Except as otherwise noted,
the content of this page is licensed under the Creative Commons
Attribution 3.0 License.
Google Code offered in: English - Español - 日本語 - 한국어 - Português - Pусский - 中文(简体) - 中文(繁體)
Documentation for the requested version is not available.Documentation for the requested diff is not available.
Data associated with a keyword criterion. This data is used by the
CriterionService.
Note:
For statically typed languages, such as Java, create an instance of Keyword.
For dynamically typed languages such as Perl and Python,
create a Criterion data object. Then either specify the xsi:type attribute as
Keyword or set the criterionType field to Keyword.
| Field name | Field type | Field description |
|---|---|---|
| adGroupId | long |
ID of the ad group associated with this criterion.
This field is not mutable. |
| criterionType | CriterionType |
Concrete type of this criterion. Generally, this attribute is
read-only, but may be set by scripting languages to indicate a concrete
type.
Values are:
|
| destinationUrl | string |
Destination URL associated with this criterion. Optional.
If absent, the destination URL associated with the Ad will be
used instead. |
| exemptionRequest | string |
Reason for allowing submission of a keyword that violates the ad
policies described by Google's AdWords Editorial Guidelines. Must be no
longer than 300 characters.
Set this field only if this keyword violates policy. Unnecessarily specifying an exemption request will cause any add or update operation to fail. For more information, see Policy Checking in the Web Services overview. |
| firstPageCpc new in v13 |
long |
Approximate cost-per-click (CPC) bid needed for associated ads to reach the
first page of Google search results when a search query exactly matches
this keyword. For more information, see
First Page Bid Estimates in the AdWords Help Center. |
| id | long |
ID of this criterion.
This field is set by CriterionService when this criterion is
created and is not mutable. |
| language | string |
Language for this criterion.
This field is not mutable. |
| maxCpc | long |
The maximum cost-per-click you are willing to pay for this keyword.
If zero, the parent ad group's CPC bid is used instead.
This value is interpreted as micro-units of the currency associated
with the account. |
| minCpc | long |
Minimum cost-per-click required for this keyword to be active
in live advertising, represented as micro-units of the currency
associated with the account.
This field is read only, and its value depends on a
variety of factors, such as how many advertisers are bidding
for this keyword and the effectiveness of the keyword. |
| negative | boolean |
If this criterion is negative, queries or placements that match its text
or URL will prevent the display of ads in its associated ad group. |
| paused | boolean |
True if this criterion is paused. |
| proxyMaxCpc | long |
When present, this read-only field indicates that there is a proxy
bid that is active for this keyword. This will be the case, for instance,
when budget optimizer is turned on for the campaign that this keyword
is a part of. |
| qualityScore new in v13 |
int |
Overall quality of this keyword, ranging from 1 (lowest quality) to 10
(highest quality). For more information, see
Quality Score in the AdWords Help Center. |
| status | CriterionStatus |
Status of this criterion.
Values are:
|
| text | string |
Text of this keyword.
This field is not mutable after the being initially set. Must be no
longer than 80 characters and no more than ten words.
The text can contain only letters, digits, and the following special
characters:
space # $ & _ - " [ ] ' + . / : |
| type | KeywordType |
How this keyword is matched against search queries.
This field is not mutable after being initially set.
Values are:
|