Method: accounts.locations.findMatches

Находит все возможные местоположения, соответствующие указанному местоположению. Эта операция действительна только в том случае, если местоположение не проверено.

HTTP-запрос

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches

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

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

Параметры
name

string

Имя ресурса местоположения, для которого необходимо найти совпадения.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "languageCode": string,
  "numResults": integer,
  "maxCacheDuration": string
}
Поля
languageCode

string

Предпочтительный язык для соответствующего местоположения (в формате BCP-47).

numResults

integer

Количество совпадений для возврата. Значение по умолчанию — 3, максимум — 10. Обратите внимание, что задержка может увеличиться, если запрошено большее количество. Пагинации нет.

maxCacheDuration

string ( Duration format)

Устарело. Это поле игнорируется для всех запросов.

Продолжительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся символом « s ». Пример: "3.5s" .

Тело ответа

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

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

JSON-представление 
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
Поля
matchedLocations[]

object ( MatchedLocation )

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

matchTime

string ( Timestamp format)

Когда алгоритм сопоставления последний раз выполнялся для этого местоположения.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

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

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

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

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

Сопоставленное местоположение

Представляет возможное совпадение с местоположением.

JSON-представление 
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
Поля
location

object ( Location )

Малонаселенное место, потенциально подходящее. Незаполненные поля включают, помимо прочего: имя (совпадающее местоположение не может быть получено ни через locations.get , ни через locations.batchGet ); storeCode ; сведения о зоне покрытия serviceArea ; labels ; adWordsLocationExtensions ; photos

isExactMatch

boolean

Это точное совпадение?