XML API の HTTP ヘッダーとクエリ文字列パラメータ

Cloud Storage XML API では、いくつかの標準 HTTP ヘッダーと拡張(カスタム)HTTP ヘッダーを使用します。いくつかの HTTP メソッドでは、クエリ文字列パラメータもサポートされます。ヘッダーとパラメータについては後述します。

HTTP ヘッダーやクエリ文字列パラメータの概要

XML API では、次の標準 HTTP ヘッダーを使用します。

リクエスト イベントに 両方
承認
コンテンツ MD5
ホスト
If-Match
If-Modified-Since
一致しない場合
If-Unmodified-Since
ETag
Last-Modified
場所
キャッシュ制御
コンテンツ消去
コンテンツ エンコード
コンテンツの言語
コンテンツの長さ
コンテンツの範囲
コンテンツ タイプ
Date(日付)
範囲
転送エンコード

XML API では、次の拡張(カスタム)HTTP ヘッダーを使用します。

リクエスト イベントに 両方
x-goog-acl
x-goog-api-version
x-goog-bucket-retention-period
x-goog-content-length-range
x-goog-content-sha256
x-goog-copy-source
x-goog-copy-source-generation
x-goog-copy-source-if-generation-match
x-goog-copy-source-if-match
x-goog-copy-source-if-metageneration-match
x-goog-copy-source-if-modified-since
x-goog-copy-source-if-none-match
x-goog-copy-source-if-unmodified-since
x-goog-date
x-goog-encryption-key
x-goog-encryption-kms-key-name
x-goog-if-generation-match
x-goog-if-metageneration-match
x-goog-metadata-directive
x-goog-project-id
x-goog-resumable
x-goog-user-project
x-goog-component-count
x-goog-expiration
x-goog-generation
x-goog-metageneration
x-goog-stored-content-encoding
x-goog-stored-content-length
x-goog-custom-time
x-goog-encryption-algorithm
x-goog-encryption-key-sha256
x-goog-hash
x-goog-meta-
x-goog-storage-class

XML API では、次のクエリ文字列パラメータを使用します。

アクセスキー ID
ACL
アクション
課金
作成
cors
defaultObjectAcl
区切り文字
エンコード タイプ
暗号化
encryptionConfig
生成
世代マーカー
ライフサイクル 立地
ロギング
マーカー
マーカー
max-keys
MaxItems
接頭辞
レスポンス コンテンツの処理
レスポンス コンテンツ タイプ
ステータス
storageClass
タグ付け
アップロード ID
ユーザー名
ユーザー プロジェクト
バージョニング
バージョン
websiteConfig
X-Goog-Algorithm
X-Goog-Credential
X-Goog-Date
X-Goog-Expires
X-Goog-SignedHeaders
X-Goog-Signature

標準 HTTP ヘッダー

Authorization

リクエスト認証に使用する認証文字列を格納するリクエスト ヘッダー。

有効な値 認証識別子(Bearer | GOOG1 | AWS)の後に次のいずれかを指定します。
  • 有効な OAuth 2.0 トークン
  • アクセス キー
  • 署名
Authorization: Bearer ya29.AHES6ZRVmB7fkLtd1XTmq6mo0S1wqZZi3-Lh_s- ...
詳細 このヘッダーの使用方法について詳しくは、認証をご覧ください。

注: プロキシを介してリクエストを送信している場合は、認証情報を含む Authorization ヘッダーがネットワーク管理者かどうか確認する必要があります。プロキシから除外されません。Authorization ヘッダーがない場合、MissingSecurityHeader エラーが発生し、リクエストは拒否されます。 プロキシ サーバー経由で Cloud Storage にアクセスする方法については、 トラブルシューティングをご覧ください。

Cache-Control

キャッシュ コントロール設定を指定するためのリクエスト / レスポンス ヘッダー。

有効な値 有効な control-control の値(仕様についてのページをご覧ください)。
Cache-Control: public, max-age=6000
詳細 すべての匿名ユーザーがアクセス可能なオブジェクトに対してのみ、キャッシュ制御を指定します。匿名でアクセスできるようにするには、オブジェクトの ACL で次の権限を付与する必要があります。READまたはFULL_CONTROL権限AllUsersを使用して Google Cloud Storage とやり取りできます。すべての匿名ユーザーがアクセスできるオブジェクトにキャッシュ コントロールを指定しない場合は、3, 600 秒のキャッシュ制御設定が適用されます。XML で処理する場合、Cloud Storage は、メタデータによって設定されたオブジェクトのキャッシュ制御に従います。

Content-Disposition

転送されるデータに関する表現情報を指定するリクエスト / レスポンス ヘッダー。

有効な値 有効なコンテンツ配置値(仕様についてのページをご覧ください)。
Content-Disposition: attachment; filename=FILENAME
詳細 オブジェクトのアップロード時に Content-Disposition ヘッダーを設定すると、ダウンロード時にそのヘッダーが提供され、ウェブブラウザや他の HTTP クライアントによって解釈されます。Content-Disposition は、一般的に attachment;filename=FILENAMEt に設定されており、ウェブブラウザに [名前を付けて保存] ダイアログ ボックスが表示されます。

Content-Encoding

オブジェクトの圧縮アルゴリズムを指定するリクエストとレスポンスのヘッダー。

有効な値 有効な圧縮アルゴリズム(仕様についてのページをご覧ください)。
Content-Encoding: gzip
詳細 Cloud Storage は、オブジェクトの圧縮や解凍を行いません。このヘッダーを使用して圧縮タイプ アルゴリズム(deflate など)を指定すると、ヘッダーは保持されますが、オブジェクトの圧縮や解凍は行われません。

Content-Language

コンテンツの ISO 639-1 言語コード。

有効な値 言語コードの一覧については、各国言語のコード表の ISO 639-1 の列をご覧ください。
Content-Language: en

Content-Length

リクエストまたはレスポンスの本文の長さ(バイト単位)。

有効な値 ゼロ以上の値。
Content-Length: 1234
詳細 チャンク形式転送エンコードを使用するリクエストを除き、すべてのリクエストで必須です(仕様をご覧ください)。 チャンク形式転送エンコードを使用せず、リクエストに Content-Length ヘッダーを含めない場合、リクエストは失敗し、Cloud Storage は 411(長さが必要)ステータス コードを返します。

Content-MD5

リクエスト本文の MD5 ダイジェスト。

有効な値 有効な MD5 ダイジェスト。
Content-MD5: iB94gawbwUSiZy5FuruIOQ==
詳細 仕様をご覧ください。 Cloud Storage は、PUT オペレーションの整合性の確認に使用できます。

Content-Range

バイト範囲を指定するリクエスト / レスポンス ヘッダー。

有効な値 有効なバイト範囲。
Content-Range: bytes 456-987/1234
詳細

レスポンスに表示される場合、Content-Range ヘッダーは Range ヘッダーを含むリクエストによって返されるバイトの範囲を示します。

再開可能なアップロード リクエストの一部として Content-Range を使用すると、アップロードの現在の位置をクエリするか、現在のリクエストでアップロードされたデータのブロック。

