Contents

KeywordCreate

The request body for creating a new Keyword object.

Declaration

object KeywordCreate

Properties

NameTypeDescription
adGroupId Requiredint64

The ad group this keyword targets.

text Requiredstring

The keyword text as entered by the advertiser. Can’t be changed after creation. To change it, delete the keyword and create a new one.

matchTypeKeywordCreate.MatchType

The match type for this keyword. Values: EXACT, BROAD, PHRASE, CATEGORY. See KeywordMatchType. Immutable after creation. To change it, delete the keyword and create a new one.

bidMoney

Per-keyword bid override as a Money object. See Money. Overrides the ad group default bid. Omit or pass null to default to the ad group’s BidStrategy bid. Not used with Maximize Conversions bid strategy campaigns.

statusKeywordCreate.Status

Whether this keyword is active and eligible to serve. Values: ENABLED, PAUSED. See KeywordStatus.

Discussion

The KeywordCreate object is the request payload for adding a keyword to an ad group via POST /v1/keywords (Create a Keyword), after the ad group has already been created. The AdGroupCreate doesn’t support keywords inline. See the properties below for field-level requirements, mutability, and defaults.

Example

{
  "adGroupId": 555666777,
  "text": "photo editor",
  "matchType": "EXACT",
  "bid": {
    "amount": "2.50",
    "currency": "USD"
  },
  "status": "ENABLED"
}

Topics

Type Aliases

See Also