Zernio
Zernio
API Reference

Campaigns and Ads

Overview

Get campaign treeGETGet daily account metricsGET

Campaigns

List campaignsGETCreate a standalone campaignPOSTUpdate a campaignPUTDuplicate a campaignPOSTDelete a campaignDELETEPause or resume a campaignPUTPause or resume many campaignsPOSTList campaign assetsGETAttach campaign assetsPOSTUpdate campaign assetsPUTRemove campaign assetsDELETERead a Google campaign's device, location, and language targetingGETEdit a Google campaign's device, location, or language targetingPUTList Performance Max asset groupsGET

Ad Sets

List ad setsGETCreate a standalone ad groupPOSTGet live ad-set detailsGETUpdate an ad setPUTDuplicate an ad setPOSTDelete an ad setDELETEPause or resume a single ad setPUTList ad-group assetsGETAttach ad-group assetsPOSTUpdate ad-group assetsPUTRemove ad-group assetsDELETE

Ads

List adsGETGet ad detailsGETCreate standalone adPOSTBoost post as adPOSTUpdate adPUTDuplicate an adPOSTCancel an adDELETEPause or resume a single adPUT

Keywords

List Search keywordsGETAdd Search ad-group keywordsPOSTPause or enable a Search keywordPATCHRemove a Search keywordDELETEList campaign-level negative keywordsGETReplace campaign-level negative keywordsPUTList campaign negative listsGETReplace campaign negative listsPUT

Bidding

Read a campaign's current biddingGETList portfolio bid strategiesGETCreate portfolio bid strategyPOSTUpdate portfolio bid strategyPATCH

Other

Get live campaign detailsGETRead a campaign's ad schedule (dayparting)GETReplace a campaign's ad schedule (dayparting)PUT
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Campaigns and Ads

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.

PlatformsGoogle
GET
/v1/ads/campaigns/{campaignId}/ad-schedule

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

campaignId*string

Numeric Google platform campaign id.

Query Parameters

platform?"google"

Disambiguates the campaign id when the connection spans platforms.

Value in

  • "google"
includePerformance?boolean

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

windowDays?integer

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

Range1 <= value <= 90
Default30
fromDate?string

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

Formatdate
toDate?string

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

Formatdate

Response Body

application/json

application/json

application/json

application/json

{  "campaignId": "string",  "schedule": [    {      "criterionId": "string",      "resourceName": "string",      "dayOfWeek": "MONDAY",      "startHour": 0,      "startMinute": 0,      "endHour": 0,      "endMinute": 0,      "bidModifier": 0    }  ],  "servesAroundTheClock": true,  "cachedAt": "2019-08-24T14:15:22Z",  "stale": true,  "performance": {    "windowDays": 0,    "byDayOfWeek": [      {        "dayOfWeek": "MONDAY",        "impressions": 0,        "clicks": 0,        "cost": 0,        "conversions": 0      }    ],    "byHour": [      {        "hour": 0,        "impressions": 0,        "clicks": 0,        "cost": 0,        "conversions": 0      }    ]  }}
Was this page helpful?

Get live campaign details

Reads one campaign live from Meta, returned verbatim, so a caller that knows a campaign id no longer has to page `GET /v1/ads/campaigns` to find it. The default projection covers name, status, objective, buying type, bid strategy, budgets, spend cap, schedule and `issues_info`. `fields` is a raw-passthrough override; unknown fields return Meta's 400 verbatim. A campaign the resolved connection cannot see comes back as Meta's own 400, not a 404.

Replace a campaign's ad schedule (dayparting)

Replaces the campaign's whole ad schedule with the windows you send. This is a REPLACE, not a merge: windows you leave out stop serving. Send `schedule: []` to clear dayparting, which returns the campaign to serving around the clock. Google rules enforced here, so you get a named field instead of a criterion error: at most 6 windows per day, a window must end after it starts, windows on the same day may not overlap, `endHour` 24 is midnight and cannot carry minutes, and minutes are quarter-hours only (0, 15, 30, 45). `bidModifier` is 0.1-10.0; Google's 0 means "off" for devices only, so a window is switched off by leaving it out. Windows are half-open (Google is exclusive of the end minute), so 09:00-12:00 and 12:00-17:00 on the same day are adjacent and both valid. Google cannot edit an ad schedule in place (every AdScheduleInfo field is prohibited on update), so this removes the live criteria and creates the new ones in a single atomic mutate. The response is read back from Google and carries the new criterion ids.