バイト範囲には上限が含まれます。つまり、bytes 0-999 はファイルまたはオブジェクトの最初の 1, 000 バイトを表します。

詳細については、特にダウンロード レスポンスについては、仕様をご覧ください。

Content-Type

リクエストの本文の MIME タイプ。

有効な値 有効な MIME タイプ(仕様についてのページをご覧ください)。
Content-Type: text/html
詳細 オブジェクトのアップロード時にコンテンツ タイプを指定しない場合、Cloud Storage システムはオブジェクトを提供するときにデフォルトで application/octet-stream にします。

日付

リクエスト / レスポンスの日時。

有効な値 従来の HTTP フォーマットで表された日時(仕様についてのページをご覧ください)。
Date: Wed, 16 Jun 2010 11:11:11 GMT
詳細 動画広告の作成時に 署名付き URL V2 署名プロセスを使用する場合、形式は従来の HTTP 形式である必要があります。詳しくは、第 7.1.1.2 項の仕様を使用して Google Cloud Storage とやり取りできます。V4 署名プロセスを使用する場合、形式は ISO 8601 基本形式 YYYYMMDD'T'HHMMSS'Z' である必要があります。

ETag

アクセスされているオブジェクトのエンティティ タグを含むレスポンス ヘッダー。

有効な値 引用符で囲われた文字列。詳細については、ハッシュと ETag: ベスト プラクティスをご覧ください。
ETag: "39a59594290b0f9a30662a56d695b71d"
ETag: "-CKicn4fknbUCEAE="
詳細 仕様をご覧ください。

ホスト

Cloud Storage の URI を指定するリクエスト ヘッダー。

有効な値 有効なフォーマットの URI。
Host: storage.googleapis.com
詳細 有効な URI について詳しくは、リクエスト エンドポイントホストの仕様をご覧ください。

If-Match

エンティティ タグ(ETag)を指定するリクエスト ヘッダー。

有効な値 有効なエンティティ タグ。
If-Match: "881f7881ac1bc144a2672e45babb8839"
詳細 単一のエンティティ タグのみを指定できます(カンマ区切りのエンティティ タグは使用できません)。このヘッダーは HEAD Object メソッドと GET Object メソッドで使用できます。このヘッダーに指定した ETag がオブジェクトの ETag と一致した場合は、メタデータまたはオブジェクトが返されます。このヘッダーに指定した ETag がオブジェクトの ETag と異なる場合に、メタデータまたはオブジェクトは返されず、Cloud Storage は412 前提条件の失敗エラーコードが表示されます。詳細については、仕様をご覧ください。

If-Modified-Since

日時を指定するリクエスト ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
If-Modified-Since: Fri, 19 Feb 2010 22:04:23 GMT
詳細 このヘッダーは、HEAD Object メソッドと GET Object メソッドで使用できます。このヘッダーに指定した日時より後にオブジェクトが変更されていた場合は、メタデータまたはオブジェクトが返されます。このヘッダーに指定した日時より後にオブジェクトが変更されていなかった場合は、メタデータまたはオブジェクトは返されず、Cloud Storage は304 Not Modified(未更新)ステータス コードを返します。

If-Modified-Since ヘッダーについて詳しくは、仕様についてのページをご覧ください。 HTTP 日付フォーマットについて詳しくは、仕様についてのページのセクション 7.1.1.2 をご覧ください。

If-None-Match

エンティティ タグ(ETag)を指定するリクエスト ヘッダー。

有効な値 有効なエンティティ タグ。
If-None-Match: "881f7881ac1bc144a2672e45babb8839"
詳細 このヘッダーは、HEAD Object メソッドと GET Object メソッドで使用できます。このヘッダーに指定した ETag がオブジェクトの ETag と異なる場合に、メタデータまたはオブジェクトが返されます。このヘッダーに指定した ETag がオブジェクトの ETag と一致した場合は、メタデータまたはオブジェクトは返されず、Cloud Storage から304 Not Modified(未更新)ステータス コード。詳細については、仕様をご覧ください。

If-Unmodified-Since

日時を指定するリクエスト ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
If-Unmodified-Since: Fri, 19 Feb 2010 22:04:23 GMT
詳細 このヘッダーは、HEAD Object メソッドと GET Object メソッドで使用できます。このヘッダーに指定した日付より後にオブジェクトが変更されていない場合は、メタデータまたはオブジェクトが返されます。このヘッダーに指定した日付より後にオブジェクトが変更されていた場合は、メタデータまたはオブジェクトが返されず、Cloud Storage から 412 Precondition Failed エラーコードを表示します。

If-Unmodified-Since ヘッダーについて詳しくは、仕様についてのページをご覧ください。 HTTP 日付フォーマットについて詳しくは、仕様についてのページのセクション 7.1.1.2 をご覧ください。

Last-Modified

オブジェクトが最後に変更された日時を含むレスポンス ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
Last-Modified: Fri, 19 Feb 2010 22:04:23 GMT
詳細 Last-Modified ヘッダーの詳細については、仕様をご覧ください。 HTTP 日付フォーマットについて詳しくは、仕様についてのページのセクション 7.1.1.2 をご覧ください。

場所

いくつかの目的のレスポンス ヘッダー:

  • 再開可能なアップロードの開始に応じて、再開可能なアップロード操作のためのセッション URI が提供されます。
  • Cookie ベースの認証リクエストに応じて、リクエストへの一意のウェブ生成レスポンス URL が返されます。
  • www.googleapis.com/download 以外の URL で行われる JSON API ダウンロード リクエストに応じて、ダウンロードを実行できる JSON API URL にリダイレクトします。
有効な値 有効な URI。
Location: https://example.storage.googleapis.com/?upload_id=tvA0...rot
詳細 再開可能なアップロードを開始すると、Location レスポンス ヘッダーが返されます。

範囲

返すバイトの範囲を示すリクエスト ヘッダーと、Cloud Storage システムにアップロードされたバイトの範囲を示すレスポンス ヘッダー。

有効な値 バイトの隣接範囲。
Range: bytes=0-1999(最初の 2,000 バイト)
Range: bytes=-2000(最後の 2,000 バイト)
Range: bytes=2000-(2,000 バイト目からファイルの終わりまで)
詳細

オブジェクト データのリクエストにヘッダーとして含まれている場合、オブジェクトの指定されたバイト範囲のみが返されます。これは、中断されたアップロードを再開する際に役立ちます。有効なリクエストが成功すると、206 Partial Content レスポンス コードが返されます。特定の状況では、range リクエスト ヘッダーは無視されます。

再開可能なアップロードに関連付けられたレスポンスの一部として返される場合、Range には現在アップロードされているバイト数が示されます。これらの情報を使用して、アップロードを続行できます。

バイト範囲も含まれます。たとえば、bytes=0-999 はファイルまたはオブジェクトの最初の 1, 000 バイトを表します。このヘッダーの詳細については、仕様についてのページをご覧ください。

Transfer-Encoding

メッセージ本文に転送エンコードが適用されているかどうかを指定するリクエスト / レスポンス ヘッダー。

有効な値 chunked
Transfer-Encoding: chunked
詳細 このヘッダーでは、リクエストまたはレスポンスのメッセージ本文がチャンク形式になっているかどうかを指定します。 変更した場合、サーバーは、一連のチャンクでコンテンツを処理します。最終チャンクの長さは 0 です。Transfer-Encoding: Chunked を指定する場合、Content-Length を指定する必要はありません。これは、ストリーミング アップロードのように、メッセージ本文の長さが事前にわからない場合に便利です。Transfer-Encodings について詳しくは、仕様についてのページをご覧ください。 チャンク転送エンコーディングについて詳しくは、仕様についてのページをご覧ください。

拡張(カスタム) HTTP ヘッダー

x-goog-acl

バケットまたはオブジェクトをアップロードまたは作成する際に、あらかじめ定義された ACL を適用するリクエスト ヘッダー。

有効な値 バケットの場合: project-privateprivatepublic-readpublic-read-writeauthenticated-read

オブジェクトの場合: project-privateprivatebucket-owner-readbucket-owner-full-controlpublic-readauthenticated-read

x-goog-acl: private
詳細 ユーザーが、ACL を指定せずにオブジェクトをアップロードしたりバケットを作成したりすると、private ACL が適用されます。あらかじめ定義された ACL について詳しくは、アクセス制御をご覧ください。

x-goog-api-version

このヘッダーはサポートが終了しており、使用されていません。

x-goog-bucket-retention-period

新しいバケットに保持ポリシーを追加するリクエスト ヘッダー。

有効な値 1 ~ 3,155,760,000 の整数。
x-goog-bucket-retention-period: 32000
詳細 このリクエスト ヘッダーは、新しいバケットを作成する場合にのみ使用できます。ヘッダーが含まれていると、新しいバケットは、ロックされた保持ポリシーを取得します。有効期間は秒単位で指定します。

x-goog-component-count

複合オブジェクトを構成するコンポーネントの数を指定するレスポンス ヘッダー。

有効な値 1 以上の整数。
x-goog-component-count: 32
詳細 アクセスされたオブジェクトが複合オブジェクトの場合は、このレスポンス ヘッダーのみ返されます。このヘッダーは、オブジェクトを構成するコンポーネントの数を返します。

x-goog-content-length-range

PUT リクエスト ヘッダー。リクエストのコンテンツ サイズがヘッダーの指定範囲内にある場合にのみ、Cloud Storage はリクエストを受け入れます。

有効な値 MIN,MAX ペア
x-goog-content-length-range: 0,256
詳細 コンテンツ サイズの値は整数(バイト単位)で表示されます。リクエストのサイズが指定した範囲内にある場合、そのリクエストはリクエストどおりに配信されます。リクエストのコンテンツ サイズが指定範囲外の場合、リクエストは失敗し、レスポンスで 400 Bad Request コードが返されます。x-goog-content-length-rangePUT 以外のリクエストで使用されている場合、ヘッダーは通知なく無視されます。

x-goog-content-sha256

リクエスト本文のハッシュを含むリクエスト ヘッダー。

有効な値 小文字の 16 進数、SHA-256 ハッシュ、UNSIGNED-PAYLOAD
x-goog-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
詳細 このヘッダーは、Authorization ヘッダー内の署名を使用するリクエストに必要です。 x-goog-content-sha256 は、正規リクエストのペイロード 部分に使用した値と一致する必要があります。

x-goog-copy-source

コピー操作のソースバケットとオブジェクトを指定するリクエスト ヘッダー。

有効な値 /BUCKET_NAME/OBJECT_NAME パス
x-goog-copy-source: travel-maps/paris.jpg
詳細 このリクエスト ヘッダーを使用すると、コピー元のオブジェクトへのパスを指定できます。有効なパスはバケットとオブジェクトの両方を含み、これらをスラッシュ(/)で区切ります。ソース オブジェクトのパスは、正式 URL にする必要があるため、一般的にはパーセント エンコードされます。

このヘッダーを使用するには、転送元オブジェクトに対する READ 権限と、転送先バケットに対する WRITE 以上の権限が必要です。

転送元と転送先のオブジェクトが(世代も含めて)同一の場合、コピーはメタデータのアップデートとして処理されます。更新/置換の動作を制御する方法については、x-goog-metadata-directive をご覧ください。

x-goog-copy-source-generation

コピーするオブジェクトの世代を指定するリクエスト ヘッダー。

有効な値 正の数値(64 ビット値)
x-goog-copy-source-generation: 1360044097839000
詳細 このリクエスト ヘッダーは、x-goog-copy-source と併用することで、コピー元のオブジェクトの世代を指定できます。x-goog-copy-source ヘッダーがないと無効です。このような世代オブジェクトが存在しない場合、Cloud Storage は 404 Not Found ステータス コードを返します。

転送元と転送先のオブジェクトが(世代も含めて)同一の場合、コピーはメタデータのアップデートとして処理されます。更新/置換の動作を制御する方法については、x-goog-metadata-directive をご覧ください。

x-goog-copy-source-if-generation-match

ソース オブジェクト x-goog-generation が指定された値と一致する場合にのみ、対応するコピー リクエストを指定するリクエスト ヘッダーが実行されます。このヘッダーは、x-goog-copy-source とともにのみ有効です。

有効な値 正の数値(64 ビット値)
x-goog-copy-source-if-generation-match: 1360044097835000
詳細 このリクエスト ヘッダーを使用すると、指定した世代が存在する場合にのみ、ソース オブジェクトを条件付きでコピーできます。世代が一致しない場合は、Cloud Storage より「412 Precondition Failed」(前提条件で失敗)エラーコードが返されます。

詳細については、オブジェクトのバージョンの使用をご覧ください。

x-goog-copy-source-if-match

コピー操作の条件を指定するリクエスト ヘッダー。

有効な値 エンティティ タグ(ETag)
x-goog-copy-source-if-match: 53fc311c15eda0a031809982ccf92aac
詳細 指定できるエンティティ タグは 1 つだけです(エンティティ タグをカンマで区切って指定することはできません)。このリクエスト ヘッダーは、x-goog-copy-source リクエスト ヘッダーを使用してコピー操作を実行する場合にのみ使用できます。このリクエスト ヘッダーで指定した ETag がソース オブジェクトの ETag に一致するとコピー操作が続行されます。ETag が一致しない場合は、Cloud Storage より「412 Precondition Failed」(前提条件で失敗)エラーコードが返されます。

x-goog-copy-source-if-metageneration-match

対応するリクエストを指定するリクエスト ヘッダーは、ソース オブジェクトの metageneration がこのヘッダーの値に一致する場合にのみ許可されます。

有効な値 正の数値(64 ビット値)
x-goog-copy-source-if-metageneration-match: 4
詳細 ソース オブジェクトのメタ世代が x-goog-copy-source-if-metageneration-match ヘッダーと一致する場合、リクエストは正常に処理され、Google Cloud Storage から HTTP 200 OK ステータスが返されます。メタデータの世代が一致しない場合は、「412 Precondition Failed」(前提条件で失敗)エラーコードが返されます。

