Package google.maps.geocode.v4alpha

Индекс

Пункт назначения

Сервис для получения информации о пунктах назначения.

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

ПоискНаправления

rpc SearchDestinations( SearchDestinationsRequest ) returns ( SearchDestinationsResponse )

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

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

Геокодировка

Сервис для выполнения геокодирования.

ГеокодАдрес

rpc GeocodeAddress( GeocodeAddressRequest ) returns ( GeocodeAddressResponse )

Этот метод выполняет геокодирование адреса, сопоставляя адрес с координатами широты и долготы. Он также предоставляет структурированную информацию об адресе.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.address
ГеокодМестоположение

rpc GeocodeLocation( GeocodeLocationRequest ) returns ( GeocodeLocationResponse )

Этот метод выполняет геокодирование местоположения, сопоставляя координаты широты и долготы с адресом. Он также предоставляет структурированную информацию об адресе.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

rpc GeocodePlace( GeocodePlaceRequest ) returns ( GeocodeResult )

Этот метод выполняет поиск геокода, используя идентификатор места.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

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

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

Поля
primary

PlaceView

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

containing_places[]

PlaceView

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

sub_destinations[]

PlaceView

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

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

landmarks[]

Landmark

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

entrances[]

Entrance

Входы в этот регион.

navigation_points[]

NavigationPoint

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

arrival_summary

Destination.ArrivalSummary

Сводная информация о впечатлениях от прибытия в пункт назначения, сгенерированная искусственным интеллектом.

Сводка прибытия

Сводная информация о впечатлениях от прибытия в пункт назначения, сгенерированная искусственным интеллектом.

Поля
text

LocalizedText

Краткое описание впечатлений от прибытия в пункт назначения.

flag_content_url

string

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

disclosure_text

LocalizedText

Только для вывода. Содержит текст с информацией о прибытии.

Вход

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

Поля
location

LatLng

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

tags[]

Entrance.Tag

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

place

string

Физическое местоположение данного входа указано в формате places/{place_id} .

Ярлык

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

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

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

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

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

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

GeocodeAddressRequest

Запрос сообщения для GeocodeService.GeocodeAddress.

Поля
location_bias

GeocodeAddressRequest.LocationBias

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

language_code

string

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

region_code

string

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

Поле объединения address_input . Адрес для геокодирования. address_input может принимать только одно из следующих значений:
address_query

string

Неструктурированный адрес для геокодирования.

address

PostalAddress

Структурированный адрес для геокодирования в формате почтового адреса.

LocationBias

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

Поля
type поля объединения. Типы смещения местоположения. type может быть только одним из следующих:
rectangle

Viewport

Прямоугольный прямоугольник, ограниченный северо-восточным и юго-западным углами. rectangle.high() должен быть северо-восточной точкой области просмотра прямоугольника. rectangle.low() должен быть юго-западной точкой области просмотра прямоугольника. rectangle.low().latitude() не может быть больше, чем rectangle.high().latitude() . Это приведет к пустому диапазону широты. Область просмотра прямоугольника не может быть шире 180 градусов.

GeocodeAddressResponse

Ответное сообщение для GeocodeService.GeocodeAddress .

Поля
results[]

GeocodeResult

Результат геокодирования.

GeocodeLocationRequest

Запрос сообщения для GeocodeService.GeocodeLocation.

Поля
language_code

string

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

region_code

string

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

types[]

string

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

Полный список возможных значений см. в таблицах A и B по адресу https://developers.google.com/maps/documentation/places/web-service/place-types .

granularity[]

GeocodeResult.Granularity

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

Поле объединения location_input . Местоположение для геокодирования. location_input может принимать только одно из следующих значений:
location_query

string

Местоположение указывается в формате строки "lat,lng". Например: "64.7611872,-18.4705364".

location

LatLng

Местоположение в структурированном формате.

GeocodeLocationResponse

Ответное сообщение для GeocodeService.GeocodeLocation .

Поля
results[]

GeocodeResult

Результат геокодирования.

plus_code

PlusCode

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

GeocodePlaceRequest

Сообщение запроса для GeocodeService.GeocodePlace.

Поля
place

string

Обязательно. Идентификатор места для геокодирования в формате places/{place}.

language_code

string

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

region_code

string

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

GeocodeResult

Результат геокодирования содержит географическую информацию о месте.

Поля
place

string

Полный идентификатор места для данного результата. В формате "//places.googleapis.com/places/{placeID}". Дополнительные сведения см. на странице https://developers.google.com/maps/documentation/places/web-service/place-id .

place_id

string

Идентификатор места для этого результата.

location

LatLng

Последняя цифра этого адреса.

granularity

GeocodeResult.Granularity

Детальность определения местоположения.

viewport

Viewport

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

bounds

Viewport

Ограничивающая рамка для адреса.

formatted_address

string

Адрес в однострочном формате.

postal_address

PostalAddress

Адрес в формате почтового адреса.

address_components[]

GeocodeResult.AddressComponent

Повторяющиеся компоненты для каждого уровня местоположения.

postal_code_localities[]

LocalizedText

Полный список населенных пунктов, входящих в данный почтовый индекс.

Это поле заполняется только в том случае, если результат имеет тип "postal_code".

types[]

string

Набор тегов типа для этого результата. Например, "political" и "administrative_area".

Полный список возможных значений см. в таблицах A и B по адресу https://developers.google.com/maps/documentation/places/web-service/place-types .

plus_code

PlusCode

Плюс код местоположения в этом геокоде.

AddressComponent

Структурированные компоненты, формирующие отформатированный адрес, если эта информация доступна.

Поля
long_text

string

Полное текстовое описание или название компонента адреса. Например, компонент адреса для страны Австралия может иметь полное название «Австралия».

short_text

string

Если имеется, укажите сокращенное текстовое название компонента адреса. Например, компонент адреса для страны Австралия может иметь короткое название «AU».

types[]

string

Массив, указывающий тип(ы) компонента адреса.

Дополнительную информацию см. на странице https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types .

language_code

string

Язык, используемый для форматирования этих компонентов, в нотации CLDR.

Гранулярность

Детальность определения местоположения.

Перечисления
GRANULARITY_UNSPECIFIED Не использовать.
ROOFTOP Неинтерполированное местоположение фактического земельного участка, соответствующего указанному адресу.
RANGE_INTERPOLATED Интерполируется из диапазона номеров домов. Например, если известно, что участок Amphitheatre Pkwy содержит номера от 1600 до 1699, то 1650 может быть расположен посередине между его конечными точками.
GEOMETRIC_CENTER Геометрический центр объекта, для которого у нас имеются полигональные данные.
APPROXIMATE Всё остальное.

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

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

Поля
relational_description

LocalizedText

Удобочитаемое описание того, как место назначения связано с достопримечательностью. Например: «Рядом с Эмпайр-стейт-билдинг» или «Напротив Белого дома».

tags[]

Landmark.Tag

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

straight_line_distance_meters

double

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

travel_distance_meters

double

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

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

PlaceView

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

Ярлык

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

Если адрес содержит одновременно метки ADDRESS и ARRIVAL , это означает, что ориентир хорошо известен в этом районе и находится недалеко от места назначения.

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

Навигационная точка — это место рядом с дорогой, где может закончиться навигация.

Поля
navigation_point_token

string

Только для вывода. Токен, который можно использовать для идентификации этой точки навигации.

display_name

LocalizedText

Отображаемое название этой точки навигации. Например, «5th Ave» или «Gate B».

location

LatLng

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

travel_modes[]

NavigationPoint.TravelMode

Подходящие для данной точки навигации способы передвижения.

usages[]

NavigationPoint.Usage

Варианты использования, поддерживаемые этим пунктом навигации.

TravelMode

Подходящие для данной точки навигации способы передвижения.

Перечисления
TRAVEL_MODE_UNSPECIFIED Не используется.
DRIVE Подходит для вождения.
WALK Подходит для прогулок.

Использование

Варианты использования, поддерживаемые этим пунктом навигации.

Перечисления
USAGE_UNSPECIFIED Не используется.
UNKNOWN Тип использования неизвестен. Большинство точек навигации будут UNKNOWN , и это не обязательно означает, что их использование каким-либо образом ограничено. Эта навигация может быть пригодна для посадки и/или высадки пассажиров.
DROPOFF Подходит для высадки пассажира. Например, для места высадки пассажиров в пункте проката автомобилей.
PICKUP Подходит для посадки пассажиров. Например, в пункте посадки для водителей сервисов совместных поездок.

PlaceView

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

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

Поля
place

string

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

display_name

LocalizedText

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

primary_type

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 .

formatted_address

string

Адрес в одну строку.

postal_address

PostalAddress

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

structure_type

PlaceView.StructureType

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

location

LatLng

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

display_polygon

Struct

Контур местности в формате GeoJSON, соответствующий стандарту RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 .

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

StructureType

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

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

ПлюсКод

Код Plus ( http://plus.codes ) — это код местоположения, имеющий два формата: глобальный код, определяющий прямоугольник размером 14х14 м (1/8000 градуса) или меньше, и составной код, в котором префикс заменяется указанием местоположения.

Поля
global_code

string

Полный глобальный код района, например, "9FWM33GV+HQ", обозначает область размером 1/8000 на 1/8000 градуса (примерно 14 на 14 метров).

compound_code

string

Составной код места, например, "33GV+HQ, Рамберг, Норвегия", содержит суффикс глобального кода и заменяет префикс отформатированным именем ссылочного объекта.

SearchDestinationsRequest

Сообщение запроса для DestinationService.SearchDestinations.

Поля
travel_modes[]

NavigationPoint.TravelMode

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

language_code

string

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

region_code

string

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

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

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

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

place

string

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

address_query

SearchDestinationsRequest.AddressQuery

Адрес.

location_query

SearchDestinationsRequest.LocationQuery

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

АдресЗапрос

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

Поля
Поле объединения kind . Запрос адреса. kind может принимать только одно из следующих значений:
address

PostalAddress

Адрес улицы в формате почтового адреса.

address_query

string

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

LocationQuery

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

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

Поля
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

Необязательно. Фильтры для отбора кандидатов на место назначения.

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

LatLng

Точное местоположение по широте и долготе.

PlaceFilter

Фильтры для отбора кандидатов на место назначения.

Поля
structure_type

PlaceView.StructureType

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

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

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

addressability

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

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

Адресность

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

Перечисления
ADDRESSABILITY_UNSPECIFIED Если параметр не указан, сервис выберет разумное значение по умолчанию.
ANY Возможность указания адреса не является критерием фильтрации. Адреса возвращаются независимо от возможности указания адреса.
PRIMARY Для всех возвращаемых адресов будет указано основное место назначения с адресом или названием улицы.
WEAK Все возвращаемые пункты назначения будут содержать либо основное место назначения, либо дополнительный пункт назначения с указанием адреса или названия улицы.

SearchDestinationsResponse

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

Поля
destinations[]

Destination

Список направлений.

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