Method: projects.databases.documents.listCollectionIds

Répertorie tous les ID de collection sous un document.

Requête HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Requis. Le document parent. Au format : projects/{projectId}/databases/{databaseId}/documents/{document_path} . Par exemple : projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Corps de la demande

Le corps de la requête contient des données avec la structure suivante :

Représentation JSON
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Des champs
pageSize

integer

Le nombre maximum de résultats à renvoyer.

pageToken

string

Un jeton de page. Doit être une valeur de ListCollectionIdsResponse .

Champ d'union consistency_selector . Le mode de cohérence pour cette requête. S’il n’est pas défini, la cohérence est forte par défaut. consistency_selector ne peut être que l'un des éléments suivants :
readTime

string ( Timestamp format)

Lit les documents tels qu'ils étaient à un moment donné.

Il doit s'agir d'un horodatage précis à la microseconde au cours de la dernière heure, ou si la récupération ponctuelle est activée, il peut également s'agir d'un horodatage d'une minute entière au cours des 7 derniers jours.

Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .

Corps de réponse

La réponse de Firestore.ListCollectionIds .

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

Représentation JSON
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Des champs
collectionIds[]

string

Les identifiants de la collection.

nextPageToken

string

Un jeton de page qui peut être utilisé pour continuer la liste.

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 .