この値は、x-goog-copy-source-if-generation-match または x-goog-copy-source-generation でのみ使用できます。を使わないと、HTTP 400 BadRequest Invalid Argument エラーコードが返されます。

詳細については、オブジェクトのバージョンの使用をご覧ください。

x-goog-copy-source-if-modified-since

コピー操作の条件を指定するリクエスト ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
x-goog-copy-source-if-modified-since: Fri, 19 Feb 2010 14:05:04 GMT
詳細 このリクエスト ヘッダーは、x-goog-copy-source リクエスト ヘッダーを使用してコピー操作を実行する場合にのみ使用できます。指定した日時がソース オブジェクトの Last-Modified 日よりも前である場合は、オブジェクトがコピーされます。指定した日時の方が後である場合は、Cloud Storage より「412 Precondition Failed」(前提条件で失敗)エラーコードが返されます。

If-Modified-Since HTTP ヘッダー(このユースケースに適用される以外のコピー ヘッダー)の詳細については、仕様をご覧ください。 HTTP 日付フォーマットについて詳しくは、仕様についてのページのセクション 7.1.1.2 をご覧ください。

x-goog-copy-source-if-none-match

コピー操作の条件を指定するリクエスト ヘッダー。

有効な値 エンティティ タグ(ETag)
x-goog-copy-source-if-none-match: 53fc311c15eda0a031809982ccf92aac
詳細 このリクエスト ヘッダーは、x-goog-copy-source リクエスト ヘッダーを使用してコピー操作を実行する場合にのみ使用できます。このリクエスト ヘッダーで指定した ETag がソース オブジェクトの ETag と一致しない場合にコピー操作を続行します。ETag が一致する場合、Cloud Storage は「412 Precondition Failed」エラーコードを返します。If-None-Match の HTTP ヘッダー(この場合は、コピーソース以外のヘッダー)について詳しくは、仕様についてのページをご覧ください。

x-goog-copy-source-if-unmodified-since

コピー操作の条件を指定するリクエスト ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
x-goog-copy-source-if-unmodified-since: Fri, 19 Feb 2010 14:05:04 GMT
詳細 このリクエスト ヘッダーは、x-goog-copy-source リクエスト ヘッダーを使用してコピー操作を実行する場合にのみ使用できます。指定した日時がソース オブジェクトの Last-Modified 日より後の場合、オブジェクトはコピーされます。指定した日時の方が前である場合は、Cloud Storage より「412 Precondition Failed」(前提条件で失敗)エラーコードが返されます。

If-Unmodified-Since の HTTP ヘッダー(この場合は、コピーソース以外のヘッダー)について詳しくは、仕様についてのページをご覧ください。 HTTP 日付フォーマットについて詳しくは、仕様についてのページのセクション 7.1.1.2 をご覧ください。

x-goog-custom-time

カスタム タイムスタンプ オブジェクト メタデータのリクエストとレスポンス ヘッダー。

有効な値 RFC 3339 形式の日時。
x-goog-custom-time: 2020-04-12T23:20:50.52Z
詳細 このヘッダーは、オブジェクトの PUT リクエストまたは POST リクエスト中に含めることができます。ヘッダーで指定した値はオブジェクトと一緒に格納され、オブジェクトに対して GET リクエストや HEAD リクエストを行うとレスポンス ヘッダーで返されます。オブジェクトのカスタム時間は、通常、オブジェクトのライフサイクル管理で使用されます。

x-goog-date

認証済みリクエストのタイムスタンプを指定するリクエスト ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
x-goog-date: Fri, 19 Feb 2010 14:05:04 GMT
詳細 動画広告の作成時に 署名付き URL V2 署名プロセスを使用する場合、形式は従来の HTTP 形式である必要があります。詳しくは、仕様のセクション 7.1.1.2を使用して Google Cloud Storage とやり取りできます。V4 署名プロセスを使用する場合、形式は ISO 8601 の基本形式 YYYYMMDD'T'HHMMSS'Z' である必要があります。

x-goog-encryption-algorithm

使用する暗号アルゴリズムを指定するためのリクエスト / レスポンス ヘッダー。

有効な値 AES256
x-goog-encryption-algorithm: AES256
詳細 このリクエスト ヘッダーやレスポンス ヘッダーは、ユーザー指定の暗号化鍵を使用する場合に使用されます。

x-goog-encryption-key

AES-256 暗号化鍵を指定するリクエスト ヘッダー。

有効な値 RFC 4648 の Base64 でエンコードされた、有効な AES-256 暗号鍵の文字列
x-goog-encryption-key: NwbyGGmcKAX4FxGpOERG2Ap33m5NVOgmXznSGTEvG0I=
詳細 このリクエスト ヘッダーは、顧客指定の暗号鍵を使用する場合に使用されます。

x-goog-encryption-key-sha256

暗号鍵の SHA256 ハッシュを指定するリクエスト / レスポンス ヘッダー。

有効な値 RFC 4648 の Base64 でエンコードされた、暗号鍵の有効な SHA256 ハッシュの文字列。
x-goog-encryption-key-sha256: +eBzkZBt1Mj2CZx69L3c8yXoZB6DtRLlSvXMJB9JGIQ=
詳細 このリクエスト ヘッダーは、顧客指定の暗号鍵を使用する場合に使用されます。

x-goog-encryption-kms-key-name

Cloud KMS 暗号鍵を指定するリクエスト ヘッダー。

有効な値 Cloud KMS 暗号鍵リソース
x-goog-encryption-kms-key-name: projects/my-project/locations/us-east1/keyRings/my-keyring/cryptoKeys/my-key
詳細 このリクエスト ヘッダーは、顧客管理の暗号鍵で特定のオブジェクトを暗号化する場合に使用します。

x-goog-expiration

ライフサイクル構成に従って、アクセスされたオブジェクトを削除するタイミングを指定するレスポンス ヘッダー。

有効な値 通常の HTTP フォーマットで表された日時。
x-goog-expiration: Tue, 25 June 2013 00:00:00 GMT
詳細 このレスポンス ヘッダーは、特定の条件が満たされたときに、ライフサイクル管理が有効であるバケット内のオブジェクトにのみ返されます。詳細については、オブジェクトのライフサイクル動作をご覧ください。

x-goog-generation

アクセスするオブジェクト データのバージョンを示すレスポンス ヘッダー。

有効な値 正の数値(64 ビット値)
x-goog-generation: 1360044097835000
詳細 オブジェクトが作成または置換されると、Cloud Storage によって自動的に世代が割り当てられます。オブジェクト データが置き換えられるたびに世代が変更されます。ただし、世代の世代間でオブジェクト間の関係が定義されることはありません。

詳細については、オブジェクトのバージョンの使用をご覧ください。

x-goog-if-generation-match

オブジェクトの x-goog-generation がこのヘッダーの値と一致する場合にのみ、対応するリクエストを指定するリクエスト ヘッダーを指定できます。

