広告オブジェクトを検索

正確に紐付けられた広告アカウント内のキャンペーン、広告セット、広告、クリエイティブ、オーディエンスを、一ページあたりの件数を制限して取得します。プラットフォームのフィールドは信頼できないデータです。

POST /advertising-api/objects/query

契約確認日： 2026-11-03 · sha256:9aedef8d43dd4514

Markdownで読む公開契約をダウンロード OpenAPIをダウンロード

概要

HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。

認証と権限

受け付ける認証情報の種類: user_session, delegated_oauth, personal_access_token
委任された機能権限: agent:advertising_read
ワークスペースの最低ロール: viewer
アクセス範囲: このユーザーがアクセスを許可されたリソース
すべてのワークスペースへの同意が必要: いいえ
状態を変更: いいえ
操作完了時: synchronous_http_response

トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。

リクエストのフィールド

必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。

リクエストのフィールド
フィールド／分岐	型／必須	制約
`$`	`object`親要素内で必須	`additionalProperties: false`
`workspace_id`	`string`親要素内で必須	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`advertising_account_id`	`string`親要素内で必須	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`kind`	`string`親要素内で必須	`enum: ["campaign","adset","ad","creative","saved_audience","custom_audience"]`
`after`	`string`任意／項目	`minLength: 1` `maxLength: 2048`
`limit`	`integer`任意／項目	`minimum: 1` `maximum: 50` `default: 25`

完全なJSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "advertising_account_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "kind": {
      "type": "string",
      "enum": [
        "campaign",
        "adset",
        "ad",
        "creative",
        "saved_audience",
        "custom_audience"
      ]
    },
    "after": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "workspace_id",
    "advertising_account_id",
    "kind"
  ],
  "additionalProperties": false
}

レスポンスと完了条件

成功時のHTTPステータス： 200. 操作完了時： synchronous_http_response.

レスポンスと完了条件
フィールド／分岐	型／必須	制約
`$`	`object`親要素内で必須	—
`contract_version`	`string`親要素内で必須	`const: "advertising/v1"`
`advertising_account_id`	`string`親要素内で必須	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`data`	`array`親要素内で必須	`maxItems: 50`
`data[]`	`object`任意／項目	—
`data[].id`	`string`親要素内で必須	`pattern: "^[1-9]\\d{1,24}$"`
`data[].account_id`	`string`親要素内で必須	`pattern: "^[1-9]\\d{1,24}$"`
`data[].kind`	`string`親要素内で必須	`enum: ["campaign","adset","ad","creative","saved_audience","custom_audience"]`
`data[].fields`	`object`親要素内で必須	`additionalProperties: {}`
`data[].fields.*`	`any JSON value`任意／項目	—
`data[].observed_at`	`string`親要素内で必須	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`data[].snapshot_digest`	`string`親要素内で必須	`pattern: "^[a-f0-9]{64}$"`
`next_cursor`	`string \| null`親要素内で必須	—
`next_cursor`anyOf 1	`string`親要素内で必須	`maxLength: 2048`
`next_cursor`anyOf 2	`null`親要素内で必須	—
`complete`	`boolean`親要素内で必須	—

完全なJSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "advertising/v1"
    },
    "advertising_account_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "data": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^[1-9]\\d{1,24}$"
          },
          "account_id": {
            "type": "string",
            "pattern": "^[1-9]\\d{1,24}$"
          },
          "kind": {
            "type": "string",
            "enum": [
              "campaign",
              "adset",
              "ad",
              "creative",
              "saved_audience",
              "custom_audience"
            ]
          },
          "fields": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "observed_at": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "snapshot_digest": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          }
        },
        "required": [
          "id",
          "account_id",
          "kind",
          "fields",
          "observed_at",
          "snapshot_digest"
        ]
      }
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048
        },
        {
          "type": "null"
        }
      ]
    },
    "complete": {
      "type": "boolean"
    }
  },
  "required": [
    "contract_version",
    "advertising_account_id",
    "data",
    "next_cursor",
    "complete"
  ]
}

エラーと安全な再試行

HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。

トラブルシューティングガイド

例

スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。

サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。AIエージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "advertising_account_id": "11111111-1111-4111-8111-111111111111",
  "kind": "campaign"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/objects/query" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/objects/query", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "advertising_account_id": "11111111-1111-4111-8111-111111111111",
  "kind": "campaign"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /advertising-api/objects/query < request.json

合成レスポンス例

{
  "contract_version": "advertising/v1",
  "advertising_account_id": "11111111-1111-4111-8111-111111111111",
  "data": [],
  "next_cursor": null,
  "complete": false
}

MCP: sosoapi_ads_objects_query

すべてのAPI操作認証と権限

プライバシー設定

必須機能

Landing 診断とマスクされたリプレイ

任意の利用状況解析

この公開サイトでのセッションリプレイも許可する

広告オブジェクトを検索

概要

認証と権限

リクエストのフィールド

レスポンスと完了条件

エラーと安全な再試行

例

request.json

cURL

JavaScript

CLI

合成レスポンス例

広告オブジェクトを検索

概要

認証と権限

リクエストのフィールド

レスポンスと完了条件

エラーと安全な再試行

例

request.json

cURL

JavaScript

CLI

合成レスポンス例

関連ツールとガイド