Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.keywordPlanAdGroupKeywords

Resource: KeywordPlanAdGroupKeyword

A Keyword Plan ad group keyword. Max number of keyword plan keywords per plan: 10000.

JSON representation
{
  "resourceName": string,
  "matchType": enum (KeywordMatchType),
  "keywordPlanAdGroup": string,
  "id": string,
  "text": string,
  "cpcBidMicros": string,
  "negative": boolean
}
Fields
resourceName

string

Immutable. The resource name of the Keyword Plan ad group keyword. KeywordPlanAdGroupKeyword resource names have the form:

customers/{customerId}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}

matchType

enum (KeywordMatchType)

The keyword match type.

keywordPlanAdGroup

string

The Keyword Plan ad group to which this keyword belongs.

id

string (int64 format)

Output only. The ID of the Keyword Plan keyword.

text

string

The keyword text.

cpcBidMicros

string (int64 format)

A keyword level max cpc bid in micros (e.g. $1 = 1mm). The currency is the same as the account currency code. This will override any CPC bid set at the keyword plan ad group level. Not applicable for negative keywords. (negative = true) This field is Optional.

negative

boolean

Immutable. If true, the keyword is negative.

Methods

get

Returns the requested Keyword Plan ad group keyword in full detail.

mutate

Creates, updates, or removes Keyword Plan ad group keywords.