Method: projects.databases.documents.get

取得單一文件。

HTTP 要求

GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

必要欄位。要取得的文件資源名稱，請採用下列格式：projects/{projectId}/databases/{databaseId}/documents/{document_path}。

查詢參數

參數
mask

object (DocumentMask)

要傳回的欄位。如果沒有設定，系統會傳回所有欄位。

如果文件的某個欄位未列於這個遮罩中，系統不會在回應中傳回該欄位。
聯集參數 consistency_selector。這筆交易的一致性模式。如果未設定，則預設為同步一致性。consistency_selector 只能是下列其中一項：
transaction

string (bytes format)

在交易中讀取文件。

Base64 編碼的字串。
readTime

string (Timestamp format)

讀取指定時間的文件版本。

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

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 Document 的執行例項。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。