Service
AdGroupCriterionService
MutateJobService
Inheritance
A biddable (positive) criterion in an adgroup.
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201506 - Fields
-
- adGroupId
- criterionUse
- criterion
- labels
- forwardCompatibilityMap
- AdGroupCriterion.Type
- userStatus
- systemServingStatus
- approvalStatus
- disapprovalReasons
- destinationUrl
- experimentData
- firstPageCpc
- topOfPageCpc
- qualityInfo
- biddingStrategyConfiguration
- bidModifier
- finalUrls
- finalMobileUrls
- finalAppUrls
- trackingUrlTemplate
- urlCustomParameters
| Field | Type | Description |
|---|---|---|
| AdGroupCriterion (inherited) | ||
| adGroupId Required
|
xsd:long
|
The ad group this criterion is in.
This field is required and should not be null.
|
| criterionUse ReadOnly
|
CriterionUse
|
This field is read only and will be ignored when sent to the API.
Enumerations
|
| criterion Required
|
|
The criterion part of the ad group criterion.
This field is required and should not be null.
|
| labels ReadOnly
|
Labels that are attached to the AdGroupCriterion. To associate an existing Label to an existing AdGroupCriterion, use AdGroupCriterionService.mutateLabel with ADD operator. To remove an associated Label from the AdGroupCriterion, use AdGroupCriterionService.mutateLabel with REMOVE operator. To filter on Labels, use one of Predicate.Operator.CONTAINS_ALL, Predicate.Operator.CONTAINS_ANY, Predicate.Operator.CONTAINS_NONE operators with a list of Label ids. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET. | |
| forwardCompatibilityMap |
String_StringMapEntry[]
|
This Map provides a place to put new features and settings in older versions of the AdWords API in the rare instance we need to introduce a new feature in an older version. It is presently unused. Do not set a value. |
| AdGroupCriterion.Type |
xsd:string
|
Indicates that this instance is a subtype of AdGroupCriterion. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead. |
| BiddableAdGroupCriterion | ||
| userStatus |
UserStatus
|
Current user-set state of criterion.
UserStatus may not be set to REMOVED. On add, defaults to
ENABLED if unspecified.
Enumerations
|
| systemServingStatus ReadOnly
|
SystemServingStatus
|
Serving status.
This field is read only and will be ignored when sent to the API.
Enumerations
|
| approvalStatus ReadOnly
|
ApprovalStatus
|
Approval status.
This field is read only and will be ignored when sent to the API.
Enumerations
|
| disapprovalReasons ReadOnly
|
xsd:string[]
|
List of disapproval reasons. This field is read only and will be ignored when sent to the API. |
| destinationUrl |
xsd:string
|
Destination URL override when Ad is triggered by this criterion.
Some sample valid URLs are: "http://www.website.com", "http://www.domain.com/somepath". Set to the empty string ("") to clear the destination URL. |
| experimentData |
BiddableAdGroupCriterionExp...
|
The campaign bidding strategy specific experiment data for this criterion. |
| firstPageCpc ReadOnly
|
Bid
|
First page Cpc for this criterion. This field is read only and will be ignored when sent to the API. |
| topOfPageCpc ReadOnly
|
Bid
|
An estimate of the cpc bid needed for your ad to appear above the first page of Google search results when a query matches the keywords exactly. Note that meeting this estimate is not a guarantee of ad position, which may depend on other factors. This field is read only and will be ignored when sent to the API. |
| qualityInfo ReadOnly
|
QualityInfo
|
Contains quality information about the criterion. This field is read only and will be ignored when sent to the API. |
| biddingStrategyConfiguration |
BiddingStrategyConfiguration
|
Bidding configuration for this ad group criterion. To set the bids on the ad groups use BiddingStrategyConfiguration.bids. Multiple bids can be set on ad group criterion at the same time. Only the bids that apply to the campaign's bidding strategy bidding strategy will be used. |
| bidModifier |
xsd:double
|
Bid modifier of the criterion which is used when the criterion is not in an absolute bidding dimension. |
| finalUrls |
UrlList
|
A list of possible final URLs after all cross domain redirects. |
| finalMobileUrls |
UrlList
|
A list of possible final mobile URLs after all cross domain redirects. |
| finalAppUrls |
AppUrlList
|
A list of final app URLs that will be used on mobile if the user has the specific app installed. |
| trackingUrlTemplate |
xsd:string
|
URL template for constructing a tracking URL.
On update, empty string ("") indicates to clear the field. |
| urlCustomParameters |
CustomParameters
|
A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. |