Skip to main content
Version: v3

Upsert Google campaign

PUT 

/ad-publishing/google/ads

Create or update a full Google Ads campaign structure

Request

Version stringrequired

API Version

Available optionsv3
application/json

Bodyrequired

    idstring

    Campaign identifier

    namestringrequired

    Campaign name

    locationIdstringrequired

    Location identifier

    advertisingChannelTypestringrequired

    Advertising channel. Only SEARCH and DEMAND_GEN campaigns can be built and published by this product; the other Google channels are readable on existing campaigns but cannot be created here.

    Available optionsSEARCHDEMAND_GEN
    advertisingChannelSubTypestring

    Channel sub type

    Available optionsDEMAND_GEN
    goalTypestring

    Goal type

    Available optionsWEBSITE_TRAFFICLEAD
    budgetobject

    Campaign budget

    audienceobject

    Campaign audience targeting

    networkSettingsobject

    Network settings

    biddingStrategyobject

    Bidding strategy config

    assetsobject

    Campaign assets

    isEuPoliticalAdsboolean

    EU political ads flag

    adGroupsobject[]

    Campaign ad groups

    campaignGoalobject

    Campaign goal config

    adScheduleobject[]

    Ad schedule rules

    publishingStatusstring

    Publishing status

    Available optionsDRAFTSCHEDULEDPUBLISHEDPUBLISHINGFAILEDIN_REVIEWPAUSEDARCHIVEDWITH_ISSUESREJECTED
    googleAdAccountIdstring

    Google Ad account identifier

    unpublishedChangesboolean

    Whether the campaign has unpublished changes

    maximumCpcnumber

    Maximum CPC bid in micros

    googleCampaignIdstring

    Google Ads campaign resource ID

    sourcestring

    Traffic source

    advancedOptionsobject

    Advanced options

    customValueMappingsobject

    User-provided overrides for custom_values merge tags used in ad copy

application/json

The saved campaign document, same shape as GET /ads/{adId}

Schema
    idstringrequired

    Campaign identifier

    namestringrequired

    Campaign name

    locationIdstringrequired

    Location identifier

    googleAdAccountIdstringrequired

    Google Ads customer id the campaign belongs to

    advertisingChannelTypestringrequired

    Advertising channel

    Available optionsSEARCHDEMAND_GEN
    publishingStatusstringrequired

    Publishing status

    Available optionsDRAFTSCHEDULEDPUBLISHEDPUBLISHINGFAILEDIN_REVIEWPAUSEDARCHIVEDWITH_ISSUESREJECTED
    sourcestringrequired

    Where the campaign was created from

    budgetobjectrequired

    Budget configuration

    networkSettingsobjectrequired

    Network placement settings

    biddingStrategyobjectrequired

    Bidding configuration

    campaignGoalobjectrequired

    Campaign goal

    assetsobjectrequired

    Attached assets by kind

    audienceobjectrequired

    Campaign level targeting

    adScheduleobject[]required

    Ad scheduling windows, empty when the campaign runs continuously

    adGroupsobject[]required

    Ad groups with their ads

    unpublishedChangesbooleanrequired

    Whether the campaign has edits not yet published

    isEuPoliticalAdsbooleanrequired

    Whether the campaign is declared as EU political advertising

    metaobject

    Ancillary campaign metadata

    createdBystringrequired

    User who created the campaign

    updatedBystringrequired

    User who last updated the campaign

    createdAtstringrequired

    Created at

    updatedAtstringrequired

    Updated at