Sign in
Ad Campaigns

Read a campaign's current bidding

Read of the campaign's bidding strategy on Google, cached for the quota window, for pre-filling the bid strategy block before a PUT to /v1/ads/campaigns/{campaignId}. Google Ads only; platform is required and rejected when it is anything else, since a campaignId is not globally unique. The response carries cachedAt and stale, set when a quota-exhausted call falls back to the last-good copy instead of a live read.

Maps Google's bidding strategy onto the same triplet PUT accepts: LOWEST_COST_WITHOUT_CAP (Maximize Conversions, no target), COST_CAP + bidAmount (Target CPA), LOWEST_COST_WITH_MIN_ROAS

  • roasAverageFloor (Target ROAS), LOWEST_COST_WITH_BID_CAP + bidAmount (Maximize Clicks with a CPC ceiling). A campaign on a portfolio strategy returns portfolio (id + name) and bidSpec.portfolioBidStrategyId instead of the triplet. Anything else (Manual CPC, Target Impression Share, ...) returns bidSpec: null; show biddingStrategyType as-is.
get/v1/ads/campaigns/{campaignId}/bidding

Path parameters

campaignIdstring required

Numeric Google platform campaign id.

Query parameters

accountIdstring required

Zernio Google Ads SocialAccount id: resolves the customer id + refresh token.

platform'google' required

Required: campaign IDs are not globally unique. Only "google" is supported today.

adAccountIdstring

Platform ad account ID (Google customer ID, digits only). Required when the connection has multiple Google Ads accounts; optional (and inferred) when it has only one.

customerIdstring

Alias of adAccountId, kept for existing callers

Response

Campaign bidding

campaignIdstring
channel'SEARCH' | 'DISPLAY'

campaign.advertising_channel_type. COST_CAP's underlying Google field differs by channel; see bidStrategy on PUT.

biddingStrategyTypestring

Google's raw enum: MAXIMIZE_CONVERSIONS, TARGET_CPA, MAXIMIZE_CONVERSION_VALUE, TARGET_ROAS, TARGET_SPEND, MANUAL_CPC, TARGET_IMPRESSION_SHARE, or another Google adds later.

cachedAtstring date-time nullable

When this data was fetched from Google. Null when it was never served from cache.

staleboolean

True when Google's daily API quota was exhausted and this is the last successful fetch, not a live read.

Changes

Changed in 6 of the 55 revisions of this API.19

  • 2c04683ce6948See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd3865482f9f2See the full diff
    • ○

      added the new optional query request parameter adAccountId

      new-optional-request-parameter

    • ○

      query request parameter customerId was deprecated

      request-parameter-deprecated

  • 3e6ddf2a99ea2See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0dba7d004d754See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • e70ed06e71502See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • d7a8fa118ef01See the full diff
    • ○

      endpoint added

      endpoint-added