有効な値 ゼロまたは正の数値(64 ビット値)
x-goog-if-generation-match: 1360044097835000
詳細 オブジェクトの世代が x-goog-if-generation-match ヘッダーと一致すると、リクエストは正常に完了し、Google Cloud Storage から HTTP 200 OK ステータスが返されます。世代が一致しない場合、Google Cloud Storage は HTTP 412 Precondition Failed エラーコードを返します。

x-goog-if-generation-match ヘッダーを 0 に設定すると、そのオブジェクトが存在しない場合にのみ指定したリクエストが実行されます。たとえば、PUT リクエストを実行して、x-goog-if-generation-match で新しいオブジェクトを作成できます。このオブジェクトは、ライブ バージョンとして存在していない場合にのみ作成されます。オブジェクトが存在する場合、リクエストは中止されます。

詳細については、オブジェクトのバージョンの使用をご覧ください。

x-goog-if-metageneration-match

オブジェクトの x-goog-metageneration がこのヘッダーの値と一致する場合にのみ、対応するリクエストを指定するリクエスト ヘッダーを指定できます。

有効な値 正の数値(64 ビット値)
x-goog-if-metageneration-match: 4
詳細 オブジェクトのメタ世代が x-goog-if-metageneration-match ヘッダーと一致する場合、リクエストは正常に処理され、Google Cloud Storage から HTTP 200 OK ステータスが返されます。メタデータの世代が一致しない場合、Cloud Storage は HTTP 412 Precondition Failed エラーコードを返します。

このリクエスト ヘッダーは、x-goog-if-generation-match ヘッダーと併用して、メタデータの更新がオブジェクトの生成に対して実際に実行されるようにします。読み取り、変更、書き込みオペレーションを安全に実行できるように計画されています。

詳細については、オブジェクトのバージョンの使用をご覧ください。

x-goog-metadata-directive

コピー操作中のメタデータ処理を指定するリクエスト ヘッダー。

オブジェクト ACL が存在する場合はコピーされません。該当する場合、新しいオブジェクトは、x-goog-acl リクエスト ヘッダーで指定された ACL、または新しいオブジェクトを含むバケットに設定されているデフォルト オブジェクト ACL を受け取ります。

有効な値 COPY | REPLACE
x-goog-metadata-directive: REPLACE
詳細

x-goog-copy-source リクエスト ヘッダーでのみ使用されます。 デフォルト値は COPY です。

COPY を指定すると、新たに作成するオブジェクトに、ソース オブジェクトのメタデータが適用されます。

REPLACE を指定すると、新たに指定されたオブジェクトに、リクエストで指定されたメタデータが適用されます。

オブジェクトをコピーすると、ソース オブジェクトが書き換えられます。その際、x-goog-metadata-directive: REPLACE を含める必要があります。 他のすべてのケースでは、ヘッダーは省略可能です。

x-goog-metageneration

アクセスしているオブジェクト メタデータのバージョンを指定するレスポンス ヘッダー。

有効な値 正の数値(64 ビット値)
x-goog-metageneration: 1
詳細 オブジェクトが作成または置換されると、Cloud Storage は自動的に 1 のメタ世代を割り当てます。metageneration は、オブジェクトのメタデータ(ACL の更新やその他のメタデータの更新)が更新されるたびに増加します。つまり、メタ世代が大きいと、新しいバージョンのオブジェクト メタデータを意味します。ただし、世代の異なる世代間で、同一オブジェクトの世代が定義されることはありません。オブジェクトの各世代には、その世代に関連する独自のメタ世代 バージョンがあります。

詳細については、オブジェクトのバージョンの使用をご覧ください。

x-goog-hash

オブジェクトの MD5/CRC32C Base64 でエンコードされたチェックサムを表すためのリクエストとレスポンスのヘッダー。指定したハッシュは、アップロード リクエストのリクエスト ヘッダーとして、Cloud Storage で計算された値に照らして検証されます。

有効な値 md5=BASE64_ENCODED_MD5 または crc32c=BASE64_ENCODED_CRC32C を指定します。ビッグ エンディアンのバイト順で CRC32c 値を指定します。また、HTTP では、カンマ区切りヘッダー値は、同一キーを持つ個別のヘッダーと同等とみなされます。
x-goog-hash: crc32c=n03x6A==
x-goog-hash: md5=Ojk9c3dhfxgoKVVHYwFbHQ==
x-goog-hash: crc32c=n03x6A==,md5=Ojk9c3dhfxgoKVVHYwFbHQ==
詳細 Cloud Storage は、非複合オブジェクトすべての MD5 ハッシュを保存します。 CRC32C はすべてのオブジェクトで使用できます。

x-goog-meta-

オブジェクトのカスタム メタデータを定義するリクエスト ヘッダーとレスポンス ヘッダー。

有効な値 有効なヘッダー名。
x-goog-meta-reviewer: jane
詳細 このヘッダーを使用するには、カスタム ヘッダー名を x-goog-meta- 接頭辞に追加し、ヘッダーとそれに関連する値を PUT または POST リクエストに追加します。たとえば、オブジェクトが複数のプロジェクトに関連付けられている場合、次のような複数のリクエスト ヘッダーを作成することで、プロジェクト固有の情報をオブジェクト メタデータに追加できます。たとえば、x-goog-meta-project-namex-goog-meta-project-numberx-goog-meta-project-manager。PUT または POST のリクエスト中に、このようなリクエスト ヘッダーに値を設定することもできます。

PUT /kitten.jpg HTTP/1.1
Host: my-bucket.storage.googleapis.com
Date: Wed, 17 Jun 2020 11:11:11 GMT
Content-Type: image/jpg
Content-Length: 554
Authorization: Bearer 1/zVNpoQNsOSxZKqOZgckhpQ
x-goog-meta-project-name: Sales Projections
x-goog-meta-project-number: 878973
x-goog-meta-project-manager: W. Loman
    

x-goog-meta- ヘッダーはオブジェクトと一緒に格納され、オブジェクトに対し GET リクエストや HEAD リクエストを実行すると常にレスポンス ヘッダーで返されます。料金とサポートで説明されているように、カスタム メタデータとしてヘッダーを使用すると、料金が発生します。

注: すべてのカスタム ヘッダーとそれらに関連付けられている値に含めることができるのは US-ASCII 文字のみです。

注: カスタム ヘッダーの合計サイズを数 KB に制限することをおすすめします。

x-goog-project-id

作業中のプロジェクトを指定するリクエスト ヘッダー。

有効な値 有効なプロジェクト番号またはプロジェクト名。
x-goog-project-id: 000111222333
x-goog-project-id: my-project-name
x-goog-project-id: example.com:my-google-apps-for-work-project-name
詳細 このリクエスト ヘッダーは、バケットを作成するプロジェクトや、バケットを一覧表示するプロジェクトを Cloud Storage に指示します。これらのタスクでは、相互運用可能なアクセスのためにデフォルト プロジェクトを設定している場合、この手順は省略できます。

x-goog-resumable

再開可能なアップロード操作を開始するリクエスト ヘッダー。

