ads
PUT /v1/ads/shield
Switch the shield off or on, and set the figures its estimate uses.
Authentication
Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/ads/shield \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on ads.manage; audit action ads.shield_update. avg_cpc_minor is the organisation's average cost per click in integer minor units of currency (0 = show no estimate). conversion_paths are URL path prefixes that count as a conversion: a click followed by one is never flagged.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | — |
enabled | boolean | No | — |
avg_cpc_minor | integer | No | — |
currency | string | No | — |
conversion_paths | string[] | No | — |
exclusions_enabled | boolean | No | Propose IP and placement exclusions to the connected Google Ads accounts. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | Yes | — |
enabled | boolean | Yes | — |
avg_cpc_minor | integer | Yes | — |
currency | string | Yes | — |
conversion_paths | string[] | Yes | — |
period_days | integer | Yes | — |
clicks | integer | Yes | — |
suspected | integer | Yes | — |
converted | integer | Yes | — |
by_reason | object | Yes | — |
estimated_wasted | object[] | Yes | — |
suspect_at | integer | Yes | — |
reasons_known | string[] | Yes | — |
claim_window_days | integer | Yes | — |
retention_days | integer | Yes | — |
estimate_sources | object | No | How many estimated costs came from Google's measured average CPC for the click's keyword (keyword_day) or campaign (campaign_day) that day, or from the organisation's own… |
exclusions_enabled | boolean | No | — |
exclusions | object | No | The organisation's shield exclusions counted by status. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429