Method: projects.databases.documents.listCollectionIds

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 は次のいずれかになります。
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

詳細については、認証の概要をご覧ください。