Method: projects.databases.documents.get

単一のドキュメントを取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
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 日間以内の 1 分単位のタイムスタンプにすることもできます。 RFC3339 UTC「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

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