有効な値 start
x-goog-resumable: start
詳細 このリクエスト ヘッダーを使用すると、再開可能なアップロードを開始することを Cloud Storage システムに通知します。このヘッダーは、POST Object リクエストを使用して再開可能なアップロードを開始する場合にのみ使用できます。

x-goog-storage-class

オブジェクトのストレージ クラスを表すリクエスト ヘッダーとレスポンス ヘッダー。

有効な値 STANDARDNEARLINECOLDLINEARCHIVEMULTI_REGIONALREGIONAL
x-goog-storage-class: NEARLINE
詳細 関連するバケットのデフォルト ストレージ クラス以外のストレージ クラスにオブジェクトを設定するには、このヘッダーを PUT ObjectPOST Object のリクエストに含めます。このヘッダーは、すべての GET Object レスポンスに含まれます。

x-goog-stored-content-encoding

Cloud Storage に保存されているオブジェクトのコンテンツ エンコードを示すレスポンス ヘッダー。オブジェクトの個々のリクエストで発生する可能性があるサーバー主導のネゴシエーションはありません。

有効な値 オブジェクトのアップロードまたは identity で指定されたコンテンツ コーディング。
x-goog-stored-content-encoding: gzip
詳細 オブジェクトがコンテンツ コーディングなしでアップロードされた場合、このヘッダーの値は identity になります。

x-goog-stored-content-length

Cloud Storage に保存されているオブジェクトのコンテンツの長さ(バイト単位)を示すレスポンス ヘッダー。オブジェクトの個々のリクエストで発生する可能性があるサーバー ネゴシエーションはありません。

有効な値 ゼロ以上のバイト値。
x-goog-stored-content-length: 350
詳細 なし

x-goog-user-project

リクエストに関連するアクセス料金の請求先プロジェクトを指定するリクエスト ヘッダー。

有効な値 既存の Google Cloud プロジェクトのプロジェクト ID
x-goog-user-project: my-project
詳細 ヘッダーで指定されたプロジェクトは、リクエストに関連する料金の請求が発生します。このヘッダーは、たとえば、リクエスト元による支払いが有効になっているバケットに対するリクエストを実行する場合に使用します。

クエリ文字列パラメータ

このセクションで説明したクエリ文字列パラメータの例では、URI は示されていませんが、storage.googleapis.com に関連しています。リクエスト エンドポイントで説明されているように、ホスト名の一部としてバケット名を指定することもできます(例: BUCKET-NAME.storage.googleapis.com)。ホスト名の一部としてバケットを指定する場合は、URI パスの一部としてバケット名を含めないでください。たとえば、以下はオブジェクトの ACL を取得するのと同じです。

  • https://storage.googleapis.com/BUCKET-NAME/object-name?acl
  • https://BUCKET-NAME.storage.googleapis.com/object-name?acl

アクセスキー ID

更新または削除する HMAC キーを識別するためのクエリ文字列パラメータ。

有効な値 HMAC キーに関連付けられたアクセス ID。
/?Action=UpdateAccessKey&AccessKeyId=GOOG1EXAMPLE&Status=Inactive
/?Action=DeleteAccessKey&AccessKeyId=GOOG1EXAMPLE
詳細 AccessKeyId クエリ文字列パラメータを使用すると、更新または削除する HMAC キーを指定できます。AccessKeyId は、Action クエリ パラメータと組み合わせて使用する必要があります。HMAC 鍵のアクセス ID を取得する方法については、HMAC キー情報の取得をご覧ください。

acl

バケットまたはオブジェクトのアクセス制御リストを取得または変更するためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?acl
/BUCKET_NAME/OBJECT_NAME?acl
詳細 PUT Bucket、PUT Object、GET Bucket、GET Object リクエストにオプションで指定できます。PUT リクエストを送信する場合は、適用する ACL を指定した XML ドキュメントをリクエストの本文に組み込む必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

対応

実行する HMAC キーオペレーションを識別するためのクエリ文字列パラメータ。

有効な値 ListAccessKeys, CreateAccessKey, UpdateAccessKey, DeleteAccessKey
/?Action=ListAccessKeys
詳細 Action クエリ文字列パラメータを使用すると、実行する HMAC キーオペレーションを指定できます。 listcreateupdatedelete

billing

バケットのリクエスト元による支払い機能の有効化、無効化、ステータス確認のクエリ文字列パラメータ。

有効な値 リクエストの本文: EnabledDisabled
/BUCKET_NAME?billing
詳細 GET BucketPUT Bucket リクエストに任意で指定できます。GET Bucket リクエストで使用すると、リクエスト元による支払い機能の現在のステータスがレスポンスの本文で返されます。PUT Bucket リクエストで使用する場合、リクエストの本文で、この機能を有効または無効にする <BillingConfiguration> 要素を含める必要があります。XML API を使用したリクエスト元による支払い機能の設定の詳細については、バケット リクエスト元による支払いの設定をご覧ください。

compose

既存のオブジェクトのシーケンスを新しい複合オブジェクトに構成できるクエリ文字列パラメータ(XML API でのみ使用します)。

有効な値 なし
/BUCKET_NAME/OBJECT_NAME?compose
詳細 PUT Object リクエストのオプション。リクエストの本文で ComposeRequest XML ドキュメントを指定する必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

cors

バケットのクロスオリジン リソース シェアリング(CORS)を取得または変更するためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?cors
詳細 PUT Bucket、GET Bucket リクエストに任意で指定できます。PUT リクエストを送信する場合は、適用する CORS を指定した XML ドキュメントをリクエストの本文に組み込む必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

defaultObjectAcl

バケットのデフォルト オブジェクト アクセス制御リストを取得または変更するクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?defaultObjectAcl
詳細 PUT Bucket リクエストと GET Bucket リクエストのオプション。PUT リクエストを送信する場合は、バケットに追加された新しいオブジェクトにデフォルトで適用される ACL を指定したリクエスト本文に XML ドキュメントを含める必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。詳細については、デフォルト オブジェクト ACL の設定をご覧ください。

delimiter

GET Bucket リクエスト中にオブジェクトの一覧を制限するために使用される文字または文字のグループ。

有効な値 Unicode 文字。
/?delimiter=/
詳細

delimiter は、ディレクトリに似た命名規則を使用するオブジェクトの一覧を簡略化します。指定すると、通常、レスポンスに名前が含まれていないオブジェクトはレスポンスの Contents 要素内に返されます。オブジェクト名に区切り文字が含まれている場合、オブジェクト名の最初の部分までの区切り文字がCommonPrefixesレスポンスの要素。

delimiterprefix パラメータと組み合わせて使用できます。この場合、名前に prefix が一致するオブジェクトにのみ prefix の結果が制限されます。

通常、delimiter/ に設定されますが、任意の文字列です。delimiter の使用例については、区切り文字の例をご覧ください。

エンコード タイプ

オブジェクトの一覧表示リクエストに対するレスポンスに URL エンコードするクエリ文字列パラメータ。

