Method: accounts.locations.list

Вы можете получить список адресов для определенного аккаунта.

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Параметры пути

Параметры
parent

string

Обязательно. Название аккаунта, из которого нужно получить адреса.

  • Идентификатор определенного аккаунта. Если аккаунт относится к типу AccountType.PERSONAL, в ответе будут возвращены только адреса, принадлежащие непосредственно этому аккаунту. Для всех остальных типов (например, AccountType.LOCATION_GROUP) возвращаются все доступные местоположения.

  • Подстановочный знак (-). Использование accounts/- позволяет идентифицировать аутентифицированного пользователя. По умолчанию используется область действия AccountType.PERSONAL, но она включает как адреса, принадлежащие напрямую, так и адреса, принадлежащие косвенно (например, доступные через группы участников).

Параметры запроса

Параметры
pageSize

integer

Необязательное поле. Количество адресов, которые нужно получить на странице. Если значение не задано, по умолчанию используется 10. Минимальное значение – 1, максимальное – 100.
pageToken

string

Необязательное поле. Если указано, то извлекает следующие page местоположений. Токен страницы возвращается предыдущими вызовами locations.list, когда адресов больше, чем может поместиться на странице запрошенного размера.
filter

string

Необязательное поле. Фильтр, ограничивающий возвращаемые местоположения. В ответе будут только записи, соответствующие фильтру. Если параметр filter пустой, то применяются ограничения и для запрашиваемого аккаунта извлекаются все адреса (с разбивкой на страницы).

Дополнительную информацию о допустимых полях и примеры их использования можно найти в руководстве по работе с данными о местоположении.
orderBy

string

Необязательное поле. Порядок сортировки для запроса. Если полей несколько, их нужно перечислить через запятую в соответствии с синтаксисом SQL. По умолчанию используется порядок сортировки по возрастанию. Чтобы задать сортировку по убыванию, добавьте суффикс " desc". Допустимые поля для orderBy – title и storeCode. Примеры: "title, storeCode desc", "title", "storeCode desc".
readMask

string (FieldMask format)

Обязательно. Маска чтения, указывающая, какие поля будут возвращены в ответе.

Это список полных названий полей, разделенных запятыми. Пример: "user.displayName,photo".

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ на запрос Locations.ListLocations.

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Поля
locations[]

object (Location)

Местоположения.
nextPageToken

string

Если количество адресов превышает размер страницы, в этом поле указывается токен, который позволяет получить следующую страницу с адресами при последующем вызове locations.list. Если адресов больше нет, это поле в ответе отсутствует.
totalSize

integer

Приблизительное количество местоположений в списке без учета разбивки на страницы. Это поле возвращается, только если в качестве параметра запроса используется filter.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.