Method: projects.databases.documents.list

ドキュメントをリストします。

HTTPリクエスト

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

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

パスパラメータ

パラメーター
parent

string

必須。親リソースの名前。形式は、 projects/{projectId}/databases/{databaseId}/documentsまたはprojects/{projectId}/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

これはオプションであり、指定しない場合、Firestore は指定されたparent下にあるすべてのコレクションのドキュメントをリストします。

クエリパラメータ

パラメーター
pageSize

integer

オプション。 1 回の応答で返されるドキュメントの最大数。

Firestore が返す値はこの値よりも少ない場合があります。

pageToken

string

オプション。以前のdocuments.list応答から受け取ったページ トークン。

これを指定して後続のページを取得します。ページ分割する場合、他のすべてのパラメーター ( pageSizeを除く) は、ページ トークンを生成したリクエストに設定された値と一致する必要があります。

orderBy

string

オプション。返却するドキュメントのオプションの順序。

例: priority desc, __name__ desc

これは、Firestore クエリで使用されるORDER BY文字列表現でミラーリングしています。存在しない場合、ドキュメントは__name__ ASCに基づいて順序付けされます。

mask

object ( DocumentMask )

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

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

showMissing

boolean

リストに不足しているドキュメントが表示されるかどうか。

ドキュメントが存在しない場合、ドキュメントは欠落していますが、その下にサブドキュメントがネストされています。 true の場合、そのような欠落しているドキュメントはキーとともに返されますが、フィールド、 createTime 、またはupdateTimeは設定されていません。

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

ユニオンパラメータの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"

リクエストボディ

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

レスポンスボディ

成功した場合、応答本文にはListDocumentsResponseのインスタンスが含まれます。

認可範囲

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

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

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