Method: projects.databases.documents.listCollectionIds

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Document parent. Format à respecter: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Par exemple : projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Corps de la requête

Le corps de la requête contient des données présentant 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.
}
Champs
pageSize

integer

Nombre maximal de résultats à renvoyer.
pageToken

string

Un jeton de page. Doit être une valeur de ListCollectionIdsResponse.
Champ d'union consistency_selector. Mode de cohérence pour cette requête. Si ce champ n'est pas spécifié, la valeur par défaut est la cohérence forte. consistency_selector ne peut être qu'un des éléments suivants :
readTime

string (Timestamp format)

Lit les documents tels qu'ils étaient à l'époque.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Corps de la réponse

Réponse de Firestore.ListCollectionIds.

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

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

string

ID des collections.
nextPageToken

string

Jeton de page qui peut être utilisé pour poursuivre la liste.

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.