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」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："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

詳情請參閱驗證總覽一文。