Ads · Ad Campaigns
Replaces a campaign's ad schedule (dayparting). Works with Google Ads.
https://api.pozy.ai/v1/ads/campaigns/{campaignId}/ad-scheduleGuide: Google Ads
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
campaignIdrequired | string |
Request body
application/json, required
schedulearray of objectrequiredUp to 42 items.
dayOfWeekstringrequiredOne of
MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY.startHourintegerrequired0 to 23.
startMinuteintegerOne of
0,15,30,45. Default0.endHourintegerrequired0 to 24.
endMinuteintegerOne of
0,15,30,45. Default0.bidModifiernumber0.1 to 10. Can be null.
Example
curl -X PUT "https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e/ad-schedule" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"schedule": [
{
"dayOfWeek": "MONDAY",
"startHour": 1,
"endHour": 1
}
]
}'const res = await fetch("https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e/ad-schedule", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
schedule: [
{
dayOfWeek: "MONDAY",
startHour: 1,
endHour: 1
}
]
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.put(
"https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e/ad-schedule",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"schedule": [
{
"dayOfWeek": "MONDAY",
"startHour": 1,
"endHour": 1,
},
],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
campaignIdstringschedulearray of object8 child fields
criterionIdstringresourceNamestringdayOfWeekstringOne of
MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY.startHourinteger0 to 23.
startMinuteintegerOne of
0,15,30,45.endHourinteger0 to 24.
endMinuteintegerOne of
0,15,30,45.bidModifiernumberCan be null.
servesAroundTheClockboolean
{
"campaignId": "65a3737dd8b11ea61f199e6e",
"schedule": [
{
"criterionId": "6b845e5fcfff945d049c4701",
"resourceName": "Acme",
"dayOfWeek": "MONDAY",
"startHour": 1,
"startMinute": 0,
"endHour": 1,
"endMinute": 0,
"bidModifier": 12.5
}
],
"servesAroundTheClock": true
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.