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

Class: TargetingIdeaService

Source Location: /AdWords/v200909/o/TargetingIdeaService.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --TargetingIdeaService

TargetingIdeaService


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 6362]
TargetingIdeaService



Tags:

author:  WSDLInterpreter


[ Top ]


Class Variables

static $classmap = array(
    "getResponse" => "TargetingIdeaServiceGetResponse",
    "get" => "TargetingIdeaServiceGet",
    "mutate" => "TargetingIdeaServiceMutate",
    "mutateResponse" => "TargetingIdeaServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AdGroupCriterionError" => "AdGroupCriterionError",
    "ApiError" => "ApiError",
    "AdGroupCriterionLimitExceeded" => "AdGroupCriterionLimitExceeded",
    "EntityCountLimitExceeded" => "EntityCountLimitExceeded",
    "AdScheduleTarget" => "AdScheduleTarget",
    "Address" => "Address",
    "AgeTarget" => "AgeTarget",
    "DemographicTarget" => "DemographicTarget",
    "AuthenticationError" => "AuthenticationError",
    "AuthorizationError" => "AuthorizationError",
    "BiddingError" => "BiddingError",
    "BudgetError" => "BudgetError",
    "CityTarget" => "CityTarget",
    "GeoTarget" => "GeoTarget",
    "ClientTermsError" => "ClientTermsError",
    "CountryTarget" => "CountryTarget",
    "CriterionPolicyError" => "CriterionPolicyError",
    "PolicyViolationError" => "PolicyViolationError",
    "DateError" => "DateError",
    "DistinctError" => "DistinctError",
    "DoubleValue" => "DoubleValue",
    "NumberValue" => "NumberValue",
    "EntityNotFound" => "EntityNotFound",
    "GenderTarget" => "GenderTarget",
    "GeoPoint" => "GeoPoint",
    "InternalApiError" => "InternalApiError",
    "Keyword" => "Keyword",
    "Criterion" => "Criterion",
    "LanguageTarget" => "LanguageTarget",
    "LongValue" => "LongValue",
    "MetroTarget" => "MetroTarget",
    "Money" => "Money",
    "ComparableValue" => "ComparableValue",
    "NetworkTarget" => "NetworkTarget",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "NullError" => "NullError",
    "Paging" => "Paging",
    "Placement" => "Placement",
    "PlatformTarget" => "PlatformTarget",
    "PolicyViolationError.Part" => "PolicyViolationErrorPart",
    "PolicyViolationKey" => "PolicyViolationKey",
    "PolygonTarget" => "PolygonTarget",
    "ProvinceTarget" => "ProvinceTarget",
    "ProximityTarget" => "ProximityTarget",
    "QuotaCheckError" => "QuotaCheckError",
    "QuotaExceededError" => "QuotaExceededError",
    "RangeError" => "RangeError",
    "ReadOnlyError" => "ReadOnlyError",
    "RegionCodeError" => "RegionCodeError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "StatsQueryError" => "StatsQueryError",
    "StringLengthError" => "StringLengthError",
    "TargetError" => "TargetError",
    "DatabaseError" => "DatabaseError",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "AdGroupCriterionError.Reason" => "AdGroupCriterionErrorReason",
    "AdGroupCriterionLimitExceeded.CriteriaLimitType" => "AdGroupCriterionLimitExceededCriteriaLimitType",
    "AgeTarget.Age" => "AgeTargetAge",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "BiddingError.Reason" => "BiddingErrorReason",
    "BudgetError.Reason" => "BudgetErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DayOfWeek" => "DayOfWeek",
    "DistinctError.Reason" => "DistinctErrorReason",
    "EntityCountLimitExceeded.Reason" => "EntityCountLimitExceededReason",
    "EntityNotFound.Reason" => "EntityNotFoundReason",
    "GenderTarget.Gender" => "GenderTargetGender",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "KeywordMatchType" => "KeywordMatchType",
    "MinuteOfHour" => "MinuteOfHour",
    "NetworkCoverageType" => "NetworkCoverageType",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "NullError.Reason" => "NullErrorReason",
    "PlatformType" => "PlatformType",
    "ProximityTarget.DistanceUnits" => "ProximityTargetDistanceUnits",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "QuotaExceededError.Reason" => "QuotaExceededErrorReason",
    "RangeError.Reason" => "RangeErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "RegionCodeError.Reason" => "RegionCodeErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "StatsQueryError.Reason" => "StatsQueryErrorReason",
    "StringLengthError.Reason" => "StringLengthErrorReason",
    "TargetError.Reason" => "TargetErrorReason",
    "AdFormatSpec" => "AdFormatSpec",
    "AdFormatSpecListAttribute" => "AdFormatSpecListAttribute",
    "Attribute" => "Attribute",
    "AdTypeSearchParameter" => "AdTypeSearchParameter",
    "SearchParameter" => "SearchParameter",
    "BooleanAttribute" => "BooleanAttribute",
    "CollectionSizeError" => "CollectionSizeError",
    "CompetitionSearchParameter" => "CompetitionSearchParameter",
    "DoubleAttribute" => "DoubleAttribute",
    "IdeaTypeAttribute" => "IdeaTypeAttribute",
    "InStreamAdInfo" => "InStreamAdInfo",
    "InStreamAdInfoAttribute" => "InStreamAdInfoAttribute",
    "IncludeAdultContentSearchParameter" => "IncludeAdultContentSearchParameter",
    "IntegerAttribute" => "IntegerAttribute",
    "IntegerSetAttribute" => "IntegerSetAttribute",
    "KeywordCategoryIdSearchParameter" => "KeywordCategoryIdSearchParameter",
    "KeywordMatchTypeSearchParameter" => "KeywordMatchTypeSearchParameter",
    "LongAttribute" => "LongAttribute",
    "LongComparisonOperation" => "LongComparisonOperation",
    "MobileSearchParameter" => "MobileSearchParameter",
    "MonthlySearchVolume" => "MonthlySearchVolume",
    "MonthlySearchVolumeAttribute" => "MonthlySearchVolumeAttribute",
    "NgramGroupsSearchParameter" => "NgramGroupsSearchParameter",
    "PlacementTypeAttribute" => "PlacementTypeAttribute",
    "PlacementTypeSearchParameter" => "PlacementTypeSearchParameter",
    "RelatedToUrlSearchParameter" => "RelatedToUrlSearchParameter",
    "SeedAdGroupIdSearchParameter" => "SeedAdGroupIdSearchParameter",
    "StringAttribute" => "StringAttribute",
    "TargetingIdeaError" => "TargetingIdeaError",
    "WebpageDescriptor" => "WebpageDescriptor",
    "WebpageDescriptorAttribute" => "WebpageDescriptorAttribute",
    "AverageTargetedMonthlySearchesSearchParameter" => "AverageTargetedMonthlySearchesSearchParameter",
    "GlobalMonthlySearchesSearchParameter" => "GlobalMonthlySearchesSearchParameter",
    "MoneyAttribute" => "MoneyAttribute",
    "Range" => "Range",
    "CountryTargetSearchParameter" => "CountryTargetSearchParameter",
    "LanguageTargetSearchParameter" => "LanguageTargetSearchParameter",
    "LongRangeAttribute" => "LongRangeAttribute",
    "ExcludedKeywordSearchParameter" => "ExcludedKeywordSearchParameter",
    "KeywordAttribute" => "KeywordAttribute",
    "PlacementAttribute" => "PlacementAttribute",
    "RelatedToKeywordSearchParameter" => "RelatedToKeywordSearchParameter",
    "TargetingIdeaSelector" => "TargetingIdeaSelector",
    "Type_AttributeMapEntry" => "Type_AttributeMapEntry",
    "TargetingIdea" => "TargetingIdea",
    "TargetingIdeaPage" => "TargetingIdeaPage",
    "AttributeType" => "AttributeType",
    "CollectionSizeError.Reason" => "CollectionSizeErrorReason",
    "CompetitionSearchParameter.Level" => "CompetitionSearchParameterLevel",
    "IdeaType" => "IdeaType",
    "RequestType" => "RequestType",
    "SiteConstants.AdFormat" => "SiteConstantsAdFormat",
    "SiteConstants.AdType" => "SiteConstantsAdType",
    "SiteConstants.PlacementType" => "SiteConstantsPlacementType",
    "TargetingIdeaError.Reason" => "TargetingIdeaErrorReason",
    "getBulkKeywordIdeas" => "getBulkKeywordIdeas",
    "getBulkKeywordIdeasResponse" => "getBulkKeywordIdeasResponse",
  )

