- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
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 |
O nome da conta em que os locais serão buscados. Se a |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Quantos locais devem ser buscados por página. O padrão é 100, o mínimo é 1, e o tamanho máximo da página é 100. |
pageToken |
Se especificado, ele busca o próximo |
filter |
Um filtro que restringe os locais a serem retornados. A resposta inclui apenas entradas que correspondem ao filtro. Se Para mais informações sobre campos válidos e exemplos de uso, consulte o Guia "Trabalhar com dados de local". |
languageCode |
O código de idioma BCP 47 em que as propriedades de local de exibição serão mostradas. Se esse idioma não estiver disponível, ele será fornecido no idioma do local. Se nenhuma dessas opções estiver disponível, elas serão fornecidas 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 sempre será usado. |
orderBy |
Ordem de classificação da solicitação. Vários campos devem ser separados por vírgula, seguindo a sintaxe SQL. A ordem de classificação padrão é crescente. Para especificar a ordem decrescente, um sufixo " desc" precisa ser adicionado. 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 ( |
Campos | |
---|---|
locations[] |
Os locais. |
nextPageToken |
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 |
totalSize |
O número aproximado de locais na lista, independentemente da paginação. |
Escopos de autorização
Requer um dos seguintes escopos de 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.