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

Method: projects.databases.documents.list

ドキュメントを一覧表示します。

HTTPリクエスト

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

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

collectionId

string

必須。リストするparent基準としたコレクションID。例: chatroomsまたはmessages

クエリパラメータ

パラメーター
pageSize

integer

返送するドキュメントの最大数。

pageToken

string

前のListリクエストから返されたnextPageToken値(ある場合)。

orderBy

string

結果を並べ替える順序。例: priority desc, name

mask

object ( DocumentMask )

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

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

showMissing

boolean

リストに不足しているドキュメントが表示されるかどうか。欠落しているドキュメントは、存在しないがサブドキュメントがあるドキュメントです。これらのドキュメントはキーとともに返されますが、フィールド、 Document.create_time 、またはDocument.update_time設定されません。

showMissingリクエストでは、 whereまたはorderBy指定できない場合があります。

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

string ( bytes format)

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

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

readTime

string ( Timestamp format)

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

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

リクエスト本文

リクエストの本文は空である必要があります。

レスポンスボディ

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

Firestore.ListDocumentsの応答。

JSON表現
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
田畑
documents[]

object ( Document )

見つかったドキュメント。

nextPageToken

string

次のページのトークン。

承認範囲

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

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

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