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

Class: ConversionTrackerService

Source Location: /AdWords/v201101/cm/ConversionTrackerService.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --ConversionTrackerService

ConversionTrackerService


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 2861]
ConversionTrackerService



Tags:

author:  WSDLInterpreter


[ Top ]


Class Variables

static $classmap = array(
    "getResponse" => "ConversionTrackerServiceGetResponse",
    "get" => "ConversionTrackerServiceGet",
    "mutate" => "ConversionTrackerServiceMutate",
    "mutateResponse" => "ConversionTrackerServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AdWordsConversionTracker" => "AdWordsConversionTracker",
    "ConversionTracker" => "ConversionTracker",
    "AuthenticationError" => "AuthenticationError",
    "ApiError" => "ApiError",
    "AuthorizationError" => "AuthorizationError",
    "ClientTermsError" => "ClientTermsError",
    "ConversionTrackingError" => "ConversionTrackingError",
    "DateError" => "DateError",
    "DateRange" => "DateRange",
    "DistinctError" => "DistinctError",
    "DoubleValue" => "DoubleValue",
    "NumberValue" => "NumberValue",
    "InternalApiError" => "InternalApiError",
    "LongValue" => "LongValue",
    "Money" => "Money",
    "ComparableValue" => "ComparableValue",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "OrderBy" => "OrderBy",
    "Paging" => "Paging",
    "Predicate" => "Predicate",
    "QuotaCheckError" => "QuotaCheckError",
    "RangeError" => "RangeError",
    "RateExceededError" => "RateExceededError",
    "ReadOnlyError" => "ReadOnlyError",
    "RequestError" => "RequestError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "ConversionTrackerStats" => "ConversionTrackerStats",
    "ConversionTrackerOperation" => "ConversionTrackerOperation",
    "Operation" => "Operation",
    "ConversionTrackerReturnValue" => "ConversionTrackerReturnValue",
    "ListReturnValue" => "ListReturnValue",
    "DatabaseError" => "DatabaseError",
    "Selector" => "Selector",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "ConversionTrackerPage" => "ConversionTrackerPage",
    "NoStatsPage" => "NoStatsPage",
    "Page" => "Page",
    "AdWordsConversionTracker.HttpProtocol" => "AdWordsConversionTrackerHttpProtocol",
    "AdWordsConversionTracker.MarkupLanguage" => "AdWordsConversionTrackerMarkupLanguage",
    "AdWordsConversionTracker.TextFormat" => "AdWordsConversionTrackerTextFormat",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "ConversionTracker.Category" => "ConversionTrackerCategory",
    "ConversionTracker.Status" => "ConversionTrackerStatus",
    "ConversionTrackingError.Reason" => "ConversionTrackingErrorReason",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DistinctError.Reason" => "DistinctErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "Operator" => "Operator",
    "Predicate.Operator" => "PredicateOperator",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "RangeError.Reason" => "RangeErrorReason",
    "RateExceededError.Reason" => "RateExceededErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "RequestError.Reason" => "RequestErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "SortOrder" => "SortOrder",
  )

[line 2867]

Default class map for wsdl=>php



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 2948]

ConversionTrackerService __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 2968]

list get( serviceSelector $serviceSelector)

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

Returns a list of the conversion trackers that match the selector. The actual objects contained in the page's list of entries will be specific subclasses of the abstract {@ConversionTracker} class.




Tags:

return:  of conversion trackers specified by the selector.
throws:  com.google.ads.api.services.common.error.ApiException if problems occurred while retrieving results.
access:  public


Parameters:

serviceSelector   $serviceSelector   the selector specifying the ConversionTrackers to return.

[ Top ]

method mutate [line 2992]

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.</span>

Applies the list of mutate operations.




Tags:

return:  list of the conversion trackers as they appear after mutation, in the same order as they appeared in the list of operations.
throws:  com.google.ads.api.services.common.error.ApiException if problems occurred while updating the data.
access:  public


Parameters:

operations   $operations   a list of mutate operations to perform.

[ Top ]


Documentation generated by phpDocumentor 1.4.3