Docs for page BulkMutateJobService.php

Procedural File: BulkMutateJobService.php

Classes:

The base class of all ad types. To update basic ad fields (such as #status), you can construct an {@code Ad} object (instead of the ad's concrete type) with the appropriate fields set.

Base class for AdExtension objects. An AdExtension is an extension to an existing ad or metadata that will process into an extension.

Represents an ad level ad extension override. An ad extension override specifies the ad extension that must be used if the ad is served with any ad extension data.

Represents an ad group.

Represents an ad in an ad group.

Represents bids at the adgroup level, which could be of different subtypes based on campaign's bidding strategy.

Represents a criterion in an ad group, used with AdGroupCriterionService.

Represents criterion level bids.

Represents an id indicating a grouping of Ads under some heuristic.

Structure to specify an address location.

The API error base class that provides details about an error that occurred while processing a service request.

Interface that has a reason return an associated service error.

Base class for exceptions.

Errors returned when Authentication failed.

Errors that are thrown due to an authorization problem.

Represents a bid on a criterion.

A biddable (positive) criterion in an adgroup.

Represents bidding errors.

A campaign's bidding strategy, such as manual CPC, manual CPM, budget optimizer, etc.

Used to switch a campaign's bidding strategy.

Bidding transition errors.

Represents the billing summary of the job that provides the overall cost of the job's operations, i.e., for the work done by the job. This therefore excludes the cost of operating on the job itself - setting up the job, polling for its status, retrieving the result, etc.

Data representing the budget for a campaign.

A list of all the error codes being used by the common budget domain package.

In budget optimizer, Google automatically places bids for the user based on their daily/monthly budget.

Adgroup level bids used in budget optimizer bidding strategy.

AdGroupCriterion level bids used in budget optimizer bidding strategy.

Bulk mutate job handling errors.

A basic job policy.

A request part of a BulkMutateJob.

Represents a result part of a BulkMutateJob.

Data representing an AdWords campaign.

Represents a campaign level criterion (either keyword or placement).

Base error class for Campaign Criterion Service.

Base error class for Campaign Service.

Encapsulates the errors thrown during client terms checks for adwords.

Comparable types for constructing ranges with.

Conversion optimizer bidding strategy.

Adgroup level bids used in conversion optimizer bidding strategy.

AdGroupCriterion level bids used in conversion optimizer bidding strategy.

Used to switch a campaign's bidding strategy to conversion optimizer.

Represents a criterion (such as a keyword, placement, or vertical).

Errors that are thrown due to a database access problem.

Errors associated with invalid dates and date ranges.

Represents a deprecated ad.

Represents a simple height-width dimension.

Errors related to distinct ids or content.

Reports permission problems trying to access an entity.

Signals that an entity count limit was exceeded for some level.

A qualified long-valued identity that can identify different types of AdWords entities such as campaigns and ad-groups.

An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.

A request to be exempted from a PolicyViolationError.

A frequency cap is the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.

Specifies a geo location with the supplied latitude/longitude.

Errors associated with the ids.

Represents an ImageAd.

Error class for errors associated with parsing image data.

Indicates that a server-side error has occured. {@code InternalApiError}s are generally not the result of an invalid request or message sent by the client.

Represents an asynchronous macro unit of work.

Represents the request and processing context information of a job.

Job handling errors.

An event defined by a status change of a job.

For selecting jobs whose information will be returned from a get method call of a job service.

Job-handling statistics.

Represents a keyword.

Represents Legacy Local Business Ad

Location based ad extension.

Represents override info for ad level LocationExtension overrides.

Manual click based bidding where user pays per click.

Adgroup level bids used in manual CPC bidding strategy.

Data representing a criterion level cost-per-click bid.

Manual impression based bidding where user pays per thousand impressions.

Adgroup level bids used in manual CPM bidding strategy.

Data representing a criterion-level CPM bid.

Represents some kind of media.

Error class for media related errors.

Media_MediaExtendedCapabilityType_Media_MediaExtendedCapabilityStateMapEntry

This represents an entry in a map with a key of type MediaExtendedCapabilityType and value of type MediaExtendedCapabilityState.

This represents an entry in a map with a key of type Size and value of type Dimensions.

This represents an entry in a map with a key of type Size and value of type String.

Represents a mobile ad.

Represents a mobile image ad.

Represents a money amount.

A negative criterion in an adgroup.

A negative campaign criterion.

Error associated with creation of new entities using com.google.ads.api.services.common.id.TempIds.

A list of all errors associated with the @NotEmpty constraints.

Indicates that the customer is not whitelisted for accessing the API.

Errors associated with contents not null constraint.

Number value types for constructing number valued ranges.

A marker interface for entities that can be operated upon in mutate operations.

This represents an operation that includes an operator and an operand specified type.

Unauthorized access errors as determined by the invoked service's access policy.

Represents the result of an individual mutate operation.

A stream of AdWords API mutate operations that must be performed serially.

The result of processing an OperationStream.

A list of all errors associated with the @SupportedOperators constraints.

Represents additional override info with which to augment the override extension.

Error codes for pagination.

A placement used for modifying bids for sites when targeting the content network.

Represents violations of a single policy by some text in a field.

Points to a substring within an ad field or criterion.

Key of the violation. The key is used for referring to a violation when filing an exemption request.

AdGroupCriterion level bids used in manual cpc bidding strategy when position preference is turned on.

Container for criterion quality information.

Encapsulates the errors thrown during developer quota checks.

Errors that are thrown if a quota limit is exceeded.

QuotaExceededError

Represents Quota Exceeded Error.

A list of all errors associated with the Range constraint.

A list of all errors associated with the @ReadOnly constraint.

A list of all errors associated with the @RegionCode constraints.

Errors due to missing required field.

Represents a success result of processing a mutate operation that returned a value.

Indicates that the number of entries in the request or response exceeds the system limit.

Defines the required and optional elements within the header of a SOAP request.

Defines the elements within the header of a SOAP response.

Statistics about an ad or criterion within an adgroup or campaign.

Represents possible error codes when querying for stats.

A list of all errors associated with the @ContentsString constraint.

Target abstract class.

A list of all the error codes being used by the common targeting package.

Targets list abstract class (a list of a given type of targets along with their campaign ID).

Represents the temporary id for an ad union id, which the user can specify.

Represents a <a href=

Represents an element in a template. Each template element is composed of a list of fields (actual value data).

Represents a field in a template element.

Represents a TextAd.

Indicates that the mutate operation was not processed. This could result if the job was aborted by the back-end workflow because the developer's API quota was exceeded or if the job encountered some severe workflow system failure.

Encapsulates a Video media identified by a MediaId

Represents the possible approval statuses.

The reasons for the target error.

Approval status for the AdExtensionOverride

Status of the AdExtensionOverride

Status of this ad group.

The current status of an Ad.

The reasons for the target error.

The entity type that exceeded the limit.

The reasons for the adgroup service error.

Ad serving status of campaign.

Age segments.

Approval status for the criterion.

The single reason for the authentication failure.

The reasons for the database error.

AutoKeywordMatchingStatus

Automatic Keyword matching (AutoPilot) status for the campaign.

A basic set of job statuses.

Indicate where a criterion's bid came from: criterion or the adgroup it belongs to.

Reason for bidding error.

Reason for bidding transition error.

Budget delivery methods.

Budget periods.

The reasons for the budget error.

The reasons for the bulk mutate job handling error.

The reasons for the target error.

Campaign status.

Enums for the various reasons an error can be thrown as a result of ClientTerms violation.

Content label type.

The reasons for the database error.

The reasons for the target error.

Days of the week.

Video ad.

The reasons for the validation error.

User did not have read access.

Limits at various levels of the account.

Type of entity identity.

The specified id refered to an entity which either doesn't exist or is not accessible to the customer. e.g. campaign belongs to another customer.

Gender segments.

The reasons for the target error.

The image is not valid.

The single reason for the internal API error.

The reasons for the job handling error.

Match type of a keyword. i.e. the way we match a keyword string with search queries.

The level on which the cap is to be applied.

LoasAuthenticationErrorReason

The reasons for the loas authentication error.

From manual entry in adwords frontend

Radius units

Markup languages to use for mobile ads.

MediaMediaExtendedCapabilityType

MediaMediaSubType

Media types

Mime types

Sizes for retrieving the original media

The reasons for the target error.

Minutes in an hour. Currently only 0, 15, 30, and 45 are supported

Network coverage types.

Do not set the id field while creating new entities.

The reasons for the validation error.

The single reason for the whitelist error.

The reasons for the validation error.

The reasons for the operation access error.

This represents an operator that may be presented to an adsapi service.

The reasons for the validation error.

The reasons for errors when using pagination.

Platform types.

Campaign's pricing model indicates whether it is a pay per clicks, pay per impressions, or play per conversions campaign.

The radius distance is expressed in either kilometers or miles.

Enums for all the reasons an error can be thrown to the user during billing quota checks.

The reasons for the quota error.

The single reason for the quota error.

The reasons for the target error.

The reasons for the validation error.

Error reason is unknown.

The reasons for the target error.

Campaign serving status.

The reasons for Ad Scheduling errors.

Ad network.

The reasons for errors when querying for stats.

The reasons for the target error.

Reported by system to reflect the criterion's serving status.

The reasons for the target error.

Field types

Unit of time the cap is defined at.

Specified by user to pause or unpause a criterion.

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

Base error class for Ad Service.

Represents stats specific to AdExtensionOverrides.

Indicates too many ads were added/enabled under the specified adgroup.

Error information for AdGroupAdService.

AdGroupAd service operations.

Base error class for Ad Group Criterion Service.

Signals that too many criteria were added to some ad group.

Operation (add, remove and set) on adgroup criteria.

AdGroup operations for adding/updating/removing adgroups.

Represents possible error codes in AdGroupService.

Immutable structure to hold an ad schedule target.

List of ad schedule targets.

Represents stats specific to Ads.

Exception class for holding a list of service errors.

Encapsulates an Audio media identified by a MediaId.

Represents a failure result for a mutate operation that was applied in a transactional batch. It does not imply that the corresponding operation for this result itself caused the failure. To determine that, please see the FailureResult provided for the first operation of the batch.

A {@code BulkMutateJob} is essentially a mixed collection of mutate

An event defined by a status change of a bulk mutate job.

Specifies additional criteria for selecting bulk mutate jobs.

Bulk mutate job-handling statistics.

Error to indicate that too many negative criteria added to some campaign.

Generic operation (add, remove and set) for campaign criteria.

An operation on an AdWords campaign.

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

Content Label for category exclusion.

Contains the policy violations for a single BiddableAdGroupCriterion.

Abstract class to identify a demographic target.

List of demographic targets.

Number value type for constructing double valued ranges.

Represents a failure result for an individual mutate operation.

Immutable structure to hold a gender target.

Abstract class to identify a geographic target.

List of geographic targets.

Raw image data.

Mutate operations of a job service:

Represents language for targeting.

List of language targets.

Number value type for constructing long valued ranges.

Represents the result of processing an individual mutate operation that however failed to get durably saved despite the service's best efforts.

Represents US metropolitan regions (metros) for targeting.

Immutable structure to hold a network coverage target.

List of network targets.

A platform target is used to discriminate among the potential devices from which the users access the web (ie, desktops vs. mobile devices).

List of platform targets.

Represents a geographic region enclosed by a set of vertices (points).

Represents the worldwide province for targeting.

Structure to specify a geographic target for a proximity location.

Immutable structure to hold an age target.

Represents cities for targeting.

Represents countries in the world for targeting.

BulkMutateJobService

Page Details:

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Procedural File: BulkMutateJobService.php

Classes:

Page Details:

Tags:

Includes: