Class: BulkOpportunityService

Source Location: /AdWords/v201101/o/BulkOpportunityService.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 3890]
BulkOpportunityService

Tags:

author:

WSDLInterpreter

[ Top ]

Class Variables

static $classmap = array(
    "getResponse" => "BulkOpportunityServiceGetResponse",
    "get" => "BulkOpportunityServiceGet",
    "mutate" => "BulkOpportunityServiceMutate",
    "mutateResponse" => "BulkOpportunityServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AdGroupBidLandscape" => "AdGroupBidLandscape",
    "BidLandscape" => "BidLandscape",
    "ApiError" => "ApiError",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "AuthenticationError" => "AuthenticationError",
    "AuthorizationError" => "AuthorizationError",
    "DataEntry" => "DataEntry",
    "BidLandscape.LandscapePoint" => "BidLandscapeLandscapePoint",
    "ClientTermsError" => "ClientTermsError",
    "ComparableValue" => "ComparableValue",
    "Criterion" => "Criterion",
    "CriterionBidLandscape" => "CriterionBidLandscape",
    "DatabaseError" => "DatabaseError",
    "DoubleValue" => "DoubleValue",
    "NumberValue" => "NumberValue",
    "InternalApiError" => "InternalApiError",
    "Keyword" => "Keyword",
    "LongValue" => "LongValue",
    "Money" => "Money",
    "NotWhitelistedError" => "NotWhitelistedError",
    "NullError" => "NullError",
    "Paging" => "Paging",
    "Placement" => "Placement",
    "Product" => "Product",
    "ProductCondition" => "ProductCondition",
    "ProductConditionOperand" => "ProductConditionOperand",
    "QuotaCheckError" => "QuotaCheckError",
    "RateExceededError" => "RateExceededError",
    "RequestError" => "RequestError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "CriterionUserInterest" => "CriterionUserInterest",
    "CriterionUserList" => "CriterionUserList",
    "Vertical" => "Vertical",
    "AdGroupBidLandscape.Type" => "AdGroupBidLandscapeType",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "KeywordMatchType" => "KeywordMatchType",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "NullError.Reason" => "NullErrorReason",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "RateExceededError.Reason" => "RateExceededErrorReason",
    "RequestError.Reason" => "RequestErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "CriterionUserList.MembershipStatus" => "CriterionUserListMembershipStatus",
    "AdFormatSpec" => "AdFormatSpec",
    "AdFormatSpecListAttribute" => "AdFormatSpecListAttribute",
    "Attribute" => "Attribute",
    "BidLandscapeAttribute" => "BidLandscapeAttribute",
    "BooleanAttribute" => "BooleanAttribute",
    "BulkOpportunityPage" => "BulkOpportunityPage",
    "BulkOpportunitySelector" => "BulkOpportunitySelector",
    "BulkOpportunityServiceError" => "BulkOpportunityServiceError",
    "CriterionAttribute" => "CriterionAttribute",
    "DoubleAttribute" => "DoubleAttribute",
    "IdeaTypeAttribute" => "IdeaTypeAttribute",
    "InStreamAdInfo" => "InStreamAdInfo",
    "InStreamAdInfoAttribute" => "InStreamAdInfoAttribute",
    "IntegerAttribute" => "IntegerAttribute",
    "IntegerSetAttribute" => "IntegerSetAttribute",
    "KeywordAttribute" => "KeywordAttribute",
    "LongAttribute" => "LongAttribute",
    "LongRangeAttribute" => "LongRangeAttribute",
    "MoneyAttribute" => "MoneyAttribute",
    "MonthlySearchVolume" => "MonthlySearchVolume",
    "MonthlySearchVolumeAttribute" => "MonthlySearchVolumeAttribute",
    "Opportunity" => "Opportunity",
    "OpportunityAttribute_AttributeMapEntry" => "OpportunityAttribute_AttributeMapEntry",
    "OpportunityError" => "OpportunityError",
    "OpportunityIdea" => "OpportunityIdea",
    "OpportunityIdeaTypeAttribute" => "OpportunityIdeaTypeAttribute",
    "PlacementAttribute" => "PlacementAttribute",
    "PlacementTypeAttribute" => "PlacementTypeAttribute",
    "Range" => "Range",
    "StringAttribute" => "StringAttribute",
    "WebpageDescriptor" => "WebpageDescriptor",
    "WebpageDescriptorAttribute" => "WebpageDescriptorAttribute",
    "BulkOpportunityServiceError.Reason" => "BulkOpportunityServiceErrorReason",
    "IdeaType" => "IdeaType",
    "OpportunityAttributeType" => "OpportunityAttributeType",
    "OpportunityError.Reason" => "OpportunityErrorReason",
    "OpportunityIdeaType" => "OpportunityIdeaType",
    "SiteConstants.AdFormat" => "SiteConstantsAdFormat",
    "SiteConstants.PlacementType" => "SiteConstantsPlacementType",
  )

[line 3896]

Default class map for wsdl=>php

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor __construct [line 4001]

BulkOpportunityService __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 4032]

A get(
selector
$selector)

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

Returns a page of opportunities that match the query described by the specified BulkOpportunitySelector.

The selector must specify a Paging value, with {@code numberResults} set to 20 or less. Large result sets must be composed through multiple calls to this method, advancing the Paging {@code startIndex} value by {@code numberResults} with each call.

BulkOpportunityService is available only to a limited set of advertisers. If you are not eligible to use this service, you will receive an error when calling it. Addtionally, please read this <a href="https://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=1152907"> important notice</a> before you use the results returned by this API.

Tags:

return:	BulkOpportunityPage of results, that is a subset of the list of possible opportunities meeting the criteria of the BulkOpportunitySelector.
throws:	ApiException If problems occurred while querying for opportunities.
access:	public

Parameters:

selector

$selector

Query describing the bulk opportunities to return.

[ Top ]

Documentation generated by phpDocumentor 1.4.3

Class: BulkOpportunityService

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 4001]

Tags:

Parameters:

method get [line 4032]

Tags:

Parameters: