Method: projects.databases.documents.listCollectionIds

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

HTTPリクエスト

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

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

パスパラメータ

パラメーター
parent

string

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

リクエストボディ

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

JSON表現
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
田畑
pageSize

integer

返される結果の最大数。

pageToken

string

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

ユニオンフィールドのconsistency_selector 。このリクエストの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector次のいずれか 1 つだけです。
readTime

string ( Timestamp format)

指定された時点でのドキュメントを読み取ります。

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

レスポンスボディ

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

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