ads

POST /v1/ads/shield/claims/{claim_id}/outcome

Record Google's answer to a sent pack (credit received or none).

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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 POST https://api.zinndigital.com/v1/ads/shield/claims/{claim_id}/outcome \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "outcome": <string<credited, declined>> }'

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_claim_outcome (za-22, za-N8). For a pack marked sent, a person records the credit Google gave (integer minor units, §2.8) or that Google gave none: card-paying accounts have no invoices to read, so Google's reply is the only answer. Zinn® never moves money here; this is a record of a credit Google gave the ad account. 409 when the pack is not sent yet, or when its answer was read from the account's invoices (those are never overwritten). A person-recorded answer can be corrected; the write is conditional, so an invoice answer landing while the request runs is a 409, never overwritten.

Parameters

NameTypeRequiredWhat it is
claim_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
org_idstringNo—
outcomestring<credited, declined>Yes—
credited_minorobjectNoRequired when outcome is credited; minor units of the pack's currency.
currencystringNoOnly used when neither the pack nor its ad account has a currency yet; 422 when it differs from the pack's (Google credits in the account's currency).

Response

NameTypeRequiredWhat it is
idstringYes—
connection_idstringYes—
accountstringYesThe Google Ads customer id.
account_labelstringYes—
monthstringYes—
statusstring<ready, filed, credited, declined>Yes—
clicksintegerYes—
estimated_cost_minorintegerYes—
currencystringYes—
filed_atobjectYes—
referencestringYes—
credited_minorobjectYesGoogle's invalid-activity credit for the month, integer minor units of currency: read from the account's invoices, or recorded by a person from Google's answer (credit_note =…
credit_checked_atobjectYes—
credit_notestringYesno_monthly_invoicing when the account has no invoices to read (record Google's answer by hand); no_credit_on_invoices when the three invoices after the month closed with no…
google_form_urlstringYesGoogle's invalid-click investigation form.

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429