このデータベースのフィールド構成とメタデータを一覧表示します。
現在、FirestoreAdmin.ListFields
は明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、フィルタを indexConfig.usesAncestorConfig:false or
ttlConfig:*` に設定して FirestoreAdmin.ListFields
を呼び出します。
HTTP リクエスト
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。 |
クエリ パラメータ
パラメータ | |
---|---|
filter |
リストの結果に適用するフィルタ。現在、 |
pageSize |
返される結果の数。 |
pageToken |
前回の |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
FirestoreAdmin.ListFields
に対するレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"fields": [
{
object ( |
フィールド | |
---|---|
fields[] |
リクエストされたフィールド。 |
nextPageToken |
結果の別のページをリクエストするために使用できるページトークン。空白の場合は、これが最後のページです。 |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要をご覧ください。