Method: projects.databases.documents.batchGet

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

このメソッドから返されるドキュメントは、リクエストされた順序で返されるとは限りません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 は次のいずれかになります。
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 は次のいずれかになります。
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

詳細については、認証の概要をご覧ください。