GoogleApiAdsAdWords
[ class tree: GoogleApiAdsAdWords ] [ index: GoogleApiAdsAdWords ] [ all elements ]

Class: ReportDefinitionService

Source Location: /AdWords/v201008/cm/ReportDefinitionService.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --ReportDefinitionService

ReportDefinitionService


Author(s):

  • WSDLInterpreter

Variables

Methods


Inherited Variables

Inherited Methods

Class: AdWordsSoapClient

AdWordsSoapClient::__construct()
Constructor for the AdWords API SOAP client.
AdWordsSoapClient::GenerateRequestInfoMessage()
Generates the request info message containing:
AdWordsSoapClient::GenerateSoapHeader()
Generates the SOAP header for the client.
AdWordsSoapClient::GetEffectiveUser()
Gets the effective user the request was made against.
AdWordsSoapClient::GetLastOperations()
Gets the last number of operations.
AdWordsSoapClient::GetLastOperators()
Gets the last set of operators the last call in the form of "operator1,operator2".
AdWordsSoapClient::GetLastUnits()
Gets the last number of units.
AdWordsSoapClient::RemoveSensitiveInfo()
Removes the authentication token from the request before being logged.
AdWordsSoapClient::__doRequest()
Overrides the method __doRequest(). When OAuth authentication is used the URL has OAuth parameters added.

Class: AdsSoapClient

AdsSoapClient::__construct()
The constructor intended to be called by all sub-classes.
AdsSoapClient::CreateSoapHeader()
Creates a SOAP header for the client given the user. It assumes that each element within the header to be filled in is a publicly acessible feild of the SOAP header element.
AdsSoapClient::GenerateRequestInfoMessage()
Generates the request information using the request and response. This method is called after the request has been made and RemoveSensitiveInfo() has been called as well.
AdsSoapClient::GenerateSoapHeader()
Generates the SOAP header for the client.
AdsSoapClient::GetAdsUser()
Gets the user for this client.
AdsSoapClient::GetEmail()
Gets the email of the user making the request.
AdsSoapClient::GetHeaderNames()
Gets the names of all registered request header elements.
AdsSoapClient::GetHeaderValue()
Gets the value for a registered request header element.
AdsSoapClient::GetLastFaultMessage()
Returns the SOAP fault message if there was any
AdsSoapClient::GetLastMethodName()
Gets the method name for the last method called.
AdsSoapClient::GetLastRequestDom()
Get the DOMDocument representing the last request from this client.
AdsSoapClient::GetLastRequestId()
Gets the request ID for the last call
AdsSoapClient::GetLastResponseDom()
Gets the DOMDocument representing the last response from this client.
AdsSoapClient::GetLastResponseTime()
Gets the response time for the last call
AdsSoapClient::GetServer()
Gets the server that the request was made to.
AdsSoapClient::GetServiceName()
Gets the service name for this client.
AdsSoapClient::IsFault()
Returns TRUE if there was a SOAP fault during the last call.
AdsSoapClient::PrepareRequest()
Depending on the version of PHP, the xsi:types need to be added and empty tags may need to be removed. The SoapRequestXmlFixer class can facilitate these changes.
AdsSoapClient::RemoveSensitiveInfo()
Removes any sensitive information from the request XML. This method is called after the request has been made and before logging any XML.
AdsSoapClient::SetHeaderValue()
Sets the value for a request header.
AdsSoapClient::__doRequest()
Overrides the method SoapClient.__doRequest() to perform a clean up of the request XML before marshalling.
AdsSoapClient::__soapCall()
Overrides the method SoapClient.__soapCall() to process the response from the SOAP call.

Class: SoapClient (Internal Class)

constructor SoapClient ( $wsdl, [$options = ] )
__call ( $function_name, $arguments )
__doRequest ( $request, $location, $action, $version, [$one_way = ] )
__getFunctions ( )
__getLastRequest ( )
__getLastRequestHeaders ( )
__getLastResponse ( )
__getLastResponseHeaders ( )
__getTypes ( )
__setCookie ( $name, [$value = ] )
__setLocation ( [$new_location = ] )
__setSoapHeaders ( $soapheaders )
__soapCall ( $function_name, $arguments, [$options = ], [$input_headers = ], [&$output_headers = ] )

Class Details

[line 2474]
ReportDefinitionService



Tags:

author:  WSDLInterpreter


[ Top ]


Class Variables

