Method: projects.databases.documents.listCollectionIds

Lista todos os IDs de coleções em um documento.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

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

Corpo da solicitação

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. Precisa ser um valor de ListCollectionIdsResponse.
Campo de união consistency_selector. O modo de consistência dessa solicitação. Se não for definido, o padrão é consistência forte. consistency_selector pode ser apenas de um dos tipos a seguir:
readTime

string (Timestamp format)

Lê os documentos como estavam no momento especificado.

Precisa ser um carimbo de data/hora com precisão de microssegundos na última hora ou, se a recuperação pontual estiver ativada, também poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete 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 da resposta

A resposta de Firestore.ListCollectionIds.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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

string

Os IDs das coleções.
nextPageToken

string

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

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.