Method: accounts.locations.list

Lista os locais da conta especificada.

Solicitação HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

Parâmetros de caminho

Parâmetros
parent

string

O nome da conta a partir da qual os locais serão buscados. Se o Account for PESSOAL AccountType, somente os Locais de propriedade direta da Conta serão retornados. Caso contrário, eles retornarão todos os locais acessíveis da Conta, direta ou indiretamente.

Parâmetros de consulta

Parâmetros
pageSize

integer

Quantos locais serão buscados por página. O padrão é 100, o mínimo é 1 e o tamanho máximo da página é 100.
pageToken

string

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

string

Um filtro que restringe os locais a serem retornados. A resposta inclui apenas 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 de trabalho com dados de local.
languageCode
(deprecated)

string

O código de idioma BCP 47 em que as propriedades de localização serão exibidas. Se esse idioma não estiver disponível, eles serão fornecidos no idioma do local. Se nenhum deles estiver disponível, eles serão fornecidos em inglês.

Obsoleto. Após 15 de agosto de 2020, esse campo não será mais aplicado. Em vez disso, o idioma do local será sempre usado.
orderBy

string

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

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

Mensagem de resposta para Locations.ListLocations.

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 da página solicitado, 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.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.