Method: projects.databases.documents.get

取得單一文檔。

HTTP請求

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

URL 使用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)

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

這必須是過去一小時內的微秒精度時間戳,或者如果啟用了時間點恢復,則還可以是過去 7 天內的整分鐘時間戳。

RFC3339 UTC「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

有關詳細信息,請參閱身份驗證概述