API リファレンス
ads
この領域には 50 個のエンドポイントがあります。それぞれに専用のページがあり、パラメータ、レスポンス、実行可能なリクエストが含まれています。
| メソッド | パス | 機能 | 権限 |
|---|---|---|---|
| GET | /v1/ads/builds | The organisation's Simple-mode Google Ads plans, newest first (at most 20). | ads.view |
| POST | /v1/ads/builds | Start a Simple-mode plan from a website, a monthly budget and markets. | ads.manage |
| GET | /v1/ads/builds/{build_id} | One Simple-mode plan in full. | ads.view |
| PATCH | /v1/ads/builds/{build_id} | Change what they sell, the budget, the currency, the markets or the site languages before (re)building. | ads.manage |
| POST | /v1/ads/builds/{build_id}/build | Build (or rebuild) the plan from the current inputs. | ads.manage |
| POST | /v1/ads/builds/{build_id}/launch | Turn a ready plan into approve-first queued changes on one connected account. | ads.manage |
| GET | /v1/ads/changes | The approve-first queue and the change history. | ads.view |
| POST | /v1/ads/changes/{change_id}/{action} | Approve, reject or undo one change. | ads.manage |
| POST | /v1/ads/connect/google | Google's consent URL to connect Google Ads accounts. | ads.manage |
| GET | /v1/ads/connect/google/callback | Google returns the browser here after consent. | API キーがありません |
| GET | /v1/ads/connect/google/grants/{grant_id} | The Google Ads accounts one sign-in reaches. | ads.manage |
| POST | /v1/ads/connect/google/grants/{grant_id} | Connect the picked Google Ads accounts — one connection each. | ads.manage |
| POST | /v1/ads/connect/microsoft | Microsoft's consent URL to connect Microsoft Advertising accounts (za-39). | ads.manage |
| GET | /v1/ads/connect/microsoft/callback | Microsoft returns the browser here after consent. | API キーがありません |
| GET | /v1/ads/connect/microsoft/grants/{grant_id} | The Microsoft Advertising accounts one sign-in reaches. | ads.manage |
| POST | /v1/ads/connect/microsoft/grants/{grant_id} | Connect the picked Microsoft Advertising accounts — one connection each. | ads.manage |
| GET | /v1/ads/connections | The organisation's connected ad accounts. | ads.view |
| PATCH | /v1/ads/connections/{connection_id} | The account's autopilot settings — modes, ceilings, hold, ROAS, markets, competitors. | ads.manage |
| GET | /v1/ads/connections/{connection_id}/ad-quality | Ad quality — Limited Ad Serving, weak ads and their rewrites (za-150, za-162..165). | ads.view |
| GET | /v1/ads/connections/{connection_id}/ads | The account's campaigns, ad groups and ads, read from Google now (ADMGMT1). | ads.view |
| POST | /v1/ads/connections/{connection_id}/ads/actions | Pause, unpause or delete one ad, ad group or campaign (ADMGMT1). | ads.manage |
| GET | /v1/ads/connections/{connection_id}/audits | The connection's recent audit runs (newest first, at most 20). | ads.view |
| POST | /v1/ads/connections/{connection_id}/audits | Run the connection's audit now (a Temporal workflow). | ads.manage |
| GET | /v1/ads/connections/{connection_id}/budget-flags | Campaigns held back by their budget while they convert (za-142). | ads.view |
| POST | /v1/ads/connections/{connection_id}/budget-flags/{flag_id}/raise | The one-click raise of a budget-limited campaign (za-142). | ads.manage |
| GET | /v1/ads/connections/{connection_id}/checkout-sources | The checkout providers sending this ad account their sales by webhook. | ads.view |
| POST | /v1/ads/connections/{connection_id}/checkout-sources | Add a checkout provider (Stripe, Paddle or Freemius) with its webhook signing secret. | ads.manage |
| DELETE | /v1/ads/connections/{connection_id}/checkout-sources/{source_id} | Remove a checkout source and forget its signing secret. | ads.manage |
| PATCH | /v1/ads/connections/{connection_id}/checkout-sources/{source_id} | Replace the signing secret, rename, or switch a checkout source on or off. | ads.manage |
| POST | /v1/ads/connections/{connection_id}/disconnect | Disconnect an ad account; its token and all its data are deleted. | ads.manage |
| GET | /v1/ads/connections/{connection_id}/insights | Spend pacing, tracking still firing, missed clicks and the signal ladder. | ads.view |
| GET | /v1/ads/connections/{connection_id}/outcomes | The real outcomes received for this account (newest first, at most 200). | ads.view |
| POST | /v1/ads/connections/{connection_id}/outcomes | The events API — send real outcomes (sales, trials, leads, sign-ups). | ads.manage |
| POST | /v1/ads/connections/{connection_id}/paused-ads/delete | Delete all paused ads of one account (ADMGMT1). | ads.manage |
| GET | /v1/ads/connections/{connection_id}/tracking | The account's tracking truth check, confidence gate, fix assistant and recovery. | ads.view |
| PUT | /v1/ads/connections/{connection_id}/tracking | Which actions are compared, where missed outcomes upload, recovery on/off. | ads.manage |
| GET | /v1/ads/connections/{connection_id}/tracking/actions | The account's offline-upload conversion actions, read live from the network. | ads.view |
| POST | /v1/ads/connections/{connection_id}/tracking/check | Run the tracking check and the recovery upload now (a Temporal workflow). | ads.manage |
| GET | /v1/ads/controls | The organisation's kill switch and daily e-mail setting. | ads.view |
| PUT | /v1/ads/controls | Turn the organisation's kill switch or daily e-mail on or off. | ads.manage |
| POST | /v1/ads/email-actions | Act on an e-mailed Approve or Undo link (signed in). | ads.manage |
| GET | /v1/ads/plan | The organisation's Zinn® Ads plan, what it uses and what it allows. | ads.view |
| GET | /v1/ads/shield | The organisation's click-fraud shield and its totals for a period. | ads.view |
| PUT | /v1/ads/shield | Switch the shield off or on, and set the figures its estimate uses. | ads.manage |
| GET | /v1/ads/shield/claims | Refund evidence packs, one per Google Ads account per month. | ads.view |
| GET | /v1/ads/shield/claims/{claim_id} | One refund evidence pack with every suspected click. | ads.view |
| POST | /v1/ads/shield/claims/{claim_id}/sent | Record that a person sent the pack through Google's form. | ads.manage |
| GET | /v1/ads/shield/clicks | Scored paid clicks on the organisation's hosted sites, newest first. | ads.view |
| GET | /v1/ads/shield/exclusions | The IP and placement exclusions the shield asked Google for. | ads.view |
| POST | /v1/webhooks/ads-checkout/{source_id} | A checkout provider's signed delivery (Stripe, Paddle, Freemius). | API キーがありません |