- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
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 |
Obrigatório. O nome da conta em que os locais serão buscados. Se a conta principal [Account] [google.mybusiness.accountmanagement.v1.Account] for de [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, somente os Locais de propriedade direta da conta serão retornados. Caso contrário, todos os locais acessíveis da conta serão retornados, direta ou indiretamente. |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Opcional. Quantos locais devem ser 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 |
Opcional. Se especificado, ele busca o próximo |
filter |
Opcional. 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". |
orderBy |
Opcional. 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 title e storeCode. Por exemplo: "title, storeCode desc" ou "title" ou "storeCode desc" |
readMask |
Obrigatório. Leia a máscara para especificar quais campos serão retornados na resposta. Esta é uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
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 ( |
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. Esse campo só será retornado se |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/business.manage
Para mais informações, consulte a Visão geral do OAuth 2.0.