Method: projects.databases.documents.get

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

HTTPリクエスト

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

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
name

string

必須。取得するドキュメントのリソース名。形式は、 projects/{projectId}/databases/{databaseId}/documents/{document_path}

クエリパラメータ

パラメーター
mask

object ( DocumentMask )

返されるフィールド。設定されていない場合は、すべてのフィールドを返します。

このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドは応答で返されません。

ユニオンパラメータのconsistency_selector 。このトランザクションの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector次のいずれか 1 つだけです。
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

詳細については、 「認証の概要」を参照してください。