単一のドキュメントを取得します。
HTTPリクエスト
GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}
URLはgRPCトランスコーディング構文を使用します。
パスパラメータ
| パラメーター | |
|---|---|
name | 必須。取得するドキュメントのリソース名。形式： |
クエリパラメータ
| パラメーター | ||
|---|---|---|
mask | 返すフィールド。設定されていない場合は、すべてのフィールドを返します。 ドキュメントにこのマスクに存在しないフィールドがある場合、そのフィールドは応答で返されません。 | |
ユニオンパラメーターconsistency_selector 。このトランザクションの整合性モード。設定されていない場合、デフォルトで強い整合性が設定されます。 consistency_selectorは、次のいずれかになります。 | ||
transaction | トランザクションでドキュメントを読み取ります。 base64でエンコードされた文字列。 | |
readTime | 指定された時間にドキュメントのバージョンを読み取ります。これは270秒より古くはなりません。 RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、最大9桁の小数部。例： | |
リクエスト本文
リクエストの本文は空である必要があります。
レスポンスボディ
成功した場合、応答本文にはDocumentインスタンスが含まれます。
承認範囲
次のOAuthスコープのいずれかが必要です。
-
https://www.googleapis.com/auth/datastore -
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要を参照してください。