Method: projects.databases.collectionGroups.fields.list

このデータベースのフィールド構成とメタデータを一覧表示します。

現在、FirestoreAdmin.ListFields は、明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、フィルタを indexConfig.usesAncestorConfig:false または ttlConfig:* に設定して FirestoreAdmin.ListFields を呼び出します。

HTTP リクエスト

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

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

パスパラメータ

パラメータ
parent

string

必須。projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId} フォームの親名

クエリ パラメータ

パラメータ
filter

string

リスト結果に適用するフィルタ。現在、FirestoreAdmin.ListFields は、明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、indexConfig.usesAncestorConfig:false または ttlConfig:* を含むフィルタで FirestoreAdmin.ListFields を呼び出します。
pageSize

integer

返される結果の数です。
pageToken

string

前回の FirestoreAdmin.ListFields 呼び出しから返されたページトークン。結果の次のページを取得するために使用できます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

FirestoreAdmin.ListFields に対するレスポンス。

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

JSON 表現 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
フィールド
fields[]

object (Field)

リクエストされたフィールド。
nextPageToken

string

結果の別のページをリクエストするために使用できるページトークン。空白の場合は、これが最後のページです。

認可スコープ

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

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

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