Method: projects.databases.documents.listDocuments

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。

string

省略可。parent に対する相対的なリスト対象のコレクション ID。

たとえば、chatrooms や messages です。

これは省略可能です。指定しない場合、Firestore は指定された parent にあるすべてのコレクションのドキュメントを一覧表示します。

integer

省略可。1 回のレスポンスで返すドキュメントの最大数。

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

string

省略可。前の documents.list レスポンスから受け取ったページトークン。

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

string

省略可。返されるドキュメントの順序（省略可）。

例: priority desc, __name__ desc。

これは、Firestore クエリで使用される ORDER BY を文字列表現でミラーリングします。指定されていない場合、ドキュメントは __name__ ASC に基づいて並べ替えられます。

object (DocumentMask)

省略可。返されるフィールド。設定されていない場合は、すべてのフィールドが返されます。

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

boolean

リストに不足している書類が表示されているかどうか。

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

showMissing を含むリクエストでは、where または orderBy を指定できません。

string (bytes format)

すでにアクティブなトランザクションの一部として読み取りを実行します。

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

string (Timestamp format)

指定された時刻に読み取りを実行します。

これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。