Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Método: projects.databases.documents.listCollectionIds

Enumera todas las ID de colección debajo de un documento.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

Necesario. El documento padre. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} . Por ejemplo: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Cuerpo de solicitud

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

Representación JSON
 {
  "pageSize" :  integer ,
  "pageToken" :  string
} 
Campos
pageSize

integer

El número máximo de resultados a devolver.

pageToken

string

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

Cuerpo de respuesta

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

La respuesta de Firestore.ListCollectionIds .

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

string

Los identificadores de la colección.

nextPageToken

string

Un token de página que puede usarse 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 la Descripción general de la autenticación .