Method: projects.databases.collectionGroups.fields.list

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

No momento, FirestoreAdmin.ListFields só é compatível com a listagem de campos que foram explicitamente modificados. Para emitir essa consulta, chame FirestoreAdmin.ListFields com o filtro definido como indexConfig.usesAncestorConfig:false ou ttlConfig:*.

Solicitação HTTP

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

O URL usa a 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. No momento, FirestoreAdmin.ListFields só é compatível com a listagem de campos que foram explicitamente modificados. Para emitir essa consulta, chame FirestoreAdmin.ListFields com um filtro que inclua indexConfig.usesAncestorConfig:false ou ttlConfig:*.
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 exibir a próxima página de resultados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta para FirestoreAdmin.ListFields.

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

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 o campo ficar em branco, será a última página.

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.