Class: TrafficEstimatorService

Source Location: /AdWords/v201008/o/TrafficEstimatorService.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --TrafficEstimatorService

TrafficEstimatorService

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 4964]
TrafficEstimatorService

Tags:

author:

WSDLInterpreter

[ Top ]

Class Variables

static $classmap = array(
    "getResponse" => "TrafficEstimatorServiceGetResponse",
    "get" => "TrafficEstimatorServiceGet",
    "mutate" => "TrafficEstimatorServiceMutate",
    "mutateResponse" => "TrafficEstimatorServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AdScheduleTarget" => "AdScheduleTarget",
    "Address" => "Address",
    "AgeTarget" => "AgeTarget",
    "DemographicTarget" => "DemographicTarget",
    "ApiError" => "ApiError",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "AuthenticationError" => "AuthenticationError",
    "AuthorizationError" => "AuthorizationError",
    "CityTarget" => "CityTarget",
    "GeoTarget" => "GeoTarget",
    "ClientTermsError" => "ClientTermsError",
    "ComparableValue" => "ComparableValue",
    "CountryTarget" => "CountryTarget",
    "Criterion" => "Criterion",
    "DatabaseError" => "DatabaseError",
    "DateError" => "DateError",
    "DistinctError" => "DistinctError",
    "DoubleValue" => "DoubleValue",
    "NumberValue" => "NumberValue",
    "EntityAccessDenied" => "EntityAccessDenied",
    "EntityNotFound" => "EntityNotFound",
    "GenderTarget" => "GenderTarget",
    "GeoPoint" => "GeoPoint",
    "IdError" => "IdError",
    "InternalApiError" => "InternalApiError",
    "Keyword" => "Keyword",
    "LanguageTarget" => "LanguageTarget",
    "LongValue" => "LongValue",
    "MetroTarget" => "MetroTarget",
    "MobileCarrierTarget" => "MobileCarrierTarget",
    "MobileTarget" => "MobileTarget",
    "MobilePlatformTarget" => "MobilePlatformTarget",
    "Money" => "Money",
    "NetworkTarget" => "NetworkTarget",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "NullError" => "NullError",
    "OperationAccessDenied" => "OperationAccessDenied",
    "OperatorError" => "OperatorError",
    "Placement" => "Placement",
    "PlatformTarget" => "PlatformTarget",
    "PolygonTarget" => "PolygonTarget",
    "Product" => "Product",
    "ProductCondition" => "ProductCondition",
    "ProductConditionOperand" => "ProductConditionOperand",
    "ProvinceTarget" => "ProvinceTarget",
    "ProximityTarget" => "ProximityTarget",
    "QuotaCheckError" => "QuotaCheckError",
    "RangeError" => "RangeError",
    "RateExceededError" => "RateExceededError",
    "ReadOnlyError" => "ReadOnlyError",
    "RegionCodeError" => "RegionCodeError",
    "RejectedError" => "RejectedError",
    "RequestError" => "RequestError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "StringLengthError" => "StringLengthError",
    "TargetError" => "TargetError",
    "CriterionUserInterest" => "CriterionUserInterest",
    "CriterionUserList" => "CriterionUserList",
    "Vertical" => "Vertical",
    "AgeTarget.Age" => "AgeTargetAge",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DayOfWeek" => "DayOfWeek",
    "DistinctError.Reason" => "DistinctErrorReason",
    "EntityAccessDenied.Reason" => "EntityAccessDeniedReason",
    "EntityNotFound.Reason" => "EntityNotFoundReason",
    "GenderTarget.Gender" => "GenderTargetGender",
    "IdError.Reason" => "IdErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "KeywordMatchType" => "KeywordMatchType",
    "MinuteOfHour" => "MinuteOfHour",
    "NetworkCoverageType" => "NetworkCoverageType",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "NullError.Reason" => "NullErrorReason",
    "OperationAccessDenied.Reason" => "OperationAccessDeniedReason",
    "OperatorError.Reason" => "OperatorErrorReason",
    "PlatformType" => "PlatformType",
    "ProximityTarget.DistanceUnits" => "ProximityTargetDistanceUnits",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "RangeError.Reason" => "RangeErrorReason",
    "RateExceededError.Reason" => "RateExceededErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "RegionCodeError.Reason" => "RegionCodeErrorReason",
    "RejectedError.Reason" => "RejectedErrorReason",
    "RequestError.Reason" => "RequestErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "StringLengthError.Reason" => "StringLengthErrorReason",
    "TargetError.Reason" => "TargetErrorReason",
    "CriterionUserList.MembershipStatus" => "CriterionUserListMembershipStatus",
    "AdGroupEstimate" => "AdGroupEstimate",
    "Estimate" => "Estimate",
    "AdGroupEstimateRequest" => "AdGroupEstimateRequest",
    "EstimateRequest" => "EstimateRequest",
    "CampaignEstimate" => "CampaignEstimate",
    "CampaignEstimateRequest" => "CampaignEstimateRequest",
    "CollectionSizeError" => "CollectionSizeError",
    "KeywordEstimate" => "KeywordEstimate",
    "KeywordEstimateRequest" => "KeywordEstimateRequest",
    "MatchesRegexError" => "MatchesRegexError",
    "StatsEstimate" => "StatsEstimate",
    "TrafficEstimatorError" => "TrafficEstimatorError",
    "TrafficEstimatorResult" => "TrafficEstimatorResult",
    "TrafficEstimatorSelector" => "TrafficEstimatorSelector",
    "CollectionSizeError.Reason" => "CollectionSizeErrorReason",
    "MatchesRegexError.Reason" => "MatchesRegexErrorReason",
    "TrafficEstimatorError.Reason" => "TrafficEstimatorErrorReason",
  )

[line 4970]

Default class map for wsdl=>php

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor __construct [line 5100]

TrafficEstimatorService __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 5117]

Traffic get(
selector
$selector)

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

Returns traffic estimates for specified criteria.

Tags:

return:	estimation results.
throws:	ApiException if problems occurred while retrieving estimates
access:	public

Parameters:

selector

$selector

Campaigns, ad groups and keywords for which traffic should be estimated.

[ Top ]

Documentation generated by phpDocumentor 1.4.3