有効な値 url
/bucket?encoding-type=url
詳細 バケット内のオブジェクトを一覧表示する場合はオプション。リクエストに含まれる場合、返されるオブジェクト名は URL エンコードされます。これは、オブジェクト名のいずれかに XML 1.0 で解析できない Unicode 文字が含まれている場合に便利です。

encryption

オブジェクトの暗号化情報を取得するためのクエリ文字列パラメータ。

有効な値 なし
/object?encryption
詳細 GET Object リクエストのオプション。クエリ対象のオブジェクトが顧客指定の暗号鍵で暗号化されると、暗号化アルゴリズムと鍵の SHA-256 が Encryption 要素内で返されます。クエリ対象のオブジェクトが顧客管理の暗号鍵で暗号化されると、Cloud Key Management Service のキーリソースが Encryption 要素内で返されます。それ以外の場合は、空の Encryption 要素が返されます。

このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

encryptionConfig

バケットで使用するデフォルトの顧客管理の暗号鍵を設定または取得するためのクエリ文字列パラメータ。

有効な値 なし
/bucket?encryptionConfig
詳細 GET Bucket リクエストのオプション。クエリ対象のバケットにデフォルトの顧客管理の暗号鍵が設定されている場合、鍵リソースの名前が EncryptionConfiguration 要素内で返されます。

PUT Bucket リクエストのオプション。リクエスト本文に顧客管理の暗号鍵のリソース リクエストが含まれている場合、その鍵はバケットのデフォルトの暗号鍵になります。リクエストに空の EncryptionConfiguration 要素が含まれている場合、既存のデフォルト鍵はバケットから削除されます。

の生成

フェッチするオブジェクトの世代を示す値。

有効な値 正の数値(64 ビット値)
?generation=1360887759327000
詳細 generation クエリ文字列パラメータを使用すると、操作するオブジェクトのバージョンを指定できます。

generation-marker

オブジェクトのリストを開始する世代番号を示す値。

有効な値 正の数値(64 ビット値)
?generation-marker=1360887759327000
詳細 generation-marker クエリ文字列パラメータは、バージョニングされたバケット上のページング リストの開始点となります。marker と併用する必要があります。これは、オブジェクトと、そこから一覧表示を開始する位置を完全に指定する場合に使用します。指定した generation-marker より新しいオブジェクト(世代が長い場合ライブ バージョンも含む)は、 marker

lifecycle

バケットのライフサイクル管理ポリシーを取得または変更するためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?lifecycle
詳細 PUT Bucket、GET Bucket リクエストに任意で指定できます。PUT リクエストを送信する場合は、リクエストの本文にライフサイクル構成を指定する XML ドキュメントを含める必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

場所

バケットの location 制約を取得するためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?location
詳細 GET Bucket リクエストに任意で指定できます。

ロギング

バケットのロギング構成の取得または変更を行うためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?logging
詳細 PUT Bucket、GET Bucket リクエストに任意で指定できます。PUT リクエストを送信する場合は、ロギング構成を指定するリクエストの本文に XML ドキュメントを含める必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

マーカー

オブジェクトの一覧表示をどこから開始するかを示す文字列。

有効な値 文字列
?marker=test
詳細 marker クエリ文字列パラメータは、どのオブジェクトから一覧表示を開始するかを指定する Unicode 文字列です。返されるオブジェクトの一覧は、marker より辞書順に返されます。

マーカー

HMAC キーの次のページのページを一覧表示するためのページトークン。

有効な値 IsTruncatedtrue の場合、前の list レスポンスで指定される文字列。
?Action=ListAccessKeys&Marker=AERPALERN/NEXT/TOKEN
詳細 Marker クエリ文字列パラメータは継続トークンです。特定のプロジェクトの HMAC キーを一覧表示する際に、大きな結果セットのページ割り付けに使用されます。条件IsTruncatedですtrue以前listレスポンスが提供された場合は、Marker後続のトークンlist回のリクエストIsTruncatedfalseを使用して Google Cloud Storage とやり取りできます。MarkerAction クエリ パラメータと組み合わせて使用する必要があります。詳しくは、HMAC キーを取得するをご覧ください。

max-keys

単一の結果「ページ」で返されるオブジェクトの数を制限する整数。

有効な値 0 より大きい数値。
?max-keys=100
詳細 max-keys クエリ文字列パラメータは、オブジェクトの一覧として返すオブジェクトの最大数を指定する整数です。max-keys が許容できる数を超えるオブジェクトをリクエストできる場合は、IsTruncated レスポンス要素に True 値が含まれます。

MaxItems

1 つの結果ページで返される HMAC キーの数を制限する整数。

有効な値 0 より大きい数値。
?Action=ListAccessKeys&MaxItems=100
詳細 MaxItems クエリ文字列パラメータは、1 つの結果ページで返される HMAC キーの最大数を指定する整数です。リクエストが MaxItems が許容できる数を超えるキーを返した場合、IsTruncated レスポンス要素に true 値が含まれます。MaxItems は、Action クエリ パラメータと組み合わせて使用する必要があります。サービスは指定された最大数よりも少ない結果を返すことがあります。

prefix

オブジェクトのリストを特定の接頭辞を持つオブジェクトに制限する文字列。

有効な値 有効なプレフィックス。
?prefix=/europe/france
詳細 prefix クエリ文字列パラメータは、指定された prefix 値で始まる名前を持つオブジェクトのみを一覧表示するための Unicode 文字の文字列です。prefix クエリ文字列パラメータを delimiter クエリ文字列パラメータと組み合わせて使うことで、より絞り込んだオブジェクト サブセットを作成できます。

response-content-disposition

認証済みの GET リクエストで content-disposition をオーバーライドするためのクエリ文字列パラメータ。

有効な値 基になるオブジェクトの content-disposition の代わりに返す URL エンコードのヘッダー。
?response-content-disposition=attachment%3B%20filename%3D%22foo%22
詳細 認証済みの GET リクエストで、ヘッダーで返されたコンテンツ処理をオーバーライドできます。

詳細については、仕様をご覧ください。

response-content-type

認証済みの GET リクエストで content-type をオーバーライドできるようにするクエリ文字列パラメータ。

有効な値 基になるオブジェクトの content-type の代わりに返す URL エンコードのヘッダー。
?response-content-type=text%2Fhtml
詳細 認証済みの GET リクエストで、ヘッダーで返されたコンテンツ処理をオーバーライドできます。

詳細については、仕様をご覧ください。

ステータス

HMAC キーを有効または無効にできるクエリ文字列パラメータ。

有効な値 ActiveInactive
?Action=UpdateAccessKey&AccessKeyId=GOOG1EXAMPLE&Status=Inactive
詳細 Status クエリ文字列パラメータを使用すると、Active から Inactive までの HMAC キーのステータスを変更できます。Status は、Action および AccessKeyId クエリ パラメータと組み合わせて使用する必要があります。

storageClass

バケットのストレージ クラスを設定または取得するためのクエリ文字列パラメータ。

