Class: AdWordsSoapClient

Source Location: /AdWords/Lib/AdWordsSoapClient.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient

An extension of the AdsSoapClient for the AdWords API.

Child classes:

: BulkMutateJobService

: BidLandscapeService

: UserListService

: MediaService

: CampaignService

: ExperimentService

: AdGroupCriterionService

: CampaignAdExtensionService

: AdExtensionOverrideService

: ReportDefinitionService

: CampaignTargetService

: CampaignCriterionService

: AdGroupService

: GeoLocationService

: AdParamService

: AdGroupAdService

: CustomerSyncService

: InfoService

: ServicedAccountService

: AlertService

: TrafficEstimatorService

: TargetingIdeaService

DataService: DataService

ConversionTrackerService: ConversionTrackerService

BulkOpportunityService: BulkOpportunityService

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: 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 Details

[line 37]
An extension of the AdsSoapClient for the AdWords API.

[ Top ]

Class Methods

constructor __construct [line 48]

AdWordsSoapClient __construct(
string
$wsdl, 
$options, 
$user, string
$serviceName, string
$serviceNamespace)

Constructor for the AdWords API SOAP client.

Parameters:

string	$wsdl	URI of the WSDL file or `NULL` if working in non-WSDL mode
array	$options	the SOAP client options
AdsUser	$user	the user which is responsible for this client
string	$serviceName	the name of the service which is making this call
string	$serviceNamespace	the namespace of the service

[ Top ]

method GenerateRequestInfoMessage [line 195]

string GenerateRequestInfoMessage(
)

Generates the request info message containing:

email
effectiveUser
service
method
operators
responseTime
requestId
operations
units
server
isFault
faultMessage

Tags:

return:	the request info message to log
access:	protected

Overrides 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.)

[ Top ]

method GenerateSoapHeader [line 80]

SoapHeader GenerateSoapHeader(
)

Generates the SOAP header for the client.

Tags:

return:	the instantiated SoapHeader ready to set
access:	protected

Overrides AdsSoapClient::GenerateSoapHeader() (Generates the SOAP header for the client.)

[ Top ]

method GetEffectiveUser [line 101]

string GetEffectiveUser(
)

Gets the effective user the request was made against.

Tags:

return:	the effective user the request was made against
access:	public

[ Top ]

method GetLastOperations [line 146]

string GetLastOperations(
)

Gets the last number of operations.

Tags:

return:	the last number of operations
access:	public

[ Top ]

method GetLastOperators [line 112]

string GetLastOperators(
)

Gets the last set of operators the last call in the form of "operator1,operator2".

Tags:

return:	the last set of operators
access:	public

[ Top ]

method GetLastUnits [line 163]

string GetLastUnits(
)

Gets the last number of units.

Tags:

return:	the last number of units
access:	public

[ Top ]

method RemoveSensitiveInfo [line 91]

string RemoveSensitiveInfo(
string
$request)

Removes the authentication token from the request before being logged.

Tags:

return:	the request with the authentication token removed
access:	protected

Overrides 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.)

Parameters:

string

$request

the request with sensitive data to remove

[ Top ]

method __doRequest [line 64]

string __doRequest(
string
$request, string
$location, string
$action, string
$version, [int
$one_way = 0])

Overrides the method __doRequest(). When OAuth authentication is used the URL has OAuth parameters added.

Tags:

return:

the XML SOAP response

Overrides AdsSoapClient::__doRequest() (Overrides the method SoapClient.__doRequest() to perform a clean up of the request XML before marshalling.)

Parameters:

string	$request	the request XML
string	$location	the URL to request
string	$action	the SOAP action
string	$version	the SOAP version
int	$one_way	if set to 1, this method returns nothing

[ Top ]

Documentation generated by phpDocumentor 1.4.3