keywords

Create a keyword

Adds a keyword to an ad group. matchType defaults to BROAD; set isNegative: true for a negative keyword. Changes reach the ad platforms on the next sync.

Errors

  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
post/api/v1/keywords

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/keywords
  • Auth: HTTP bearer

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

_nativeNativeExtensions

Settings that exist on one platform only, keyed by platform id (for example google-ads). Each value is a free-form object that is stored and returned exactly as sent; keys Growomat does not know are kept. Absent by default.

Keys read by platforms whose ad is a post (on the ad, with the campaign as fallback): postType (TEXT or IMAGE), postTitle, postBody, callToAction, imageUrl, videoUrl, videoThumbnailUrl, carouselCards ([{ imageUrl, destinationUrl }]), communities, interests.

Delivery keys read on the campaign: objective, goalType, startTime, endTime, optimizationGoal, conversionPixelId.

adGroupIdstring required

The ad group this keyword belongs to.

campaignIdstring

The campaign of that ad group. Optional; filled in from the ad group when omitted.

textstring required

The search term.

matchType'BROAD' | 'PHRASE' | 'EXACT'

How closely a search must match text.

status'ENABLED' | 'PAUSED' | 'REMOVED'

A paused keyword does not trigger ads.

isNegativeboolean

true makes this a negative keyword: searches matching it never show the ad group's ads.

cpcBidnumber nullable

Maximum cost per click for this keyword, in the campaign currency. null uses the ad group default.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.