Campaigns

Update a campaign

Changed on

Send only the fields to change. Google Ads settings are saved in Fandom; a campaign already in Google Ads picks them up on its next sync from the app.

Scope: campaigns:write.

Send an Idempotency-Key header to make retries safe.

patch/campaigns/{campaignId}

Request

Path parameters

campaignIdstring required

Campaign id.

Headers

Idempotency-Keystring

Any unique string. Repeating a request with the same key returns the first result instead of doing it twice.

Request body

namestring
objectivestring

What the campaign should achieve and for whom. Drives targeting.

brandIdstring nullable

Brand id.

industrystring
languagestring

Language code. Default en.

locationsstring[]

Country or region codes, e.g. ["US"]. Default ["US"].

successMetricsstring[]
campaignType'SEARCH' | 'DEMAND_GEN' | 'VIDEO' | 'DISPLAY'

Google Ads campaign type.

budgetnumber nullable
budgetType'daily' | 'total'
endDatestring nullable

YYYY-MM-DD. Required for a total budget.

biddingStrategy'MAXIMIZE_CONVERSIONS' | 'MAXIMIZE_CONVERSION_VALUE' | 'TARGET_CPA' | 'TARGET_ROAS' | 'TARGET_CPC' | 'TARGET_SPEND' | 'MANUAL_CPC' nullable

Google Ads bidding strategy.

targetCpanumber nullable
targetRoasnumber nullable

Response

Success

idstring required
namestring required
statusstring required

draft, loading (collecting data), ready or error.

objectivestring required
brandIdstring nullable required
industrystring required
languagestring required
locationsstring[] required
successMetricsstring[] required
campaignTypestring nullable required
budgetnumber nullable required

In the account's currency.

budgetType'daily' | 'total' nullable required
endDatestring nullable required
biddingStrategystring nullable required
targetCpanumber nullable required
targetRoasnumber nullable required
urlstring required

Opens the campaign in Fandom.

createdAtstring nullable required
updatedAtstring nullable required

Changes