Google の API プラットフォームでは、このプラットフォームを使用してビルドされたすべての Google API 対して一連の一般的な機能が提供されます。このような機能を使用して制御するために、プラットフォームでは、「システム パラメータ」と呼ばれる特別なパラメータ セットが事前に定義されています。これらのパラメータは、すべての Google REST API と gRPC API で使用できます。システム パラメータは、HTTP クエリ パラメータや HTTP ヘッダーを使用して指定できます。Google gRPC API では、HTTP ヘッダーのみがサポートされます。
ほとんどのユーザーはこれらのパラメータを使用する必要はありません。ただし、これらのパラメータは Google によって提供されるクライアント ライブラリによってよく使用されます。カスタムコードを作成して Google API に直接アクセスする必要がある場合、JSON 書式付き出力の制御や API キーの指定などで、システム パラメータが役立つことがあります。
HTTP マッピング
以下のように、HTTP プロトコルでは、システム パラメータは HTTP URL クエリ パラメータと HTTP ヘッダーにマッピングされます。たとえば、システム パラメータ $foo がある場合、URL の ?$foo=xxx にマッピングされます（接続時に ?%24foo=xxx として URL エンコードされます）。
注: 通常のリクエスト パラメータとの競合を回避するために、"$" 接頭辞が追加されます。
gRPC マッピング
gRPC では、システム パラメータは通常の HTTP リクエスト ヘッダーを介して送信されます。詳細については、次の表をご覧ください。
定義
次の表は、すべてのシステム パラメータとその定義を示しています。
| URL クエリ パラメータ | HTTP/gRPC ヘッダー | 説明 |
|---|---|---|
access_token、oauth_token |
Authorization | OAuth 2.0 アクセス トークン。詳細については、Cloud Platform の認証ガイドをご覧ください。 |
$alt、alt |
レスポンスの代替形式。サポートされている値は、json（デフォルト）、media、proto（バイナリ protobuf）です。 |
|
$.xgafv |
JSON エラーの形式。サポートされている値は 1、2（デフォルト）です。エラー形式 1 は、レガシー クライアントでのみ使用する必要があります。 |
|
$callback、callback |
JSONP コールバック パラメータ。 | |
$ct |
Content-Type | HTTP Content-Type ヘッダーのオーバーライド。 |
$fields、fields |
X-Goog-FieldMask | レスポンス フィルタリングには、FieldMask（google.protobuf.FieldMask）が使用されます。空の場合、すべてのフィールドが返されます。 |
$httpMethod |
X-HTTP-Method-Override | リクエストに使用される HTTP メソッド。ネットワーク プロキシによっては、すべての HTTP メソッドが受け入れられるわけではありません。 |
$key、key |
X-Goog-Api-Key | Google API キー。詳細については、https://developers.google.com/console/help/#generatingdevkeys をご覧ください。 |
passwd、password |
ユーザーが URL でパスワードを入力しないように予約されています。 | |
$prettyPrint、prettyPrint |
JSON レスポンスを書式付きで出力します。サポートされている値は true、false です。 |
|
$outputDefaults |
JSON レスポンスに対して proto のデフォルト値を強制的に出力します。 | |
$unique |
リクエスト キャッシングを無効にするための一意のクエリ パラメータ。 | |
| X-Goog-Api-Client | API クライアントの識別子。値は NAME "/" SEMVER 文字列のスペース区切りリストであり、NAME には小文字、数字、「-」のみが含まれ、SEMVER はセマンティック バージョン文字列である必要があります。たとえば、X-Goog-Api-Client: python/3.5.0 grpc-google-pubsub-v1/0.1.0-beta2 linux/2.7.0 です。 |
|
$userProject |
X-Goog-User-Project | 割り当てと課金を目的とした呼び出し元指定のプロジェクト。呼び出し元には、プロジェクトに対する serviceusage.services.use 権限が必要です。 |