有効な値 リクエストの本文: STANDARDNEARLINEARCHIVECOLDLINEMULTI_REGIONALREGIONALDURABLE_REDUCED_AVAILABILITY
/BUCKET_NAME?storageClass
詳細 GET BucketPUT Bucket リクエストに任意で指定できます。GET Bucket リクエストで使用すると、指定したバケットのストレージ クラスがレスポンスの本文で返されます。PUT Bucket リクエストで使用すると、バケットに割り当てるストレージ クラスを指定する <StorageClass> 要素がリクエストの本文に含まれます。XML API を使用してバケットのストレージ クラスを設定する方法については、バケットのストレージ クラスを設定するをご覧ください。

タグ付け

バケットに適用されるラベルを設定または取得できるクエリ文字列パラメータ。

有効な値 リクエストの本文: key:value ペアとして指定するラベル。
/BUCKET_NAME?tagging
詳細 GET BucketPUT Bucket リクエストに任意で指定できます。GET Bucket リクエストで使用すると、指定したバケットに適用されたラベルがレスポンスの本文で返されます。PUT Bucket リクエストで使用すると、バケットに適用するラベルを指定する <Tagging> 要素がリクエストの本文に含まれます。XML API を使用してラベルを適用する方法について詳しくは、バケットラベルの設定をご覧ください。

upload_id

再開可能なアップロード操作のアップロード ID を指定するクエリ文字列パラメータ。upload_id はセッション URI の一部ですが、再開可能なアップロード オペレーションのリクエスト URI は一意に定義するため、セッション URI 全体を保存する必要があります。セッション URI は、Location レスポンス ヘッダーから取得されます。

有効な値 有効なアップロード ID。
/?upload_id=tvA0ExBntDaOKdxL46u1NkHxNb...B2Uowrot HTTP/1.1
詳細 アップロード ID は 1 週間後に失効します。アップロード ID を取得したらすぐに再開可能なアップロードを開始すること、また、中断が発生したらすぐにそのアップロードを再開することをおすすめします。

期限切れのアップロード ID をリクエストで使用すると、404 Not Found ステータス コードが返されます。この場合は、再開可能なアップロードを再開し、新しいアップロード ID を取得して、新しいアップロード ID を使用してアップロードを最初からやり直す必要があります。

アップロード ID は作成された場所にバインドされているため、ある場所で作成してその別の場所で使用すると、パフォーマンスが低下します。

アップロード ID は署名なしトークンであり、認証者として機能します。そのため、アップロード ID が漏 not しないように注意してください。

ユーザー名

HMAC キーを作成、更新、一覧表示するサービス アカウントを識別するためのクエリ文字列パラメータ。

有効な値 有効なサービス アカウントのメールアドレス。
/?Action=CreateAccessKey&UserName=serviceAccount@proj.iam.gserviceaccount.com
詳細 HMAC キーを作成するには UserName が必要です。また、必要に応じて、プロジェクトに関連付けられたキーやキーを一覧表示することもできます。Action クエリ パラメータと一緒に UserName を使用する必要があります。

ユーザー プロジェクト

リクエストに関連するアクセス料金の請求先プロジェクト ID を指定するクエリ文字列パラメータ。

有効な値 有効なプロジェクト ID。
?userProject=example-project
詳細 このパラメータで指定されたプロジェクトでは、リクエストに関連する料金が課金されます。userProject は、たとえばリクエスト元による支払いが有効になっているバケットに対するリクエストを実行する場合に使用します。

通常、プロジェクト ID を必要とする XML リクエストでは、userProject パラメータではなく x-goog-user-project ヘッダーでリクエストを指定する必要があります。

バージョニング

バケットのバージョニング構成の取得または変更を行うためのクエリ文字列パラメータ。

有効な値 なし
/OBJECT_NAME?versioning
詳細 PUT Bucket、GET Bucket リクエストに任意で指定できます。PUT リクエストを送信する場合は、適用するバージョニング設定を指定した XML ドキュメントをリクエストの本文に組み込む必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

バージョン

バージョニングされたバケット内にあるすべての世代のオブジェクトを取得するためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?versions=True
詳細 GET Bucket リクエストに任意で指定できます。

websiteConfig

バケットのウェブサイト構成を取得または変更するためのクエリ文字列パラメータ。

有効な値 なし
/BUCKET_NAME?websiteConfig
詳細 PUT Bucket、GET Bucket リクエストに任意で指定できます。PUT リクエストを送信する場合は、適用するウェブサイト設定を指定した XML ドキュメントをリクエストの本文に組み込む必要があります。このクエリ パラメータを使用してさらにサブリソースを使用することはできません。

X-Goog-Algorithm

V4 署名付き URL アルゴリズムを決定するクエリ文字列パラメータ。

有効な値 GOOG4-RSA-SHA256
GOOG4-HMAC-SHA256
AWS4-HMAC-SHA256
詳細 署名付き URL など、V4 署名付きリクエスト専用に使用されます。

X-Goog-Credential

使用する認証情報タイプを決定するクエリ文字列パラメータ。

有効な値 Service_Account_Email/Date/Region/goog4_request
Google_HMAC_Access_Key_ID/Date/Region/goog4_request
AWS_HMAC_Access_Key_ID/Date/Region/aws4_request
Google サービス アカウントの使用: example%40example-project.iam.gserviceaccount.com%2F20181026%2Fus-central-1%2Fstorage%2Fgoog4_request
HMAC の使用: GOOGTS7C7FUP3AIRVJTE2BCD%2F20181026%2Fus-central-1%2Fstorage%2Fgoog4_request
詳細 署名付き URL など、V4 署名付きリクエスト専用に使用されます。

X-Goog-Date(クエリ パラメータ)

署名付き URL が使用可能になる日付と時刻。

有効な値 YYYYMMDD'T'HHMMSS'Z' の後にする日付
?X-Goog-Date=20181026T181309Z
詳細 使用する形式は、ISO 8601 の基本形式 YYYYMMDD'T'HHMMSS'Z' です。

X-Goog-Expires

V4 署名付き URL の有効期間を管理するクエリ文字列パラメータ。

有効な値 1 秒 604800 秒
?X-Goog-Expires=900
詳細 署名付き URL の有効期間。X-Goog-Date の値(秒単位)で測定されます。最大値は 7 日または 604800 秒です。

X-Goog-SignedHeaders

V4 署名付き URL で署名されたヘッダーを特定するクエリ文字列パラメータ。

有効な値 必須のヘッダーは host のみです。V4 署名付き URL 署名で署名されたヘッダーは、このリストに含まれている必要があります。
?X-Goog-SignedHeaders=host
?X-Goog-SignedHeaders=host,x-goog-acl
詳細 署名付き URL を使用するリクエストの一部として含める必要があるヘッダー。

X-Goog-Signature

V4 署名付き URL 署名の値を含むクエリ文字列パラメータ。

有効な値 署名付き URL の署名。
?X-Goog-Signature=247a2aa45f169edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa8496def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dcc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c20580e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b133447032ea7abedc098d2eb14a7
詳細 この署名付き URL を使用して指定されたリソースへのアクセスを許可した認証文字列。