このページは Cloud Translation API によって翻訳されました。
Switch to English

メソッド:projects.databases.documents.listCollectionIds

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

HTTPリクエスト

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

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

パスパラメータ

パラメーター
parent

string

必須。親ドキュメント。形式: projects/{project_id}/databases/{database_id}/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

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