Method: projects.locations.list

Lista informações sobre os locais com suporte para este serviço.

Solicitação HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
name

string

O recurso que possui a coleção de locais, se aplicável.

Parâmetros de consulta

Parâmetros
filter

string

Um filtro para restringir os resultados a um subconjunto preferido. A linguagem de filtragem aceita strings como "displayName=tokyo" e está documentada com mais detalhes em AIP-160 .

pageSize

integer

O número máximo de resultados a serem retornados. Se não for definido, o serviço selecionará um padrão.

pageToken

string

Um token de página recebido do campo nextPageToken na resposta. Envie esse token de página para receber a página subsequente.

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

A mensagem de resposta para Locations.ListLocations .

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

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

object ( Location )

Uma lista de locais que correspondem ao filtro especificado na solicitação.

nextPageToken

string

O token padrão da próxima página da 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 .