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

Class: AdGroupAdService

Source Location: /AdWords/v200909/cm/AdGroupAdService.php

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --AdGroupAdService

AdGroupAdService


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 6167]
AdGroupAdService



Tags:

author:  WSDLInterpreter


[ Top ]


Class Variables

static $classmap = array(
    "getResponse" => "AdGroupAdServiceGetResponse",
    "get" => "AdGroupAdServiceGet",
    "mutate" => "AdGroupAdServiceMutate",
    "mutateResponse" => "AdGroupAdServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "AdError" => "AdError",
    "ApiError" => "ApiError",
    "AdExtensionOverrideStats" => "AdExtensionOverrideStats",
    "Stats" => "Stats",
    "AdGroupAdCountLimitExceeded" => "AdGroupAdCountLimitExceeded",
    "EntityCountLimitExceeded" => "EntityCountLimitExceeded",
    "AdGroupAdError" => "AdGroupAdError",
    "AdScheduleTarget" => "AdScheduleTarget",
    "AdStats" => "AdStats",
    "AdStatsSelector" => "AdStatsSelector",
    "StatsSelector" => "StatsSelector",
    "Address" => "Address",
    "AgeTarget" => "AgeTarget",
    "DemographicTarget" => "DemographicTarget",
    "Audio" => "Audio",
    "Media" => "Media",
    "AuthenticationError" => "AuthenticationError",
    "AuthorizationError" => "AuthorizationError",
    "CityTarget" => "CityTarget",
    "GeoTarget" => "GeoTarget",
    "ClientTermsError" => "ClientTermsError",
    "CountryTarget" => "CountryTarget",
    "DateError" => "DateError",
    "DateRange" => "DateRange",
    "DeprecatedAd" => "DeprecatedAd",
    "Ad" => "Ad",
    "Dimensions" => "Dimensions",
    "DistinctError" => "DistinctError",
    "DoubleValue" => "DoubleValue",
    "NumberValue" => "NumberValue",
    "EntityNotFound" => "EntityNotFound",
    "GenderTarget" => "GenderTarget",
    "GeoPoint" => "GeoPoint",
    "IdError" => "IdError",
    "Image" => "Image",
    "ImageError" => "ImageError",
    "InternalApiError" => "InternalApiError",
    "LanguageTarget" => "LanguageTarget",
    "LongValue" => "LongValue",
    "MediaError" => "MediaError",
    "Media_MediaExtendedCapabilityType_Media_MediaExtendedCapabilityStateMapEntry" => "Media_MediaExtendedCapabilityType_Media_MediaExtendedCapabilityStateMapEntry",
    "Media_Size_DimensionsMapEntry" => "Media_Size_DimensionsMapEntry",
    "Media_Size_StringMapEntry" => "Media_Size_StringMapEntry",
    "MetroTarget" => "MetroTarget",
    "MobileAd" => "MobileAd",
    "Money" => "Money",
    "ComparableValue" => "ComparableValue",
    "NetworkTarget" => "NetworkTarget",
    "NewEntityCreationError" => "NewEntityCreationError",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "NullError" => "NullError",
    "OperationAccessDenied" => "OperationAccessDenied",
    "Paging" => "Paging",
    "PagingError" => "PagingError",
    "PlatformTarget" => "PlatformTarget",
    "PolicyViolationError.Part" => "PolicyViolationErrorPart",
    "PolicyViolationKey" => "PolicyViolationKey",
    "PolygonTarget" => "PolygonTarget",
    "ProvinceTarget" => "ProvinceTarget",
    "ProximityTarget" => "ProximityTarget",
    "QuotaCheckError" => "QuotaCheckError",
    "QuotaExceededError" => "QuotaExceededError",
    "RangeError" => "RangeError",
    "ReadOnlyError" => "ReadOnlyError",
    "RequiredError" => "RequiredError",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "StatsQueryError" => "StatsQueryError",
    "TempAdUnionId" => "TempAdUnionId",
    "AdUnionId" => "AdUnionId",
    "TextAd" => "TextAd",
    "Video" => "Video",
    "DatabaseError" => "DatabaseError",
    "ExemptionRequest" => "ExemptionRequest",
    "MobileImageAd" => "MobileImageAd",
    "PolicyViolationError" => "PolicyViolationError",
    "TemplateElementField" => "TemplateElementField",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "ImageAd" => "ImageAd",
    "LocalBusinessAd" => "LocalBusinessAd",
    "TemplateElement" => "TemplateElement",
    "AdGroupAdSelector" => "AdGroupAdSelector",
    "TemplateAd" => "TemplateAd",
    "AdGroupAd" => "AdGroupAd",
    "AdGroupAdOperation" => "AdGroupAdOperation",
    "Operation" => "Operation",
    "AdGroupAdPage" => "AdGroupAdPage",
    "Page" => "Page",
    "AdGroupAdReturnValue" => "AdGroupAdReturnValue",
    "ListReturnValue" => "ListReturnValue",
    "Ad.ApprovalStatus" => "AdApprovalStatus",
    "AdError.Reason" => "AdErrorReason",
    "AdGroupAd.Status" => "AdGroupAdStatus",
    "AdGroupAdError.Reason" => "AdGroupAdErrorReason",
    "AgeTarget.Age" => "AgeTargetAge",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DayOfWeek" => "DayOfWeek",
    "DeprecatedAd.Type" => "DeprecatedAdType",
    "DistinctError.Reason" => "DistinctErrorReason",
    "EntityCountLimitExceeded.Reason" => "EntityCountLimitExceededReason",
    "EntityNotFound.Reason" => "EntityNotFoundReason",
    "GenderTarget.Gender" => "GenderTargetGender",
    "IdError.Reason" => "IdErrorReason",
    "ImageError.Reason" => "ImageErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "MarkupLanguageType" => "MarkupLanguageType",
    "Media.MediaExtendedCapabilityState" => "MediaMediaExtendedCapabilityState",
    "Media.MediaExtendedCapabilityType" => "MediaMediaExtendedCapabilityType",
    "Media.MediaSubType" => "MediaMediaSubType",
    "Media.MediaType" => "MediaMediaType",
    "Media.MimeType" => "MediaMimeType",
    "Media.Size" => "MediaSize",
    "MediaError.Reason" => "MediaErrorReason",
    "MinuteOfHour" => "MinuteOfHour",
    "NetworkCoverageType" => "NetworkCoverageType",
    "NewEntityCreationError.Reason" => "NewEntityCreationErrorReason",
    "NotEmptyError.Reason" => "NotEmptyErrorReason",
    "NotWhitelistedError.Reason" => "NotWhitelistedErrorReason",
    "NullError.Reason" => "NullErrorReason",
    "OperationAccessDenied.Reason" => "OperationAccessDeniedReason",
    "Operator" => "Operator",
    "PagingError.Reason" => "PagingErrorReason",
    "PlatformType" => "PlatformType",
    "ProximityTarget.DistanceUnits" => "ProximityTargetDistanceUnits",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "QuotaExceededError.Reason" => "QuotaExceededErrorReason",
    "RangeError.Reason" => "RangeErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "Stats.Network" => "StatsNetwork",
    "StatsQueryError.Reason" => "StatsQueryErrorReason",
    "TemplateElementField.Type" => "TemplateElementFieldType",
  )

