Search Ads 360 Reporting API の呼び出しは、通常、クライアント ライブラリを通じて行われます。詳細については、クライアント ライブラリの説明をご覧ください。ただし、基盤となるリクエストの詳細の構造に関する情報は、テストとデバッグを行う際に役立ちます。
Search Ads 360 Reporting API は、REST バインディングを備えた gRPC API です。つまり、次の 2 つの方法で API を呼び出すことができます。
- おすすめの方法
- クライアント ライブラリを使用します。
- リクエストの本文をプロトコル バッファとして作成します。
- HTTP/2 を使用してサーバーにリクエストを送信します。
- レスポンスをプロトコル バッファに逆シリアル化します。
- 結果を確認します。
- オプションの代替方法
- REST を使用します。
- リクエストの本文を JSON オブジェクトとして作成します。
- HTTP 1.1 を使用してサーバーにリクエストを送信します。
- レスポンスを JSON オブジェクトとして逆シリアル化します。
- 結果を確認します。
詳細については、Google Cloud APIs をご覧ください。
以下のセクションは、gRPC プロトコルと REST プロトコルの両方に適用されます。
リソース名
API のほとんどのオブジェクトは、リソース名の文字列で識別されます。REST インターフェースを使用する場合は、これらの文字列も URL として機能します。
サポートされているリソースとそのパス表現の詳細については、[リファレンス] > [REST] をご覧ください。他のサービスでも同じ形式が使用されます。
複合 ID
オブジェクトの ID がグローバルに一意でない場合、そのオブジェクトの複合 ID は、親 ID とチルダ（~）を付加して作成されます。
たとえば、広告グループの広告 ID はグローバルに一意ではないため、親オブジェクト（広告グループ）ID が先頭に追加され、一意の複合 ID が生成されます。
例: AdGroupId/123 + ~ + AdGroupAdId / 45678 = 123~45678 の複合広告グループの広告 ID。
リクエスト ヘッダー
次のセクションの HTTP ヘッダー（または gRPC メタデータ）は、リクエストの本文に含める必要があります。
承認
次の形式で OAuth2 アクセス トークンを含める必要があります。
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
トークンは、クライアントの代理であるクライアント センター（MCC）アカウント、または自身のサブマネージャー アカウントまたはクライアント アカウントを直接管理している広告主を識別するものである必要があります。詳しくは、検索広告 360 のクライアント センター（MCC）アカウントについてと認証をご覧ください。
ログインお客様 ID ヘッダー
MCC アカウントを使用してサブマネージャー アカウントまたはクライアント アカウントにアクセスする際は、login-customer-id ヘッダーが必要です。サブマネージャー アカウントまたはクライアント アカウントに直接アクセスする場合は必要ありません。厳密には必須ではありませんが、複数のアカウントにアクセスできる認証済みユーザーについては、常に login-customer-id を指定することをおすすめします。これにより、あいまいさが回避され、コンテキストが意図せずに誤ったアカウントに設定されることもなくなります。
リクエストには、承認済みユーザーのお客様 ID を含める必要があります。ハイフン（-）は省略します。次に例を示します。
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
login-customer-id を設定すると、検索広告 360 にログインした後、または右上のプロフィール画像をクリックして、検索広告 360 の管理画面でアカウントを選択するのと同じ結果になります。
レスポンス ヘッダー
次のヘッダー（または gRPC 後置メタデータ）がレスポンスの本文とともに返されます。デバッグ用に、これらの値をログに記録することをおすすめします。
リクエスト ID
request-id ヘッダーは、リクエストを一意に識別する文字列です。