Method: accounts.locations.list

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

HTTP-запрос

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

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

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

Параметры
parent

string

Необходимый. Имя учетной записи, из которой нужно получить данные о местоположениях. Если родительский [Аккаунт] [google.mybusiness.accountmanagement.v1.Account] имеет значение [AccountType] [google.mybusiness.accountmanagement.v1.Account.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 .