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

Method: projects.databases.documents.listCollectionIds

ドキュメントの下にあるすべてのコレクションIDを一覧表示します。

HTTPリクエスト

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

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

パスパラメータ

パラメーター
parent

string

必須。親ドキュメント。形式: projects/{project_id}/databases/{databaseId}/documents/{document_path} 。例: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

リクエスト本文

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

JSON表現
{
  "pageSize": integer,
  "pageToken": string
}
田畑
pageSize

integer

返される結果の最大数。

pageToken

string

ページトークン。 ListCollectionIdsResponse値である必要があります。

レスポンスボディ

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

Firestore.ListCollectionIdsからの応答。

JSON表現
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
田畑
collectionIds[]

string

コレクションID。

nextPageToken

string

リストを続行するために使用できるページトークン。

承認範囲

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

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

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