Ad Campaigns

Preview Ad Campaign Edit

What an edit WOULD change, without applying any of it.

Same body and same response shape as PUT /ad-campaigns/{campaign_id}. Reads the campaign's live platform state to diff against and changes nothing. Run it first: some changes restart the platform's learning phase.

post/ad-campaigns/{campaign_id}/edit-preview

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/ad-campaigns/{campaign_id}/edit-preview
  • Auth: HTTP bearer

Path parameters

campaign_idinteger required

The ad campaign's id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

actionstring nullable
namestring nullable
daily_budgetnumber nullable
end_datestring date nullable
headlinestring nullable
primary_textstring nullable
ctastring nullable
destination_urlstring nullable
creative_image_urlstring nullable
creative_image_url_squarestring nullable
creative_image_url_portraitstring nullable
logo_image_urlstring nullable
auto_pause_atstring date-time nullable

Absolute UTC instant to auto-pause at (ISO-8601 with offset)

auto_pause_tzstring nullable
spend_capnumber nullable
clear_auto_stopboolean
keywordsobject[] nullable

Google Search only: COMPLETE desired keyword list [{text, match_type, negative, paused, cpc_bid}]

rsa_headlinesstring[] nullable

Google Search only: COMPLETE list of 3-15 RSA headlines (<=30 chars each)

rsa_descriptionsstring[] nullable

Google Search only: COMPLETE list of 2-4 RSA descriptions (<=90 chars each)

video_asset_idsinteger[] nullable

Google Video only: COMPLETE list of 1-5 ad_video_assets ids (None = unchanged)

video_headlinesstring[] nullable

Google Video only: COMPLETE list, 3-5 × ≤40

video_long_headlinesstring[] nullable

Google Video only: COMPLETE list, 3-5 × ≤90

video_descriptionsstring[] nullable

Google Video only: COMPLETE list, 3-5 × ≤90

video_business_namestring nullable

Google Video only: ≤25 chars

video_ctastring nullable

Google Video only: CallToActionType value

selected_channelsobject nullable

Google Video only: COMPLETE placement map (7 DemandGenSelectedChannels keys)

geo_targetsstring[] nullable

Google only: COMPLETE list of geo target constant ids, e.g. ["2840"]

campaign_negative_keywordsobject[] nullable

Google only: COMPLETE desired campaign-level negative keywords [{text, match_type}]

Response

Successful Response

dataAdPayload required

One ad-platform object, or one handler response.

Changes

No recorded changes to this operation across all 2 revisions of this API.