Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

Method: projects.databases.documents.batchGet

複数のドキュメントを取得します。

このメソッドによって返されるドキュメントは、要求されたのと同じ順序で返されることが保証されていません。

HTTPリクエスト

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

URLはgRPCトランスコーディング構文を使用します。

パスパラメータ

パラメーター
database

string

必須。データベース名。形式: projects/{project_id}/databases/{databaseId}

リクエスト本文

リクエスト本文には、次の構造のデータが含まれています。

JSON表現
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
田畑
documents[]

string

取得するドキュメントの名前。形式: projects/{project_id}/databases/{databaseId}/documents/{document_path} 。ドキュメントのいずれかが指定されたdatabase子リソースでない場合、リクエストは失敗しdatabase 。重複する名前は削除されます。

mask

object ( DocumentMask )

返すフィールド。設定されていない場合は、すべてのフィールドを返します。

ドキュメントにこのマスクに存在しないフィールドがある場合、そのフィールドは応答で返されません。

ユニオンフィールドconsistency_selector 。このトランザクションの整合性モード。設定されていない場合、デフォルトで強い整合性が設定されます。 consistency_selectorは、次のいずれかになります。
transaction

string ( bytes format)

トランザクション内のドキュメントを読み取ります。

base64でエンコードされた文字列。

newTransaction

object ( TransactionOptions )

新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトは読み取り専用トランザクションです。新しいトランザクションIDは、ストリームの最初の応答として返されます。

readTime

string ( Timestamp format)

指定された時間のドキュメントを読み取ります。これは270秒より古くはなりません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、最大9桁の小数部。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

レスポンスボディ

成功した場合、応答本文には次の構造のデータが含まれます。

Firestore.BatchGetDocumentsのストリーミング応答。

JSON表現
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
田畑
transaction

string ( bytes format)

このリクエストの一部として開始されたトランザクション。最初の応答でのみ設定され、 BatchGetDocumentsRequest.new_transactionが要求で設定された場合にのみ設定されます。

base64でエンコードされた文字列。

readTime

string ( Timestamp format)

ドキュメントが読み取られた時刻。これは単調に増加している可能性があります。この場合、結果ストリーム内の以前のドキュメントは、readTimeとこのドキュメントの間で変更されていないことが保証されています。

RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、最大9桁の小数部。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

ユニオンフィールドのresult 。単一の結果。サーバーがトランザクションを返すだけの場合、これは空になる可能性があります。 resultは次のいずれかになります。
found

object ( Document )

要求されたドキュメント。

missing

string

要求されたが存在しないドキュメント名。形式: projects/{project_id}/databases/{databaseId}/documents/{document_path}

承認範囲

次のOAuthスコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要を参照してください。