標準的なクエリパラメータ

みるくあいらんどっ! > 和訳 > google関係 > Drive API > api > v3


  • この記事は、Google Drive™ APIに関する記事を和訳したものです。
  • 原文: Standard Query Parameters
  • 元記事のライセンスは CC-BYで、この和訳記事のライセンスは CC-BYです。
  • 自己責任でご利用ください。
  • 和訳した時期は 2019年6月ころです。

すべての Drive API操作に適用されるクエリパラメータは、下の表に示されています。

備考 (APIキーおよび認証トークンについて):

  1. リクエストとともに OAuth 2.0トークンを提供しない限り、keyパラメータは、すべてのリクエストで必要とされます。
  2. OAuthスコープを必要するリクエストごとに、認証トークンを送信しなければなりません。 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 レスポンス内に含むための fieldsのサブセットを指定するセレクタ。
  • 詳細については、パフォーマンスのヒントドキュメントの 部分的なレスポンスセクションを参照してください。
  • より良いパフォーマンスのために使用します。
key APIキー。 (REQUIRED*)
  • * OAuth 2.0 トークンを提供しない限り、必須です。
  • あなたの API keyは、あなたのプロジェクトを識別し、APIアクセス、クォータ、および、レポートを提供します。
  • Google API Consoleから、あなたのプロジェクトの APIキーを取得します。
prettyPrint

インデントおよび改行を用いて、レスポンスを返します。

  • trueである場合、人間が読み取り可能な形式にてレスポンスを返します。
  • デフォルト値: true。
  • これが falseであるとき、レスポンスのペイロードサイズを減少させることができます、それは、幾つかの環境ではより良いパフォーマンスを導くかもしれません。
quotaUser userIpに代わるもの。
  • ユーザの IPアドレスが不明の場合でさえ、サーバ側アプリケーションからユーザごとのクォータを強制させることができます。 これは、例えば、ユーザに代わって App Engine上の cronジョブを実行するアプリケーションで発生する可能性があります。
  • ユーザをユニークに識別する任意の文字列を選択することができますが、それは 40文字に制限されています。
  • 両方が提供されている場合、userIpを上書きします。
  • Capping API usageについて、詳しく学んでください。
userIp API呼び出しが行われているエンドユーザの IPアドレス。
  • サーバ側アプリケーションから APIを呼び出すとき、ユーザごとのクォータを強制させます。
  • Capping API usageについて、詳しく学んでください。