Method: projects.databases.documents.batchGet

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

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

HTTPリクエスト

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

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

パスパラメータ

パラメーター
database

string

必須。データベース名。形式は、 projects/{projectId}/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/{projectId}/databases/{databaseId}/documents/{document_path}です。いずれかのドキュメントが指定されたdatabaseの子リソースではない場合、リクエストは失敗します。重複する名前は省略されます。

mask

object ( DocumentMask )

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

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

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

string ( bytes format)

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

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

newTransaction

object ( TransactionOptions )

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

readTime

string ( Timestamp format)

指定された時点でのドキュメントを読み取ります。

これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。

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次のいずれか 1 つだけになります。
found

object ( Document )

要求された書類。

missing

string

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

認可範囲

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

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

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