標準クエリ パラメータ

以下は、Resource Manager API のすべてのオペレーションに適用されるクエリ パラメータの表です。

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

  1. リクエストで OAuth 2.0 トークンを指定しない場合には、key パラメータはすべてのリクエストで必要になります。
  2. OAuth スコープを必要とするすべてのリクエストで認証トークンを送信する必要がありますOAuth 2.0 はサポートされている唯一の認証プロトコルです。
  3. リクエストで OAuth 2.0 トークンを提供するには、次のいずれかの方法を使用します。
    • 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 アクセス、割り当て、レポートが提供されます。
  • プロジェクトの API キーは Google Cloud Platform Console から入手します。
prettyPrint

インデントと改行の付いたレスポンスを返す。

  • true の場合は、人が読める形式でレスポンスを返します。
  • デフォルト値: true
  • false の場合、レスポンスのペイロード サイズが減るため、環境によってはパフォーマンスが向上する場合があります。
quotaUser userIp の代替。
  • ユーザーの IP アドレスが不明な場合でも、サーバー側アプリケーションからユーザーごとの割り当てを適用できます。この状況は、ユーザーに代わって App Engine で cron ジョブを実行するアプリケーションで発生する場合があります。
  • ユーザーを一意に識別する任意の文字列を 40 文字以内で選択できます。
  • 両方指定した場合、userIp は無視されます。
  • 詳しくは、API 使用の上限設定をご覧ください。
userIp API 呼び出しが行われているエンドユーザーの IP アドレス。
  • サーバー側アプリケーションから API を呼び出す際に、ユーザーごとの割り当てを適用できます。
  • 詳しくは、API 使用の上限設定をご覧ください。

このページは役立ちましたか?評価をお願いいたします。

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

Resource Manager のドキュメント