Method: googleLocations.search

Поиск всех возможных местоположений, соответствующих указанному запросу.

HTTP-запрос

POST https://mybusinessbusinessinformation.googleapis.com/v1/googleLocations:search

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

Тело запроса

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

JSON-представление
{
  "pageSize": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (Location)
  },
  "query": string
  // End of mutually exclusive fields.
}
Поля
pageSize

integer

Количество совпадений, которые нужно вернуть. Значение по умолчанию – 3, максимальное – 10. Если запросить больше, задержка может увеличиться. Разбивка на страницы не предусмотрена.

Поисковый запрос. Его можно указать как объект местоположения или как строку запроса. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
location

object (Location)

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

query

string

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

Конец взаимоисключающих полей.

Тело ответа

Ответное сообщение для GoogleLocations.SearchGoogleLocations.

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

JSON-представление
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
Поля
googleLocations[]

object (GoogleLocation)

Набор объектов GoogleLocation, которые могут соответствовать указанному запросу, перечисленных в порядке от наиболее до наименее точного.

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

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

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

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