|
|
Keyword
The Keyword object represents a keyword, a search term that you bid on and that is related to the products or services you want to advertise. Values set at the keyword level override corresponding values set at the ad group level.
Before you attempt to set the advancedMatchON element or provide a value for the sponsoredSearchMaxBid element, read Setting Tactics and Setting Bids.
Note the following about keyword text:
- A keyword has three forms: (1) text: "fancy red cars", (2) canonicalSearchText: "car fancy red" and (3) phraseSearchText: "fancy red car".
- The canonicalSearchText form is determined by the system and must be unique within an ad group. If you submit two keywords that both resolve to the same canonicalSearchText form, the second submission will be rejected as a duplicate. For example, keywords "fancy red cars" and "fancy red car" have the same canonicalSearchText form: "car fancy red". If keyword "fancy red car" is the second submission, it will be rejected.
- If a keyword having editorialStatus as "Approved" is updated & submitted for editorial review, the update field is set to "true" in this object. The requested changes will not be reflected in this object until they are approved. To determine the updates for a keyword that have been submitted for editorial review, use the KeywordService.getUpdateForKeyword operation.
Elements
- accountID
- adGroupID
- advancedMatchON
- alternateText
- canonicalSearchText
- createTimestamp
- deleteTimestamp
- editorialStatus
- ID
- lastUpdateTimestamp
- participatesInMarketplace
- phraseSearchText
- sponsoredSearchBidStatus
- sponsoredSearchMaxBid
- sponsoredSearchMaxBidTimestamp
- sponsoredSearchMinBid
- status
- text
- update
- url
- watchON
| Restrictions * | Element | Data Type | Description | Add | Full-Up | Part-Up |
|---|---|---|---|---|---|
| accountID | string | The account ID the keyword is associated with. | RO | RO | RO |
| adGroupID | long | The adgroup ID the keyword is associated with. | Req | Req | Opt |
| advancedMatch ON |
boolean | If true, the Sponsored Search advanced match type is enabled. | Opt | Req | Opt |
| alternateText | string | The alternate text that can be dynamically substituted for the keyword. | Opt | Opt | Opt |
| canonicalSearch Text |
string | The canonical form of the keyword (automatically generated by the system). The canonical form of the keyword must be unique within an ad group. | RO | RO | RO |
| createTimestamp | dateTime | The date the keyword is created. | RO | RO | RO |
| deleteTimestamp | dateTime | The date the keyword is deleted. | RO | RO | RO |
| editorialStatus | EditorialStatus | The editorial status of the keyword. | RO | RO | RO |
| ID | long | The ID of the keyword. | RO | Req | Req |
| lastUpdateTimestamp | dateTime | The date the keyword was last updated. | RO | RO | RO |
| participates InMarketplace |
boolean | If true, the keyword is participating in the marketplace. | RO | RO | RO |
| phraseSearch Text |
string | The phrase canonical form of the keyword (automatically generated by the system). | RO | RO | RO |
| sponsoredSearch BidStatus |
BidStatus | The status of the maximum bid for Sponsored Search (sponsoredSearchMaxBid). | RO | RO | RO |
| sponsoredSearch MaxBid |
double | The maximum bid for Sponsored Search. | Opt | Opt | Opt |
| sponsoredSearch MaxBidTimestamp |
dateTime | The date the maximum bid for Sponsored Search is set. | RO | RO | RO |
| sponsoredSearch MinBid |
double | The minimum bid for Sponsored Search. This has a value of "-1" for the markets that use the Market Minimum Bids. Please see the Setting Bids section to understand the types of bids. | RO | RO | RO |
| status | KeywordStatus | The status of the keyword. You can set the status to On or Off, but not Deleted. | Req | Req | Opt |
| text | string | The raw form of the keyword (the word or phrase as entered). The text element is required but cannot be updated; if you want to change the value, create a new keyword instead. | Req | RO | RO |
| update | boolean | If true, an update for the keyword has been submitted that requires editorial review. | RO | RO | RO |
| url | string | The custom URL, which is used to create a specific keyword+destination URL that supports a more tailored landing page for the keyword. If specified, the custom URL overrides the ad's destination URL. | Opt | Opt | Opt |
| watchON | boolean | If true, the keyword can be monitored through the web application. | Opt | Req | Opt |