Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

Method: projects.databases.documents.runQuery

クエリを実行します。

HTTPリクエスト

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery

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

パスパラメータ

パラメーター
parent

string

必須。親リソース名。形式: projects/{project_id}/databases/{databaseId}/documentsまたはprojects/{project_id}/databases/{databaseId}/documents/{document_path} 。例: projects/my-project/databases/my-database/documentsまたはprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom

リクエスト本文

リクエスト本文には、次の構造のデータが含まれています。

JSON表現
{
  "structuredQuery": {
    object (StructuredQuery)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
田畑
structuredQuery

object ( StructuredQuery )

構造化クエリ。

ユニオンフィールドconsistency_selector 。このトランザクションの整合性モード。設定されていない場合、デフォルトで強い整合性が設定されます。 consistency_selectorは、次のいずれかになります。
transaction

string ( bytes format)

トランザクション内のドキュメントを読み取ります。

base64でエンコードされた文字列。

newTransaction

object ( TransactionOptions )

新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトは読み取り専用トランザクションです。新しいトランザクションIDは、ストリームの最初の応答として返されます。

readTime

string ( Timestamp format)

指定された時間のドキュメントを読み取ります。これは270秒より古くはなりません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、最大9桁の小数部。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

レスポンスボディ

成功した場合、応答本文には次の構造のデータが含まれます。

Firestore.RunQueryの応答。

JSON表現
{
  "transaction": string,
  "document": {
    object (Document)
  },
  "readTime": string,
  "skippedResults": integer
}
田畑
transaction

string ( bytes format)

このリクエストの一部として開始されたトランザクション。最初の応答でのみ設定でき、 RunQueryRequest.new_transactionが要求で設定されている場合にRunQueryRequest.new_transactionます。設定されている場合、この応答には他のフィールドは設定されません。

base64でエンコードされた文字列。

document

object ( Document )

クエリ結果。部分的な進捗状況を報告する場合は設定されません。

readTime

string ( Timestamp format)

ドキュメントが読み取られた時刻。これは単調に増加している可能性があります。この場合、結果ストリーム内の以前のドキュメントは、 readTimeと今回のドキュメントの間で変更されていないことが保証されています。

クエリが結果を返さない場合、 readTimedocumentなしの応答が送信されます。これは、クエリが実行された時刻を表します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、最大9桁の小数部。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

skippedResults

integer

最後の応答と現在の応答の間のオフセットのためにスキップされた結果の数。

承認範囲

次のOAuthスコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

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