Method: accounts.locations.list

Перечисляет местоположения для указанной учетной записи.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
parent

string

Имя учетной записи, из которой нужно получить данные о местоположениях. Если Account имеет AccountType PERSONAL, возвращаются только местоположения, которые непосредственно принадлежат учетной записи, в противном случае будут возвращены все доступные местоположения из учетной записи, прямо или косвенно.

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

Параметры
pageSize

integer

Сколько местоположений нужно получить на странице. По умолчанию — 100, минимум — 1, максимальный размер страницы — 100.

pageToken

string

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

filter

string

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

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

languageCode
(deprecated)

string

Код языка BCP 47, на котором будут отображаться свойства местоположения. Если этот язык недоступен, они будут предоставлены на языке местоположения. Если ни один из них недоступен, они будут предоставлены на английском языке.

Устарело. После 15 августа 2020 г. это поле больше не будет применяться. Вместо этого всегда будет использоваться язык местоположения.

orderBy

string

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

Тело запроса

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

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

Ответное сообщение для Locations.ListLocations.

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

object ( Location )

Локации.

nextPageToken

string

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

totalSize

integer

Примерное количество локаций в списке независимо от нумерации страниц.

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

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .