標準クエリ パラメータ

すべての AdSense Management API オペレーションに共通のクエリ パラメータを以下の表に示します。

注(API キーと認証トークンについて):

  1. リクエストに OAuth 2.0 トークンを含めた場合を除いてkey はすべてのリクエストで必須のパラメータです。
  2. (AUTHENTICATED) とマークされたリクエストはすべて承認トークンと共に送信しなければなりません。推奨される認証プロトコルは OAuth 2.0 です。
  3. リクエストと共に OAuth 2.0 トークンを送信するには、次の 2 つの方法があります。
    • access_token クエリ パラメータの使用: ?access_token=oauth2-token
    • HTTP Authorization ヘッダーの使用: Authorization: Bearer oauth2-token

すべてのパラメータは指示がない限りオプション パラメータです。

パラメータ 意味 注意点
access_token 現在のユーザーの OAuth 2.0 トークン
callback コールバック関数
  • レスポンスを処理する JavaScript コールバック関数の名前です。
  • JavaScript JSON-P リクエストで使用します。
fields レスポンスに追加するフィールドのサブセットを指定するセレクタ
  • 詳しくは、パフォーマンス向上のヒントのドキュメントの部分的レスポンスのセクションをご覧ください。
  • パフォーマンス向上のために使用します。
key API キー(必須*)
  • *OAuth 2.0 トークンを送信しない場合は必須です。
  • API キーはプロジェクトを特定し、API アクセス、割り当て量、およびレポートを提供します。
  • Google Developers Console からプロジェクトの API キーを取得します。
prettyPrint

レスポンスにインデントと改行を含めて返す

  • true の場合、人間が読み取れる判読できるフォーマットでレスポンスを返します。
  • デフォルト値は false です。
  • false の場合、レスポンスのペイロード サイズを減らすことができ、環境によってはパフォーマンスが向上する可能性があります。
quotaUser userIp の代わりに使用する
  • ユーザーの IP アドレスが不明でも、ユーザーごとの容量をサーバーサイド アプリケーションから適用できます。これはたとえば、アプリケーションがユーザーに代わって App Engine で cron ジョブを実行する場合に使用します。
  • ユーザーを識別する任意の文字列を選択できます。ただし、文字数は 40 文字に制限されています。
  • userIp も指定されている場合は userIp より優先されます。
  • 詳しくは、キャップの使用方法をご覧ください。
userIp API 呼び出しを行ったエンドユーザーの IP アドレス
  • サーバーサイド アプリケーションから API を呼び出すときにユーザーごとの容量を適用できます。
  • 詳しくは、キャップの使用方法をご覧ください。

フィードバックを送信...