static $classmap = array(
    "getResponse" => "ReportDefinitionServiceGetResponse",
    "get" => "ReportDefinitionServiceGet",
    "mutate" => "ReportDefinitionServiceMutate",
    "mutateResponse" => "ReportDefinitionServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AuthenticationError" => "AuthenticationError",
    "ApiError" => "ApiError",
    "AuthorizationError" => "AuthorizationError",
    "ClientTermsError" => "ClientTermsError",
    "CollectionSizeError" => "CollectionSizeError",
    "DateError" => "DateError",
    "DateRange" => "DateRange",
    "DistinctError" => "DistinctError",
    "InternalApiError" => "InternalApiError",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "NullError" => "NullError",
    "OperatorError" => "OperatorError",
    "Paging" => "Paging",
    "Predicate" => "Predicate",
    "QuotaCheckError" => "QuotaCheckError",
    "RangeError" => "RangeError",
    "RateExceededError" => "RateExceededError",
    "ReadOnlyError" => "ReadOnlyError",
    "ReportDefinitionError" => "ReportDefinitionError",
    "ReportDefinitionField" => "ReportDefinitionField",
    "RequestError" => "RequestError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "Selector" => "Selector",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "ReportDefinitionSelector" => "ReportDefinitionSelector",
    "ReportDefinition" => "ReportDefinition",
    "ReportDefinitionOperation" => "ReportDefinitionOperation",
    "Operation" => "Operation",
    "ReportDefinitionPage" => "ReportDefinitionPage",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "CollectionSizeError.Reason" => "CollectionSizeErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DistinctError.Reason" => "DistinctErrorReason",
    "DownloadFormat" => "DownloadFormat",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "NullError.Reason" => "NullErrorReason",
    "Operator" => "Operator",
    "OperatorError.Reason" => "OperatorErrorReason",
    "Predicate.Operator" => "PredicateOperator",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "RangeError.Reason" => "RangeErrorReason",
    "RateExceededError.Reason" => "RateExceededErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "ReportDefinition.DateRangeType" => "ReportDefinitionDateRangeType",
    "ReportDefinition.ReportType" => "ReportDefinitionReportType",
    "ReportDefinitionError.Reason" => "ReportDefinitionErrorReason",
    "RequestError.Reason" => "RequestErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "getReportFields" => "getReportFields",
    "getReportFieldsResponse" => "getReportFieldsResponse",
  )

[line 2480]

Default class map for wsdl=>php



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 2554]

ReportDefinitionService __construct( [string $wsdl = null], array $options, $user)

Constructor using wsdl location and options array



Tags:

access:  public


Overrides AdWordsSoapClient::__construct() (Constructor for the AdWords API SOAP client.)

Parameters:

string   $wsdl   WSDL location for this service
array   $options   Options for the SoapClient
   $user  

[ Top ]

method get [line 2571]

A get( selector $selector)

<span class="constraint Required">This field is required and should not be {@code null}.</span>

Returns the list of report definitions that meet the selector criteria.




Tags:

return:  list of report definitions.
throws:  ApiException if problems occurred while fetching report definitions information.
access:  public


Parameters:

selector   $selector   Determines which report definitions to return. If empty, all report definitions will be returned.

[ Top ]

method getReportFields [line 2593]

The getReportFields( reportType $reportType)

<span class="constraint Required">This field is required and should not be {@code null}.</span>

Returns the available report fields for a given report type.




Tags:

return:  list of available report fields. Each ReportDefinitionField encapsulates the field name, the field data type, and the enum values (if the field's type is {@code enum}).
throws:  ApiException if a problem occurred while fetching the ReportDefinitionField information.
access:  public


Parameters:

reportType   $reportType   The type of report.

[ Top ]

method mutate [line 2618]

The mutate( operations $operations)

<span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span>

<span class="constraint DistinctIds">Elements in this field must have distinct IDs for following Operators : SET, REMOVE.</span> <span class="constraint NotEmpty">This field must contain at least one element.</span> <span class="constraint Required">This field is required and should not be {@code null}.</span> <span class="constraint SupportedOperators">The following Operators are supported: ADD, SET, REMOVE.</span>

Creates, updates, and deletes report definitions.




Tags:

return:  list of updated report definitions, returned in the same order as the
  1. operations
array.
throws:  ApiException if an error occurred while updating report definitions information.
access:  public


Parameters:

operations   $operations   A list of unique operations. The same report definition cannot be specified in more than one operation.

[ Top ]


Documentation generated by phpDocumentor 1.4.3