Method: projects.databases.collectionGroups.fields.list

Répertorie la configuration des champs et les métadonnées de cette base de données.

Actuellement, FirestoreAdmin.ListFields prend uniquement en charge les champs de liste qui ont été explicitement remplacés. Pour émettre cette requête, appelez FirestoreAdmin.ListFields avec le filtre défini sur indexConfig.usesAncestorConfig:false .

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Un nom parent du formulaire projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Paramètres de requête

Paramètres
filter

string

Le filtre à appliquer aux résultats de la liste. Actuellement, FirestoreAdmin.ListFields prend uniquement en charge les champs de liste qui ont été explicitement remplacés. Pour émettre cette requête, appelez FirestoreAdmin.ListFields avec le filtre défini sur indexConfig.usesAncestorConfig:false .

pageSize

integer

Le nombre de résultats à renvoyer.

pageToken

string

Un jeton de page, renvoyé lors d'un appel précédent à FirestoreAdmin.ListFields , qui peut être utilisé pour obtenir la page de résultats suivante.

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

La réponse pour FirestoreAdmin.ListFields .

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

Représentation JSON
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Des champs
fields[]

object ( Field )

Les champs demandés.

nextPageToken

string

Un jeton de page qui peut être utilisé pour demander une autre page de résultats. Si elle est vide, c'est la dernière page.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .