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

メソッド:projects.databases.collectionGroups.fields.list

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

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

HTTPリクエスト

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

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

パスパラメータ

パラメーター
parent

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collectionId}の形式の親名

クエリパラメータ

パラメーター
filter

string

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

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

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