Method: projects.databases.collectionGroups.fields.list

Listet die Feldkonfiguration und Metadaten für diese Datenbank auf.

Derzeit unterstützt FirestoreAdmin.ListFields nur das Auflisten von Feldern, die explizit überschrieben wurden. Um diese Abfrage auszugeben, rufen Sie FirestoreAdmin.ListFields mit dem Filter indexConfig.usesAncestorConfig:false orttlConfig:*` auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Ein übergeordneter Name im Format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Abfrageparameter

Parameter
filter

string

Der Filter, der auf die Listenergebnisse angewendet werden soll. Derzeit unterstützt FirestoreAdmin.ListFields nur das Auflisten von Feldern, die explizit überschrieben wurden. Um diese Abfrage auszugeben, rufen Sie FirestoreAdmin.ListFields mit einem Filter auf, der indexConfig.usesAncestorConfig:false enthält .
pageSize

integer

Die Anzahl der zurückzugebenden Ergebnisse.
pageToken

string

Ein Seitentoken, das von einem vorherigen Aufruf an FirestoreAdmin.ListFields zurückgegeben wurde und zum Abrufen der nächsten Ergebnisseite verwendet werden kann.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort für FirestoreAdmin.ListFields.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Felder
fields[]

object (Field)

Die angeforderten Felder.
nextPageToken

string

Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn das Feld leer ist, ist dies die letzte Seite.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.