Method: projects.databases.documents.listCollectionIds

Enumera todos los ID de colección debajo de un documento.

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

Requerido. El documento principal. En el formato: projects/{projectId}/databases/{databaseId}/documents/{document_path} . Por ejemplo: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
pageSize

integer

El número máximo de resultados que se devolverán.

pageToken

string

Un token de página. Debe ser un valor de ListCollectionIdsResponse .

consistency_selector del campo de unión. El modo de coherencia para esta solicitud. Si no se establece, el valor predeterminado es una coherencia fuerte. consistency_selector puede ser sólo uno de los siguientes:
readTime

string ( Timestamp format)

Lee documentos tal como estaban en el momento dado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

Cuerpo de respuesta

La respuesta de Firestore.ListCollectionIds .

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Campos
collectionIds[]

string

Los identificadores de colección.

nextPageToken

string

Un token de página que se puede utilizar para continuar la lista.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

Para obtener más información, consulte Descripción general de la autenticación .