Method: projects.databases.collectionGroups.fields.list

Lista a configuração de campo e os metadados deste banco de dados.

Atualmente, FirestoreAdmin.ListFields oferece suporte apenas à listagem de campos que foram explicitamente substituídos. Para emitir esta consulta, chame FirestoreAdmin.ListFields com o filtro definido como indexConfig.usesAncestorConfig:false or ttlConfig:*`.

Solicitação HTTP

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Um nome pai do formulário projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parâmetros de consulta

Parâmetros
filter

string

O filtro a ser aplicado aos resultados da lista. Atualmente, FirestoreAdmin.ListFields oferece suporte apenas à listagem de campos que foram explicitamente substituídos. Para emitir esta consulta, chame FirestoreAdmin.ListFields com um filtro que inclua indexConfig.usesAncestorConfig:false .

pageSize

integer

O número de resultados a serem retornados.

pageToken

string

Um token de página, retornado de uma chamada anterior para FirestoreAdmin.ListFields , que pode ser usado para obter a próxima página de resultados.

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

A resposta para FirestoreAdmin.ListFields .

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

Representação JSON
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Campos
fields[]

object ( Field )

Os campos solicitados.

nextPageToken

string

Um token de página que pode ser usado para solicitar outra página de resultados. Se estiver em branco, esta é a última página.

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 .