Method: projects.databases.documents.batchGet

取得多份文件。

此方法傳回的文件不一定會按照要求的順序傳回。

HTTP 要求

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

這個網址使用 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 只能是下列其中一項：
transaction

string (bytes format)

這個外掛程式能在交易中讀取文件。

Base64 編碼的字串。
newTransaction

object (TransactionOptions)

開始新交易並讀取文件。預設為唯讀交易。新的交易 ID 將傳回，做為串流中的第一個回應。
readTime

string (Timestamp format)

這個外掛程式能在指定時間讀取文件。

這個值必須是過去 1 小時內的微秒精確度，如果已啟用「時間點復原」功能，則可以是過去 7 天內的整分鐘時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："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 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："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

詳情請參閱驗證總覽。