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

Class: BulkMutateJobService

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

Class Overview

SoapClient
   |
   --AdsSoapClient
      |
      --AdWordsSoapClient
         |
         --BulkMutateJobService

BulkMutateJobService


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 11583]
BulkMutateJobService



Tags:

author:  WSDLInterpreter


[ Top ]


Class Variables

static $classmap = array(
    "getResponse" => "BulkMutateJobServiceGetResponse",
    "get" => "BulkMutateJobServiceGet",
    "mutate" => "BulkMutateJobServiceMutate",
    "mutateResponse" => "BulkMutateJobServiceMutateResponse",
    "DateTime" => "AdWordsDateTime",
    "Target" => "AdWordsTarget",
    "SoapHeader" => "SoapRequestHeader",
    "Ad" => "Ad",
    "AdError" => "AdError",
    "ApiError" => "ApiError",
    "AdExtension" => "AdExtension",
    "AdExtensionOverride" => "AdExtensionOverride",
    "AdExtensionOverrideStats" => "AdExtensionOverrideStats",
    "Stats" => "Stats",
    "AdGroup" => "AdGroup",
    "AdGroupAd" => "AdGroupAd",
    "AdGroupAdCountLimitExceeded" => "AdGroupAdCountLimitExceeded",
    "EntityCountLimitExceeded" => "EntityCountLimitExceeded",
    "AdGroupAdError" => "AdGroupAdError",
    "AdGroupAdOperation" => "AdGroupAdOperation",
    "Operation" => "Operation",
    "AdGroupBids" => "AdGroupBids",
    "AdGroupCriterion" => "AdGroupCriterion",
    "AdGroupCriterionBids" => "AdGroupCriterionBids",
    "AdGroupCriterionError" => "AdGroupCriterionError",
    "AdGroupCriterionLimitExceeded" => "AdGroupCriterionLimitExceeded",
    "AdGroupCriterionOperation" => "AdGroupCriterionOperation",
    "AdGroupOperation" => "AdGroupOperation",
    "AdGroupServiceError" => "AdGroupServiceError",
    "AdScheduleTarget" => "AdScheduleTarget",
    "AdScheduleTargetList" => "AdScheduleTargetList",
    "TargetList" => "TargetList",
    "AdStats" => "AdStats",
    "AdUnionId" => "AdUnionId",
    "Address" => "Address",
    "AgeTarget" => "AgeTarget",
    "DemographicTarget" => "DemographicTarget",
    "ApiErrorReason" => "ApiErrorReason",
    "ApiException" => "ApiException",
    "ApplicationException" => "ApplicationException",
    "Audio" => "Audio",
    "Media" => "Media",
    "AuthenticationError" => "AuthenticationError",
    "AuthorizationError" => "AuthorizationError",
    "BatchFailureResult" => "BatchFailureResult",
    "OperationResult" => "OperationResult",
    "Bid" => "Bid",
    "BiddableAdGroupCriterion" => "BiddableAdGroupCriterion",
    "BiddingError" => "BiddingError",
    "BiddingStrategy" => "BiddingStrategy",
    "BiddingTransition" => "BiddingTransition",
    "BiddingTransitionError" => "BiddingTransitionError",
    "BillingSummary" => "BillingSummary",
    "Budget" => "Budget",
    "BudgetError" => "BudgetError",
    "BudgetOptimizer" => "BudgetOptimizer",
    "BudgetOptimizerAdGroupBids" => "BudgetOptimizerAdGroupBids",
    "BudgetOptimizerAdGroupCriterionBids" => "BudgetOptimizerAdGroupCriterionBids",
    "BulkMutateJob" => "BulkMutateJob",
    "Job" => "Job",
    "BulkMutateJobError" => "BulkMutateJobError",
    "BulkMutateJobEvent" => "BulkMutateJobEvent",
    "JobEvent" => "JobEvent",
    "BulkMutateJobPolicy" => "BulkMutateJobPolicy",
    "BulkMutateJobSelector" => "BulkMutateJobSelector",
    "JobSelector" => "JobSelector",
    "BulkMutateJobStats" => "BulkMutateJobStats",
    "JobStats" => "JobStats",
    "BulkMutateRequest" => "BulkMutateRequest",
    "BulkMutateResult" => "BulkMutateResult",
    "Campaign" => "Campaign",
    "CampaignCriterion" => "CampaignCriterion",
    "CampaignCriterionError" => "CampaignCriterionError",
    "CampaignCriterionLimitExceeded" => "CampaignCriterionLimitExceeded",
    "CampaignCriterionOperation" => "CampaignCriterionOperation",
    "CampaignError" => "CampaignError",
    "CampaignOperation" => "CampaignOperation",
    "CampaignTargetOperation" => "CampaignTargetOperation",
    "CityTarget" => "CityTarget",
    "GeoTarget" => "GeoTarget",
    "ClientTermsError" => "ClientTermsError",
    "ComparableValue" => "ComparableValue",
    "ContentLabel" => "ContentLabel",
    "Criterion" => "Criterion",
    "ConversionOptimizer" => "ConversionOptimizer",
    "ConversionOptimizerAdGroupBids" => "ConversionOptimizerAdGroupBids",
    "ConversionOptimizerAdGroupCriterionBids" => "ConversionOptimizerAdGroupCriterionBids",
    "ConversionOptimizerBiddingTransition" => "ConversionOptimizerBiddingTransition",
    "CountryTarget" => "CountryTarget",
    "CriterionPolicyError" => "CriterionPolicyError",
    "PolicyViolationError" => "PolicyViolationError",
    "DatabaseError" => "DatabaseError",
    "DateError" => "DateError",
    "DemographicTargetList" => "DemographicTargetList",
    "DeprecatedAd" => "DeprecatedAd",
    "Dimensions" => "Dimensions",
    "DistinctError" => "DistinctError",
    "DoubleValue" => "DoubleValue",
    "NumberValue" => "NumberValue",
    "EntityAccessDenied" => "EntityAccessDenied",
    "EntityId" => "EntityId",
    "EntityNotFound" => "EntityNotFound",
    "ExemptionRequest" => "ExemptionRequest",
    "FailureResult" => "FailureResult",
    "FrequencyCap" => "FrequencyCap",
    "GenderTarget" => "GenderTarget",
    "GeoPoint" => "GeoPoint",
    "GeoTargetList" => "GeoTargetList",
    "IdError" => "IdError",
    "Image" => "Image",
    "ImageAd" => "ImageAd",
    "ImageError" => "ImageError",
    "InternalApiError" => "InternalApiError",
    "JobContext" => "JobContext",
    "JobError" => "JobError",
    "JobOperation" => "JobOperation",
    "Keyword" => "Keyword",
    "LanguageTarget" => "LanguageTarget",
    "LanguageTargetList" => "LanguageTargetList",
    "LocalBusinessAd" => "LocalBusinessAd",
    "LocationExtension" => "LocationExtension",
    "LocationOverrideInfo" => "LocationOverrideInfo",
    "LongValue" => "LongValue",
    "LostResult" => "LostResult",
    "ManualCPC" => "ManualCPC",
    "ManualCPCAdGroupBids" => "ManualCPCAdGroupBids",
    "ManualCPCAdGroupCriterionBids" => "ManualCPCAdGroupCriterionBids",
    "ManualCPM" => "ManualCPM",
    "ManualCPMAdGroupBids" => "ManualCPMAdGroupBids",
    "ManualCPMAdGroupCriterionBids" => "ManualCPMAdGroupCriterionBids",
    "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",
    "MobileImageAd" => "MobileImageAd",
    "Money" => "Money",
    "NegativeAdGroupCriterion" => "NegativeAdGroupCriterion",
    "NegativeCampaignCriterion" => "NegativeCampaignCriterion",
    "NetworkTarget" => "NetworkTarget",
    "NetworkTargetList" => "NetworkTargetList",
    "NewEntityCreationError" => "NewEntityCreationError",
    "NotEmptyError" => "NotEmptyError",
    "NotWhitelistedError" => "NotWhitelistedError",
    "NullError" => "NullError",
    "Operand" => "Operand",
    "OperationAccessDenied" => "OperationAccessDenied",
    "OperationStream" => "OperationStream",
    "OperationStreamResult" => "OperationStreamResult",
    "OperatorError" => "OperatorError",
    "OverrideInfo" => "OverrideInfo",
    "PagingError" => "PagingError",
    "Placement" => "Placement",
    "PlatformTarget" => "PlatformTarget",
    "PlatformTargetList" => "PlatformTargetList",
    "PolicyViolationError.Part" => "PolicyViolationErrorPart",
    "PolicyViolationKey" => "PolicyViolationKey",
    "PolygonTarget" => "PolygonTarget",
    "PositionPreferenceAdGroupCriterionBids" => "PositionPreferenceAdGroupCriterionBids",
    "ProvinceTarget" => "ProvinceTarget",
    "ProximityTarget" => "ProximityTarget",
    "QualityInfo" => "QualityInfo",
    "QuotaCheckError" => "QuotaCheckError",
    "QuotaError" => "QuotaError",
    "QuotaExceededError" => "QuotaExceededError",
    "RangeError" => "RangeError",
    "ReadOnlyError" => "ReadOnlyError",
    "RegionCodeError" => "RegionCodeError",
    "RequiredError" => "RequiredError",
    "ReturnValueResult" => "ReturnValueResult",
    "SizeLimitError" => "SizeLimitError",
    "SoapResponseHeader" => "SoapResponseHeader",
    "StatsQueryError" => "StatsQueryError",
    "StringLengthError" => "StringLengthError",
    "TargetError" => "TargetError",
    "TempAdUnionId" => "TempAdUnionId",
    "TemplateAd" => "TemplateAd",
    "TemplateElement" => "TemplateElement",
    "TemplateElementField" => "TemplateElementField",
    "TextAd" => "TextAd",
    "UnprocessedResult" => "UnprocessedResult",
    "Video" => "Video",
    "Ad.ApprovalStatus" => "AdApprovalStatus",
    "AdError.Reason" => "AdErrorReason",
    "AdExtensionOverride.ApprovalStatus" => "AdExtensionOverrideApprovalStatus",
    "AdExtensionOverride.Status" => "AdExtensionOverrideStatus",
    "AdGroup.Status" => "AdGroupStatus",
    "AdGroupAd.Status" => "AdGroupAdStatus",
    "AdGroupAdError.Reason" => "AdGroupAdErrorReason",
    "AdGroupCriterionError.Reason" => "AdGroupCriterionErrorReason",
    "AdGroupCriterionLimitExceeded.CriteriaLimitType" => "AdGroupCriterionLimitExceededCriteriaLimitType",
    "AdGroupServiceError.Reason" => "AdGroupServiceErrorReason",
    "AdServingOptimizationStatus" => "AdServingOptimizationStatus",
    "AgeTarget.Age" => "AgeTargetAge",
    "ApprovalStatus" => "ApprovalStatus",
    "AuthenticationError.Reason" => "AuthenticationErrorReason",
    "AuthorizationError.Reason" => "AuthorizationErrorReason",
    "AutoKeywordMatchingStatus" => "AutoKeywordMatchingStatus",
    "BasicJobStatus" => "BasicJobStatus",
    "BidSource" => "BidSource",
    "BiddingError.Reason" => "BiddingErrorReason",
    "BiddingTransitionError.Reason" => "BiddingTransitionErrorReason",
    "Budget.BudgetDeliveryMethod" => "BudgetBudgetDeliveryMethod",
    "Budget.BudgetPeriod" => "BudgetBudgetPeriod",
    "BudgetError.Reason" => "BudgetErrorReason",
    "BulkMutateJobError.Reason" => "BulkMutateJobErrorReason",
    "CampaignCriterionError.Reason" => "CampaignCriterionErrorReason",
    "CampaignCriterionLimitExceeded.CriteriaLimitType" => "CampaignCriterionLimitExceededCriteriaLimitType",
    "CampaignError.Reason" => "CampaignErrorReason",
    "CampaignStatus" => "CampaignStatus",
    "ClientTermsError.Reason" => "ClientTermsErrorReason",
    "ContentLabelType" => "ContentLabelType",
    "DatabaseError.Reason" => "DatabaseErrorReason",
    "DateError.Reason" => "DateErrorReason",
    "DayOfWeek" => "DayOfWeek",
    "DeprecatedAd.Type" => "DeprecatedAdType",
    "DistinctError.Reason" => "DistinctErrorReason",
    "EntityAccessDenied.Reason" => "EntityAccessDeniedReason",
    "EntityCountLimitExceeded.Reason" => "EntityCountLimitExceededReason",
    "EntityId.Type" => "EntityIdType",
    "EntityNotFound.Reason" => "EntityNotFoundReason",
    "GenderTarget.Gender" => "GenderTargetGender",
    "IdError.Reason" => "IdErrorReason",
    "ImageError.Reason" => "ImageErrorReason",
    "InternalApiError.Reason" => "InternalApiErrorReason",
    "JobError.Reason" => "JobErrorReason",
    "KeywordMatchType" => "KeywordMatchType",
    "Level" => "Level",
    "LoasAuthenticationError.Reason" => "LoasAuthenticationErrorReason",
    "LocationExtension.Source" => "LocationExtensionSource",
    "LocationOverrideInfo.RadiusUnits" => "LocationOverrideInfoRadiusUnits",
    "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",
    "OperatorError.Reason" => "OperatorErrorReason",
    "PagingError.Reason" => "PagingErrorReason",
    "PlatformType" => "PlatformType",
    "PolicyViolationError.Reason" => "PolicyViolationErrorReason",
    "PricingModel" => "PricingModel",
    "ProximityTarget.DistanceUnits" => "ProximityTargetDistanceUnits",
    "QuotaCheckError.Reason" => "QuotaCheckErrorReason",
    "QuotaError.Reason" => "QuotaErrorReason",
    "QuotaExceededError.Reason" => "QuotaExceededErrorReason",
    "RangeError.Reason" => "RangeErrorReason",
    "ReadOnlyError.Reason" => "ReadOnlyErrorReason",
    "RegionCodeError.Reason" => "RegionCodeErrorReason",
    "RequestError.Reason" => "RequestErrorReason",
    "RequiredError.Reason" => "RequiredErrorReason",
    "ServingStatus" => "ServingStatus",
    "SizeLimitError.Reason" => "SizeLimitErrorReason",
    "Stats.Network" => "StatsNetwork",
    "StatsQueryError.Reason" => "StatsQueryErrorReason",
    "StringLengthError.Reason" => "StringLengthErrorReason",
    "SystemServingStatus" => "SystemServingStatus",
    "TargetError.Reason" => "TargetErrorReason",
    "TemplateElementField.Type" => "TemplateElementFieldType",
    "TimeUnit" => "TimeUnit",
    "UserStatus" => "UserStatus",
  )

[line 11589]

Default class map for wsdl=>php



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 11869]

BulkMutateJobService __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 11886]

List get( selector $selector)

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

Returns a list of bulk mutate jobs.




Tags:

return:  of bulk mutate jobs meeting the {@code selector} criteria.
throws:  ApiException if problems occurred while fetching the jobs
access:  public


Parameters:

selector   $selector   Specifies which jobs to return. If the selector is empty, all jobs are returned.

[ Top ]

method mutate [line 11914]

The mutate( operation $operation)

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

Adds or updates a bulk mutate job.

<p>Use the &laquo;ADD&raquo; operator to submit a new job, and the &laquo;SET&raquo; operator to add additional {@linkplain BulkMutateRequest request parts} to an existing job. The &laquo;DELETE&raquo; operator is not supported.</p>

<p class="note">Note: In the current implementation, the check for duplicate job keys is only "best effort", and may not prevent jobs with the same keys from being accepted if they are submitted around the same instant.</p>




Tags:

return:  added or updated bulk mutate job.
throws:  ApiException if problems occurred while creating or updating jobs
access:  public


Parameters:

operation   $operation   The operation to perform.

[ Top ]


Documentation generated by phpDocumentor 1.4.3