[line 6173]

Default class map for wsdl=>php



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 6327]

AdGroupAdService __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 6344]

the get( selector $selector)

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

Returns a list of AdGroupAds based on an AdGroupAdSelector. The selector defines a specific set of AdGroupAds that are to be returned - an AdGroupAd must pass all the filters specified in the argument AdGroupAdSelector.




Tags:

return:  AdGroupAds specified
access:  public


Parameters:

selector   $selector   the selector specifying the query

[ Top ]

method mutate [line 6381]

a 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>

Applies the list of mutate operations (ie. add, set, remove): <p>Add - Creates a new {@linkplain AdGroupAd ad group ad}. The {@code adGroupId} must reference an existing ad group. The child {@code Ad} must be sufficiently specified by constructing a concrete ad type (such as {@code TextAd}) and setting its fields accordingly.</p> <p>Set - Updates an ad group ad. Except for {@code status}, ad group ad fields are not mutable. Status updates are straightforward - the status of the ad group ad is updated as specified. If any other field has changed, it will be ignored. If you want to change any of the fields other than status, you must make a new ad and then delete the old one.</p> <p>Remove - Removes the link between the specified AdGroup and Ad.</p>




Tags:

return:  list of AdGroupAds where each entry in the list is the result of applying the operation in the input list with the same index. For an add/set operation, the return AdGroupAd will be what is saved to the db. In the case, of the remove operation, the return AdGroupAd will simply be an AdGroupAd containing an Ad with the id set to the Ad being deleted from the AdGroup.
access:  public


Parameters:

operations   $operations   the operations to apply

[ Top ]


Documentation generated by phpDocumentor 1.4.3