ads

Create an ad

Creates an ad in an ad group. The default format is a responsive search ad built from headlinePart1, headlinePart2, headlinePart3, description, description2 and finalUrl. Platforms whose creative is a separate object (a promoted post, for example) read creative instead.

An ad is shown only once its campaign has been synced and is serving. 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/ads

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/ads
  • 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

angleIdstring

The angle (claim) this ad argues. Results are reported per angle.

conceptIdstring

The concept (way of making the claim) this ad is a rendition of.

angleProvenance'generated' | 'user' | 'inferred'

Where the angle stamp came from: written by Growomat, set by you, or inferred from the copy. Defaults to user when you set angleId yourself.

_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 ad belongs to.

campaignIdstring required

The campaign of that ad group.

type'RESPONSIVE_SEARCH_AD' | 'RESPONSIVE_DISPLAY_AD' | 'PERFORMANCE_MAX_ASSET_GROUP' | 'VIDEO_AD' | 'REDDIT_TEXT_POST' | 'REDDIT_IMAGE_POST' | 'REDDIT_VIDEO_POST' | 'REDDIT_CAROUSEL_POST' | 'META_LINK_AD' | 'META_IMAGE_AD' | 'META_VIDEO_AD' | 'META_CAROUSEL_AD' | 'OPENAI_CHAT_CARD' | 'OPENAI_PRODUCT_AD_TEMPLATE' | 'LINKEDIN_SINGLE_IMAGE' | 'LINKEDIN_TEXT_AD' | 'LINKEDIN_VIDEO' | 'LINKEDIN_CAROUSEL' | 'LINKEDIN_DOCUMENT'

Ad format. Defaults from the campaign type per platform; ads imported from a platform record the format that actually serves.

headlinePart1string required

First headline. Up to 30 characters on search platforms.

headlinePart2string required

Second headline. Up to 30 characters on search platforms.

headlinePart3string

Third headline, optional. Up to 30 characters on search platforms.

descriptionstring required

First description line. Up to 90 characters on search platforms.

description2string

Second description line, optional. Up to 90 characters on search platforms.

finalUrlstring uri required

The landing page.

path1string

First display-path segment shown after the domain in the ad.

path2string

Second display-path segment.

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

A paused ad is not shown.

calloutsstring[]

Short phrases shown under the ad, for example "Free shipping".

customLabelsstring[]

Free-form labels for your own grouping and reporting.

trackingUrlTemplatestring

Tracking template for this ad; overrides the ad group's and the campaign's.

finalUrlSuffixstring

Query string appended to the final URL; overrides the ad group's and the campaign's.

urlCustomParametersobject

Custom {_name} parameters available to tracking templates.

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.