Class: CustomerSyncService

Source Location: /AdWords/v201008/ch/CustomerSyncService.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --CustomerSyncService

CustomerSyncService

Author(s):

WSDLInterpreter

Variables

$classmap

Methods

Inherited Variables

Class: AdsSoapClient

AdsSoapClient::$headers
AdsSoapClient::$lastArguments
AdsSoapClient::$lastMethodName
AdsSoapClient::$lastRequest
AdsSoapClient::$lastResponse
AdsSoapClient::$lastSoapFault
AdsSoapClient::$serviceName
AdsSoapClient::$serviceNamespace
AdsSoapClient::$user

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 1752]
CustomerSyncService

Tags:

author:

WSDLInterpreter

[ Top ]

Class Variables

static $classmap = array(
    "getResponse" => "CustomerSyncServiceGetResponse",
    "get" => "CustomerSyncServiceGet",
    "mutate" => "CustomerSyncServiceMutate",
    "mutateResponse" => "CustomerSyncServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AuthenticationError" => "AuthenticationError",
    "ApiError" => "ApiError",
    "AuthorizationError" => "AuthorizationError",
    "ClientTermsError" => "ClientTermsError",
    "DateError" => "DateError",
    "DateTimeRange" => "DateTimeRange",
    "DistinctError" => "DistinctError",
    "InternalApiError" => "InternalApiError",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "QuotaCheckError" => "QuotaCheckError",
    "RateExceededError" => "RateExceededError",
    "RequestError" => "RequestError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "DatabaseError" => "DatabaseError",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DistinctError.Reason" => "DistinctErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "RateExceededError.Reason" => "RateExceededErrorReason",
    "RequestError.Reason" => "RequestErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "AdGroupChangeData" => "AdGroupChangeData",
    "CampaignChangeData" => "CampaignChangeData",
    "CustomerChangeData" => "CustomerChangeData",
    "CustomerSyncError" => "CustomerSyncError",
    "CustomerSyncSelector" => "CustomerSyncSelector",
    "ChangeStatus" => "ChangeStatus",
    "CustomerSyncError.Reason" => "CustomerSyncErrorReason",
  )

[line 1758]

Default class map for wsdl=>php

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor __construct [line 1813]

CustomerSyncService __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 1830]

A get(
selector
$selector)

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

Returns information about changed entities inside a customer's account.

Tags:

return:	Customer->Campaign->AdGroup hierarchy containing information about the objects changed at each level. All Campaigns that are requested in the selector will be returned, regardless of whether or not they have changed, but unchanged AdGroups will be ignored.
access:	public

Parameters:

selector

$selector

Specifies the filter for selecting changehistory events for a customer.

[ Top ]

Documentation generated by phpDocumentor 1.4.3