Method: projects.databases.documents.listCollectionIds

Muestra todos los 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

Requerido. El documento principal. En el formato: projects/{project_id}/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
}
Campos
pageSize

integer

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

pageToken

string

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

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la 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 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 .