API 呼び出しの仕組み

このガイドでは、すべての API 呼び出しに共通する構造について説明します。

API とのやり取りにクライアント ライブラリを使用している場合は基となるリクエストの詳細について特に考慮する必要はありませんが、テストやデバッグを行う際にはそのようなリクエストの知識が役立ちます。

Google Ads API は、REST バインディングを利用した gRPC API で、呼び出す方法は次の 2 つがあります。

  1. [推奨] リクエストの本文を プロトコル バッファを使って処理し、 HTTP/2: レスポンスのシリアル化を解除してプロトコルに 結果を解釈する必要がありますほとんどのドキュメントでは、 gRPC。

  2. （省略可）リクエストの本文を HTTP 1.1 を使用してサーバーに送信し、JSON JSON オブジェクトとしてレスポンスをシリアル化解除し、結果を解釈します。詳しくは、 REST インターフェースのガイドをご覧ください。 REST。

で確認できます。

リソース名

API のほとんどのオブジェクトは、リソース名の文字列で識別されます。これらの REST インターフェースを使用する場合、文字列も URL として機能します。REST を確認する インターフェースのリソース名を 構成します。

複合 ID

オブジェクトの ID がグローバルに一意でない場合、そのオブジェクトの複合 ID 先頭に親 ID とチルダ（~）を付加して構成されます。

たとえば、広告グループ広告 ID はグローバル レベルで一意ではないため、親オブジェクト（広告グループ）ID を先頭に追加して、一意の複合 ID を作成します。

  • 123 の AdGroupId + ~ + 45678 の AdGroupAdId = 複合広告 123~45678 のグループ広告 ID。

リクエスト ヘッダー

これらは HTTP ヘッダー（grpc メタデータ） リクエストの本文を使用します。

承認

次の形式で OAuth2 アクセス トークンを含める必要があります。 Authorization: Bearer YOUR_ACCESS_TOKEN は、 クライアントまたは広告主の代理を務める MCC アカウント 管理する必要はありません。アクセス トークンの取得手順 OAuth2 ガイドをご覧ください。アクセス トークンの有効期限は取得後 1 時間です。失効した場合は、アクセス トークンを更新して新たに取得してください。クライアント ライブラリを使用している場合、失効したトークンは自動的に更新されます。

developer-token

開発者トークンは、Google Ads API 開発者を一意に識別する 22 文字の文字列です。開発者トークン文字列の例: ABcdeFGH93KL-NOPQ_STUv。開発者トークンは developer-token : ABcdeFGH93KL-NOPQ_STUv の形式。

login-customer-id

これはリクエストで使用する承認されたお客様のお客様 ID です。 ハイフンなし（-）。お客様のアカウントに MCC アカウントの場合、このヘッダーは必須で、次のお客様 ID に設定する必要があります。 クリックします

https://googleads.googleapis.com/v17/customers/1234567890/campaignBudgets:mutate

login-customer-id の設定は、 ログインするか上部のプロフィール画像をクリックした後に表示される Google 広告の管理画面 ありますこのヘッダーを含めない場合、デフォルトは お客様に提供します。

linked-customer-id

このヘッダーは、第三者アプリ分析プロバイダが リンクされた Google 広告にコンバージョンをアップロードする 。

アカウント A のユーザーが読み取り / 編集権限を付与するシナリオを考えてみましょう。 エンティティに関連付けて、アカウント B に ThirdPartyAppAnalyticsLink。 リンクすると、アカウント B のユーザーがアカウント A に対して API 呼び出しを行うことができます。 リンクで提供されている権限が適用されます。この場合、API 呼び出し側の API 呼び出しは アカウント A の権限は、アカウント B へのサードパーティのリンクによって決まります。 クライアント センター（MCC）アカウントの関係ではなく、他の API 呼び出しで使用されます。

第三者アプリ分析プロバイダは、次のように API 呼び出しを行います。

  • linked-customer-id: アップロードする第三者アプリ分析アカウント データ（アカウント B）。
  • customer-id: データのアップロード先の Google 広告アカウント（アカウント A）。
  • login-customer-id ヘッダーと Authorization ヘッダー: アカウント B にアクセスできるユーザーを識別します。

レスポンス ヘッダー

以下のヘッダー（grpc trailing-metadata）がレスポンスの本文とともに返されます。デバッグ目的でこれらの値をログに記録することをおすすめします。

request-id

request-id は、このリクエストを一意に識別する文字列です。

前へ
リソース メタデータ