Method: projects.databases.collectionGroups.fields.list

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

Actuellement, FirestoreAdmin.ListFields ne permet de répertorier que les champs qui ont été explicitement remplacés. Pour émettre cette requête, appelez FirestoreAdmin.ListFields avec le filtre défini sur indexConfig.usesAncestorConfig:false orttlConfig:*`.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Un nom parent au format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Paramètres de requête

Paramètres
filter

string

Filtre à appliquer pour afficher les résultats de la liste. Actuellement, FirestoreAdmin.ListFields ne permet de répertorier que les champs qui ont été explicitement remplacés. Pour émettre cette requête, appelez FirestoreAdmin.ListFields avec un filtre qui inclut indexConfig.usesAncestorConfig:false .
pageSize

integer

Nombre de résultats à renvoyer.
pageToken

string

Jeton de page, renvoyé par un appel précédent à FirestoreAdmin.ListFields, qui peut être utilisé pour obtenir la page de résultats suivante.

Corps de la requête

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

Corps de la réponse

Réponse pour FirestoreAdmin.ListFields.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

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

object (Field)

Champs demandés.
nextPageToken

string

Jeton de page pouvant être utilisé pour demander une autre page de résultats. Si ce champ est vide, il s'agit de la dernière page.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.