KeywordRequest (AdWords API Developer's Guide)

KeywordRequest

Represents a keyword whose traffic is to be estimated.

To get traffic estimates for ads triggered by a keyword, such as how many clicks a day the ad might get or what the average position might be, create a KeywordRequest for each keyword to be estimated. See TrafficEstimatorService for details of how to submit the request for estimation.

The results of the estimation are returned as KeywordEstimate objects.

Fields

id
maxCpc
negative
text
type

Field name	Field type	Field description
`id`	`long`	The id of the keyword. Optional - if omitted indicates a new keyword. When requesting estimates for a keyword, you can specify: KeywordRequests for new keywords that have no ad group In this case, you would use the `TrafficEstimatorService.estimateKeywordList` request. The keyword must be new, and the id is not required (it will be ignored if provided) KeywordRequests for new or existing keywords associated with an AdGroupRequest. In this case you would use either the `TrafficEstimatorService.estimateAdGroupList` or `TrafficEstimatorService.estimateCampaignList` request as applicable. The keyword can be new or existing, hence the id is optional depending on the situation.
`maxCpc`	`long`	The bid (maximum cost per click) for this keyword in micros. See Monetary Units for information about micros. When requesting estimates for a keyword, you can specify: KeywordRequests for new keywords that have no ad group, or KeywordRequests for new or existing keywords associated with an AdGroupRequest. Keywords, KeywordRequests, AdGroups, and AdGroupRequests can each specify maxCpc values. The TrafficEstimatorService uses the following rules, in order of preference, to determine which value of maxCpc to use: maxCpc on the KeywordRequest is used, if any maxCpc on the existing keyword is used, if any maxCpc on the AdGroupRequest is used, (if applicable and if any) maxCpc on the existing AdGroup is used (if applicable) as the last resort In general, the maxCpc of a KeywordRequest is optional, since there is usually another maxCpc that can be used, such as the maxCpc on an existing keyword, an existing AdGroup or an AdGroupRequest. However, if there is no backup value of maxCpc anywhere along the line, you must provide a value for maxCpc in the KeywordRequest. This would happen, for example, if the KeywordRequest is for a new keyword and is not associated with an AdGroupRequest.
`negative`	`boolean`	Whether the keyword is negative or not. The default is false. Optional. If specified, overrides the negativity of an existing keyword. If a keyword is negative, your ad will not appear when a user searches for that keyword.
`text`	`string`	The text of the keyword. Required for new keywords, optional for existing keywords.
`type`	`KeywordType`	The match type of the keyword. Required unless the keyword's id indicates an existing keyword, in which case it acts as an override. For information about match types, see the page Keyword Matching Options in the Adwords Help Center. Note: when supplying the keyword match type via the AdWords API, you do not need to use the special characters as described in the AdWords Help Center. Values are: Broad Phrase Exact