Method: accounts.locations.list

Lista os locais da conta especificada.

Solicitação HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome da conta de onde os locais serão buscados.

  • ID de conta específico: se a conta for do tipo AccountType.PERSONAL, a resposta vai retornar apenas os locais que pertencem diretamente a ela. Para todos os outros tipos (por exemplo, AccountType.LOCATION_GROUP), ele retorna todos os locais acessíveis.

  • Caractere curinga (-): o uso de accounts/- identifica o usuário autenticado. O escopo padrão é AccountType.PERSONAL, mas inclui locais de propriedade direta e indireta (por exemplo, aqueles acessíveis por grupos de participantes).

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número de locais a serem buscados por página. Se não for definido, o valor padrão será 10. O mínimo é 1, e o tamanho máximo da página é 100.
pageToken

string

Opcional. Se especificado, busca os próximos page locais. O token de página é retornado por chamadas anteriores para locations.list quando há mais locais do que o tamanho da página solicitado.
filter

string

Opcional. Um filtro que restringe os locais a serem retornados. A resposta inclui apenas as entradas que correspondem ao filtro. Se filter estiver vazio, as restrições serão aplicadas e todos os locais (paginados) serão recuperados para a conta solicitada.

Para mais informações sobre campos válidos e exemplos de uso, consulte o Guia para trabalhar com dados de local.
orderBy

string

Opcional. Ordem de classificação da solicitação. Vários campos precisam ser separados por vírgulas, seguindo a sintaxe SQL. A ordem de classificação padrão é crescente. Para especificar a ordem decrescente, adicione o sufixo " desc". Os campos válidos para orderBy são title e storeCode. Por exemplo: "title, storeCode desc", "title" ou "storeCode desc"
readMask

string (FieldMask format)

Obrigatório. Máscara de leitura para especificar quais campos serão retornados na resposta.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para Locations.ListLocations.

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

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

object (Location)

Os locais.
nextPageToken

string

Se o número de locais exceder o tamanho solicitado da página, esse campo será preenchido com um token para buscar a próxima página de locais em uma chamada subsequente para locations.list. Se não houver mais locais, esse campo não estará presente na resposta.
totalSize

integer

O número aproximado de locais na lista, independentemente da paginação. Esse campo só será retornado se filter for usado como um parâmetro de consulta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte OAuth 2.0 Overview.