Class: UserListService

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

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 2161]
UserListService

Tags:

author:

WSDLInterpreter

[ Top ]

Class Variables

static $classmap = array(
    "getResponse" => "UserListServiceGetResponse",
    "get" => "UserListServiceGet",
    "mutate" => "UserListServiceMutate",
    "mutateResponse" => "UserListServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "ApiError" => "ApiError",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "AuthenticationError" => "AuthenticationError",
    "AuthorizationError" => "AuthorizationError",
    "ExternalRemarketingUserList" => "ExternalRemarketingUserList",
    "UserList" => "UserList",
    "UserListConversionType" => "UserListConversionType",
    "DatabaseError" => "DatabaseError",
    "InternalApiError" => "InternalApiError",
    "ListReturnValue" => "ListReturnValue",
    "LogicalUserList" => "LogicalUserList",
    "LogicalUserListOperand" => "LogicalUserListOperand",
    "NotEmptyError" => "NotEmptyError",
    "Operation" => "Operation",
    "OperationAccessDenied" => "OperationAccessDenied",
    "Page" => "Page",
    "Paging" => "Paging",
    "RangeError" => "RangeError",
    "ReadOnlyError" => "ReadOnlyError",
    "RemarketingUserList" => "RemarketingUserList",
    "RequiredError" => "RequiredError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "UserInterest" => "UserInterest",
    "UserListError" => "UserListError",
    "UserListLogicalRule" => "UserListLogicalRule",
    "UserListOperation" => "UserListOperation",
    "UserListPage" => "UserListPage",
    "UserListReturnValue" => "UserListReturnValue",
    "UserListSelector" => "UserListSelector",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "UserListConversionType.Category" => "UserListConversionTypeCategory",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "OperationAccessDenied.Reason" => "OperationAccessDeniedReason",
    "Operator" => "Operator",
    "RangeError.Reason" => "RangeErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeRange" => "SizeRange",
    "UserList.Type" => "UserListType",
    "UserListError.Reason" => "UserListErrorReason",
    "UserListLogicalRule.Operator" => "UserListLogicalRuleOperator",
    "UserListMembershipStatus" => "UserListMembershipStatus",
  )

[line 2167]

Default class map for wsdl=>php

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor __construct [line 2228]

UserListService __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 2243]

a get(
selector
$selector)

This field is required and should not be {@code null}.

Returns the list of user lists that meet the selector criteria.

Tags:

return:	list of UserList entities which meet the selector criteria.
access:	public

Parameters:

selector

$selector

the selector specifying the query

[ Top ]

method mutate [line 2266]

the mutate(
operations
$operations)

This field must not contain {@code null} elements.

Elements in this field must have distinct IDs for following Operators : SET, REMOVE. This field must contain at least one element. This field is required and should not be {@code null}. The following Operators are supported: ADD, SET.

Adds and updates user lists. Note: UserListOperation does not support the

REMOVE

operator. To disable a user list, set its UserListMembershipStatus to

CLOSED

.

Tags:

return:	mutated UserList entities.
access:	public

Parameters:

operations

$operations

the operations to apply.

[ Top ]

Documentation generated by phpDocumentor 1.4.3

Class: UserListService

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Class: AdsSoapClient

Inherited Methods

Class: AdWordsSoapClient

Class: AdsSoapClient

Class: SoapClient (Internal Class)

Class Details

Tags:

Class Variables

Tags:

Class Methods

constructor __construct [line 2228]

Tags:

Parameters:

method get [line 2243]

Tags:

Parameters:

method mutate [line 2266]

Tags:

Parameters: