Method: geocode.destinations.searchDestinations

Этот метод выполняет поиск пункта назначения и возвращает список пунктов назначения.

HTTP-запрос

POST https://geocode.googleapis.com/v4alpha/geocode/destinations

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

Текст запроса

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

JSON-представление 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
Поля
travelModes[]

enum ( NavigationPoint.TravelMode )

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

languageCode

string

Необязательно. Язык, на котором должны быть возвращены результаты.

regionCode

string

Необязательный. Код региона. Код региона, указанный как двухсимвольное значение ccTLD («домен верхнего уровня»). Параметр влияет на результаты в соответствии с действующим законодательством. Этот параметр также влияет на результаты поиска, но не ограничивает их полностью.

Поле объединения primary_query . Запрос основного пункта назначения. Это может быть место, полностью указанный адрес или местоположение в системе координат LatLng. Некоторые места и адреса с минимальной информацией невозможно преобразовать в пункт назначения.

Направления формируются на основе указанного основного запроса.

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

place

string

Имя ресурса места в формате places/{placeId} .

addressQuery

object ( SearchDestinationsRequest.AddressQuery )

Уличный адрес.

locationQuery

object ( SearchDestinationsRequest.LocationQuery )

Точное местоположение.

Тело ответа

Ответное сообщение для DestinationService.SearchDestinations.

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

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

object ( Destination )

Список пунктов назначения.

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

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

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode

SearchDestinationsRequest.AddressQuery

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

JSON-представление 
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
Поля
kind поля объединения. Запрос адреса. kind может быть только одним из следующих:
address

object ( PostalAddress )

Уличный адрес в формате почтового адреса.

addressQuery

string

Адрес, отформатированный в одну строку.

SearchDestinationsRequest.LocationQuery

Запрос местоположения для определения ближайшего основного пункта назначения.

Примечание: если запрос местоположения относится к зданию, содержащему подпомещения, возможно, что возвращаемое основное местонахождение является подпомещением. В таких случаях поле containPlaces будет включать здание.

JSON-представление 
{

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
Поля
kind поля объединения. Запрос местоположения. kind может быть только одним из следующих:
location

object ( LatLng )

Точное местоположение по координатам LatLng.

Место назначения

Пункт назначения. Сюда входят основное место, связанные с ним места, входы и навигационные точки.

JSON-представление 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ]
}
Поля
primary

object ( PlaceView )

Основное место, указанное в запросе с помощью primary_query .

containingPlaces[]

object ( PlaceView )

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

subDestinations[]

object ( PlaceView )

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

Примечание: по сравнению с подпунктом назначения , возвращаемым API Places, этот список подпунктов назначения более полный, и каждый подпункт назначения содержит больше информации.

landmarks[]

object ( Landmark )

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

entrances[]

object ( Entrance )

Входы для этого пункта назначения.

navigationPoints[]

object ( NavigationPoint )

Навигационные точки для этого пункта назначения.

МестоПросмотр

Представляет представление объекта Place в API Places. Также предоставляет дополнительную информацию, относящуюся к пунктам назначения, такую как тип структуры и отображаемый многоугольник.

В некоторых случаях PlaceView с тем же идентификатором места может отличаться от того, что возвращается API Places для types и полей displayName .

JSON-представление 
{
  "place": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  }
}
Поля
place

string

Название ресурса этого места в формате places/{placeId} .

displayName

object ( LocalizedText )

Удобочитаемое описание места. Например, «Выход B», «Макдоналдс».

primaryType

string

Основной тип местоположения. Список возможных значений см. на странице https://developers.google.com/maps/documentation/places/web-service/place-types .

Примечание: это поле заполняется не всегда. В таких ситуациях будьте готовы использовать поле types .

types[]

string

Все связанные типы мест для этого места. Список возможных значений см. на странице https://developers.google.com/maps/documentation/places/web-service/place-types .

formattedAddress

string

Однострочный адрес.

postalAddress

object ( PostalAddress )

Структурированный адрес.

structureType

enum ( PlaceView.StructureType )

Тип строения, соответствующий этому месту.

location

object ( LatLng )

Местоположение этого места. Для мест с отображаемыми полигонами это может быть хорошим местом для размещения маркера на карте.

displayPolygon

object ( Struct format)

Полигональный контур места в формате GeoJSON с использованием формата RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 .

Примечание: Формат RFC 7946 поддерживает MultiPolygons, поэтому один объект displayPolygon может представлять несколько полигонов.

PlaceView.StructureType

Тип строения, который представляет собой это место.

Перечисления
STRUCTURE_TYPE_UNSPECIFIED Не использовался.
POINT Точечное местоположение.
SECTION Часть здания.
BUILDING Здание.
GROUNDS Большая территория, обычно вмещающая несколько зданий, например университетский кампус, жилой комплекс или торговый центр.

Достопримечательность

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

JSON-представление 
{
  "tags": [
    enum (Landmark.Tag)
  ],

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
Поля
tags[]

enum ( Landmark.Tag )

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

landmark Юнион-филд. landmark может быть только одной из следующих:
place

object ( PlaceView )

Место, представляющее эту достопримечательность.

Landmark.Tag

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

Если адрес содержит оба тега: ADDRESS и ARRIVAL , это означает, что достопримечательность известна в данном районе и находится недалеко от пункта назначения.

Перечисления
TAG_UNSPECIFIED Не использовался.
ADDRESS Местное заметное место, которое можно использовать для определения местоположения пункта назначения. Обычно в пределах нескольких сотен метров от него. Они аналогичны ориентирам, возвращаемым функцией «Дескрипторы адресов» API геокодирования: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors .
ARRIVAL Место, которое можно использовать для определения местоположения. Полезно для навигации, когда вы находитесь рядом с пунктом назначения. Например, этим ориентиром может быть место, расположенное через дорогу от пункта назначения. Ориентир с этим тегом обычно находится ближе к пункту назначения, чем ориентиры с тегом ADDRESS .

Вход

Вход — это одна пара координат широты/долготы, которая определяет местоположение точки входа и выхода для какого-либо места.

JSON-представление 
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
Поля
location

object ( LatLng )

Расположение входа.

tags[]

enum ( Entrance.Tag )

Список тегов, описывающих вход.

place

string

Строение, в котором физически расположен этот вход, в формате places/{placeId} .

Вход.Тег

Характеристики, описывающие вход.

Перечисления
TAG_UNSPECIFIED Не использовался.
PREFERRED

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

Например, если основным местом является ресторан в торговом центре, «ПРЕДПОЧТИТЕЛЬНЫМИ» входами будут те, которые, скорее всего, ведут в сам ресторан, в то время как другими возвращаемыми входами будут другие входы в здание, например, входы в другие рестораны в торговом центре.

Если основным местом является само здание, то PREFERRED будут входы, ведущие в «главную» часть здания. Например, в торговом центре PREFERRED будут входы, ведущие в главное фойе, но если вход ведёт только в магазин сбоку здания, он не будет PREFERRED .

Примечание: PREFERRED вход может не обеспечивать доступ к основному месту, а PREFERRED вход может обеспечивать доступ к основному месту.