Sign in
Ad Campaigns

Read a campaign's ad schedule (dayparting)

The windows a Google campaign serves in, with the bid modifier on each, plus the criterion ids Google minted for them.

An EMPTY schedule is meaningful and is not a failed lookup: Google has no "all day" criterion, so a campaign with no ad schedule serves around the clock. servesAroundTheClock states that explicitly.

Set includePerformance=true to also get delivery split by day of week and by hour, which is the evidence for deciding what the schedule should be. It is one extra Google call segmented by both dimensions at once, so the two views always agree.

Google Ads only. The response carries cachedAt and stale, set when a quota-exhausted call falls back to the last-good copy instead of a live read.

get/v1/ads/campaigns/{campaignId}/ad-schedule

Path parameters

campaignIdstring required

Numeric Google platform campaign id.

Query parameters

platform'google'

Disambiguates the campaign id when the connection spans platforms.

includePerformanceboolean

Also return delivery by day of week and by hour. Costs one extra Google call.

windowDaysinteger

Trailing window for the performance split. Ignored when fromDate and toDate are both given.

fromDatestring date

Start of an explicit performance range (YYYY-MM-DD). Use together with toDate.

toDatestring date

End of an explicit performance range (YYYY-MM-DD). Must be on or after fromDate.

Response

The campaign's ad schedule

campaignIdstring
servesAroundTheClockboolean

True when the campaign carries no ad schedule at all, so it can serve at any time.

cachedAtstring date-time nullable
staleboolean

True when a quota-exhausted read served the last-good copy.

Changes

Changed in 4 of the 56 revisions of this API.15

  • 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

  • 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

  • a23eb241746a1See the full diff
    • ○

      endpoint added

      endpoint-added