ドキュメントの下にあるすべてのコレクションIDを一覧表示します。
HTTPリクエスト
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
URLはgRPCトランスコーディング構文を使用します。
パスパラメータ
パラメーター | |
---|---|
parent | 必須。親ドキュメント。形式: |
リクエスト本文
リクエスト本文には、次の構造のデータが含まれています。
JSON表現 | |
---|---|
{ "pageSize": integer, "pageToken": string } |
田畑 | |
---|---|
pageSize | 返される結果の最大数。 |
pageToken | ページトークン。 |
レスポンスボディ
成功した場合、応答本文には次の構造のデータが含まれます。
JSON表現 | |
---|---|
{ "collectionIds": [ string ], "nextPageToken": string } |
田畑 | |
---|---|
collectionIds[] | コレクションID。 |
nextPageToken | リストを続行するために使用できるページトークン。 |
承認範囲
次のOAuthスコープのいずれかが必要です。
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要を参照してください。