[line 6368]

Default class map for wsdl=>php



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 6533]

TargetingIdeaService __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 6562]

A get( selector $selector)

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

Returns a page of ideas that match the query described by the specified TargetingIdeaSelector.

<p>The selector must specify a {@code paging} value, with {@code numberResults} set to 800 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.

<p>Only a relatively small total number of results will be available through this method. Much larger result sets may be available using #getBulkKeywordIdeas(TargetingIdeaSelector) at the price of reduced flexibility in selector options.




Tags:

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


Parameters:

selector   $selector   Query describing the types of results to return when finding matches (similar keyword ideas/placement ideas).

[ Top ]

method getBulkKeywordIdeas [line 6603]

A getBulkKeywordIdeas( selector $selector)

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

Returns a page of ideas that match the query described by the specified TargetingIdeaSelector. This method is specialized for returning bulk keyword ideas, and thus the selector must be set for IDEAS and KEYWORD. A limited, fixed set of attributes will be returned.

<p>A single-valued com.google.ads.api.services.targetingideas.search.RelatedToUrlSearchParameter must be supplied. Single-valued com.google.ads.api.services.targetingideas.search.LanguageTargetSearchParameter and com.google.ads.api.services.targetingideas.search.CountryTargetSearchParameter are both optional. Other search parameters compatible with a keyword query may also be supplied.

<p>The selector must specify a {@code paging} value, with {@code numberResults} set to 500 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.

<p>This method can make many more results available than #get(TargetingIdeaSelector), but allows less control over the query. For fine-tuned queries that do not need large numbers of results, prefer #get(TargetingIdeaSelector).




Tags:

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


Parameters:

selector   $selector   Query describing the bulk keyword ideas to return.

[ Top ]


Documentation generated by phpDocumentor 1.4.3