Method: projects.databases.documents.listCollectionIds

Lista todos os IDs de coleção abaixo de um documento.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O documento pai. No formato: projects/{projectId}/databases/{databaseId}/documents/{document_path} . Por exemplo: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Solicitar corpo

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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

O número máximo de resultados a serem retornados.

pageToken

string

Um token de página. Deve ser um valor de ListCollectionIdsResponse .

Campo de união consistency_selector . O modo de consistência para esta solicitação. Se não for definido, o padrão é consistência forte. consistency_selector pode ser apenas um dos seguintes:
readTime

string ( Timestamp format)

Lê documentos como eles estavam no momento determinado.

Deve ser um carimbo de data/hora com precisão de microssegundos da última hora ou, se a recuperação pontual estiver ativada, também pode ser um carimbo de hora de um minuto inteiro dos últimos 7 dias.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

Corpo de resposta

A resposta de Firestore.ListCollectionIds .

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

Representação JSON
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Campos
collectionIds[]

string

Os IDs da coleção.

nextPageToken

string

Um token de página que pode ser usado para continuar a lista.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .