Package google.maps.places.v1

Landmark

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

Area

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

string

Название ресурса области.

string

Идентификатор места в этом районе.

LocalizedText

Отображаемое название области.

Containment

Определяет пространственное соотношение между целевым местоположением и областью.

string

Название ресурса достопримечательности.

string

Идентификатор места достопримечательности.

LocalizedText

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

string

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

SpatialRelationship

Определяет пространственное соотношение между целевым местоположением и ориентиром.

float

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

float

Расстояние, пройденное по дорожной сети от цели до ориентира (если известно), в метрах. Это значение не учитывает способ передвижения (например, пешком, на машине или велосипеде).

string

Имя автора Photo или Review .

string

URI автора Photo или Review .

string

URI фотографии профиля автора Photo или Review .

string

Обязательно. Текстовая строка для поиска.

LocationBias

Необязательно. Смещение результатов в указанное место.

Следует задать максимум один из параметров location_bias или location_restriction . Если ни один из них не задан, результаты будут смещены по IP-адресу, то есть IP-адрес будет сопоставлен с неточным местоположением и использован в качестве сигнала смещения.

LocationRestriction

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

Следует задать максимум один из параметров location_bias или location_restriction . Если ни один из них не задан, результаты будут смещены по IP-адресу, то есть IP-адрес будет сопоставлен с неточным местоположением и использован в качестве сигнала смещения.

string

Необязательно. Включен основной тип места (например, «ресторан» или «заправочная станция») в типы мест ( https://developers.google.com/maps/documentation/places/web-service/place-types) или только (regions) или только (cities) . Место возвращается только в том случае, если его основной тип включен в этот список. Можно указать до 5 значений. Если типы не указаны, возвращаются все типы мест.

string

Необязательно. Включать результаты только в указанных регионах, заданных как до 15 двухсимвольных кодов регионов CLDR. Пустой набор не ограничивает результаты. Если заданы оба location_restriction и included_region_codes , результаты будут расположены в области пересечения.

string

Необязательно. Язык, на котором возвращаются результаты. По умолчанию — en-US. Результаты могут быть на смешанных языках, если язык, используемый во input , отличается от language_code или если возвращаемое место не имеет перевода с локального языка на language_code .

string

Необязательный параметр. Код региона, указанный как двухсимвольный код региона CLDR. Он влияет на форматирование адреса, ранжирование результатов и может влиять на возвращаемые результаты. Это не ограничивает результаты указанным регионом. Чтобы ограничить результаты регионом, используйте region_code_restriction .

LatLng

Необязательно. Начальная точка, от которой рассчитывается геодезическое расстояние до пункта назначения (возвращается как distance_meters ). Если это значение пропущено, геодезическое расстояние не будет возвращено.

int32

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

Если пусто, по умолчанию используется длина input .

bool

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

string

Необязательная строка. Строка, идентифицирующая сеанс автозаполнения для выставления счетов. Должна представлять собой строку в формате base64, безопасную для URL и имени файла, длиной не более 36 символов ASCII. В противном случае возвращается ошибка INVALID_ARGUMENT.

Сеанс начинается с того, что пользователь начинает вводить запрос, и завершается выбором места и вызовом функции проверки сведений о месте или адреса. В каждом сеансе может быть несколько запросов, за которыми следует один запрос на проверку сведений о месте или адреса. Учётные данные, используемые для каждого запроса в рамках сеанса, должны принадлежать одному проекту Google Cloud Console. После завершения сеанса токен становится недействительным; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр session_token пропущен или вы повторно используете токен сеанса, сеанс тарифицируется так, как если бы токен сеанса не предоставлялся (каждый запрос оплачивается отдельно).

Мы рекомендуем следующие рекомендации:

• Используйте токены сеанса для всех вызовов Place Autocomplete.
• Генерируйте новый токен для каждого сеанса. Рекомендуется использовать UUID версии 4.
• Убедитесь, что учетные данные, используемые для всех запросов Place Autocomplete, Place Details и Address Validation в рамках сеанса, принадлежат одному и тому же проекту Cloud Console.
• Обязательно передавайте уникальный токен сеанса для каждого нового сеанса. Использование одного и того же токена для нескольких сеансов приведёт к тому, что каждый запрос будет оплачиваться отдельно.

bool

Необязательно. Включайте компании, работающие исключительно в зоне обслуживания, если поле установлено как true. Компании, работающие исключительно в зоне обслуживания, — это компании, которые посещают клиентов или доставляют им товары напрямую, но не обслуживают их по адресу. Например, компании, предоставляющие услуги по уборке или сантехнике. У таких компаний нет физического адреса или местоположения на Google Картах. Функция Places не будет возвращать поля, включая location , plus_code и другие поля, связанные с местоположением, для этих компаний.

Viewport

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

Circle

Окружность, определяемая центральной точкой и радиусом.

Viewport

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

Circle

Окружность, определяемая центральной точкой и радиусом.

Suggestion

Содержит список предложений, упорядоченных в порядке убывания релевантности.

PlacePrediction

Прогноз для Места.

QueryPrediction

Прогноз для запроса.

string

Текст, который можно использовать как есть или отформатировать с помощью matches .

StringRange

Список диапазонов строк, указывающих, где запрос ввода совпал с text . Эти диапазоны можно использовать для форматирования отдельных частей text . Подстроки могут не совпадать с input в точности, если совпадение определялось по критериям, отличным от соответствия строк (например, исправление орфографии или транслитерация).

Эти значения представляют собой смещения символов Unicode в text . Диапазоны гарантированно упорядочены по возрастанию значений смещения.

string

Имя ресурса предлагаемого места. Это имя можно использовать в других API, принимающих имена мест.

string

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

FormattableText

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

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

Этот текст может отличаться от display_name , возвращаемого GetPlace.

Может быть на смешанных языках, если input данные запроса и language_code указаны на разных языках или если у места нет перевода с местного языка на language_code .

StructuredFormat

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

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

string

Список типов, которые применяются к этому месту из таблицы A или таблицы B в https://developers.google.com/maps/documentation/places/web-service/place-types .

Тип — это категоризация места. Места с общими типами будут иметь схожие характеристики.

int32

Длина геодезической линии в метрах от origin если origin указана. Некоторые прогнозы, например, маршруты, могут не содержать это поле.

FormattableText

Прогнозируемый текст. Этот текст не представляет место, а представляет собой текстовый запрос, который можно использовать в конечной точке поиска (например, текстовый поиск).

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

Могут быть на смешанных языках, если input данные запроса и language_code указаны на разных языках или если часть запроса не имеет перевода с локального языка на language_code .

StructuredFormat

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

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

int32

Смещение от нуля первого символа Unicode в строке (включительно).

int32

Смещение от нуля последнего символа Unicode (исключая его).

FormattableText

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

FormattableText

Представляет дополнительные неоднозначные признаки (например, город или регион) для дальнейшей идентификации места или уточнения запроса.

LatLng

Обязательно. Центральная широта и долгота.

Диапазон широты должен быть в пределах [-90,0, 90,0]. Диапазон долготы должен быть в пределах [-180,0, 180,0].

double

Обязательно. Радиус измеряется в метрах. Радиус должен быть в диапазоне [0,0, 50000,0].

LocalizedText

Контент, соответствующий теме.

string

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

Review

Список отзывов об этом месте, соответствующих поисковому запросу.

Photo

Информация (включая ссылки) о фотографиях этого места, контекстуальная для запроса места.

Justification

Экспериментальный: более подробную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

Обоснования места.

ReviewJustification

Экспериментальный: более подробную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

BusinessAvailabilityAttributesJustification

Экспериментальный: более подробную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

bool

Если в заведении можно заказать еду на вынос.

bool

Если место обеспечивает доставку.

bool

Если в заведении есть возможность пообедать.

HighlightedText

Review

Обзор, на основе которого создан выделенный текст.

string

HighlightedTextRange

Список диапазонов выделенного текста.

int32

int32

int32

Количество разъёмов на этой станции. Однако, поскольку некоторые порты могут иметь несколько разъёмов, но при этом заряжать только один автомобиль одновременно (например), количество разъёмов может превышать общее количество автомобилей, которые могут заряжаться одновременно.

ConnectorAggregation

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

EVConnectorType

Тип соединителя данной агрегации.

double

Максимальная статическая скорость зарядки в кВт каждого разъема в агрегации.

int32

Количество коннекторов в этой агрегации.

Timestamp

Метка времени последнего обновления информации о доступности коннектора в этом агрегировании.

int32

Количество коннекторов в этой агрегации, которые в данный момент доступны.

int32

Количество коннекторов в этом агрегировании, которые в настоящее время не обслуживаются.

FuelPrice

Последняя известная цена на топливо каждого типа, доступного на этой заправке. Для каждого типа топлива, доступного на этой заправке, существует одна запись. Порядок не важен.

FuelType

Тип топлива.

Money

Цена на топливо.

Timestamp

Время последнего обновления цены на топливо.

string

Обязательно. Имя ресурса фотоносителя в формате: places/{place_id}/photos/{photo_reference}/media .

Имя ресурса фотографии, возвращаемое в поле photos.name объекта Place, имеет формат places/{place_id}/photos/{photo_reference} . Чтобы получить имя ресурса медиафайла, необходимо добавить /media в конец имени ресурса фотографии.

int32

Необязательно. Указывает максимальную желаемую ширину изображения в пикселях. Если изображение меньше указанных значений, будет возвращено исходное изображение. Если изображение больше по одному из двух измерений, оно будет масштабировано до меньшего из двух измерений с сохранением исходного соотношения сторон. Свойства max_height_px и max_width_px принимают целые числа от 1 до 4800 включительно. Если значение выходит за пределы допустимого диапазона, будет возвращена ошибка INVALID_ARGUMENT.

Необходимо указать хотя бы один из параметров: max_height_px или max_width_px. Если не указаны ни max_height_px, ни max_width_px, будет возвращена ошибка INVALID_ARGUMENT.

int32

Необязательно. Указывает максимальную желаемую высоту изображения в пикселях. Если изображение меньше указанных значений, будет возвращено исходное изображение. Если изображение больше по одному из двух измерений, оно будет масштабировано до меньшего из двух измерений с сохранением исходного соотношения сторон. Свойства max_height_px и max_width_px принимают целые числа от 1 до 4800 включительно. Если значение выходит за пределы допустимого диапазона, будет возвращена ошибка INVALID_ARGUMENT.

Необходимо указать хотя бы один из параметров: max_height_px или max_width_px. Если не указаны ни max_height_px, ни max_width_px, будет возвращена ошибка INVALID_ARGUMENT.

bool

Необязательно. Если установлено, пропускается HTTP-перенаправление по умолчанию и формируется ответ в текстовом формате (например, в формате JSON для HTTP-запроса). Если не установлено, будет выполнено HTTP-перенаправление для перенаправления вызова к медиафайлу с изображением. Этот параметр игнорируется для запросов, отличных от HTTP.

string

Обязательно. Имя ресурса места в формате places/{place_id} .

string

Необязательно. Информация о месте будет отображаться на выбранном вами языке (если он доступен).

Текущий список поддерживаемых языков: https://developers.google.com/maps/faq#languagesupport .

string

Необязательный. Код страны/региона в формате Unicode (CLDR) местоположения, откуда поступил запрос. Этот параметр используется для отображения информации о месте, например, названия региона, если оно доступно. Этот параметр может влиять на результаты в зависимости от действующего законодательства. Подробнее см. https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html .

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

string

Необязательная строка. Строка, идентифицирующая сеанс автозаполнения для выставления счетов. Должна представлять собой строку в формате base64, безопасную для URL и имени файла, длиной не более 36 символов ASCII. В противном случае возвращается ошибка INVALID_ARGUMENT.

Сеанс начинается с того, что пользователь начинает вводить запрос, и завершается выбором места и вызовом функции проверки сведений о месте или адреса. В каждом сеансе может быть несколько запросов, за которыми следует один запрос на проверку сведений о месте или адреса. Учётные данные, используемые для каждого запроса в рамках сеанса, должны принадлежать одному проекту Google Cloud Console. После завершения сеанса токен становится недействительным; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр session_token пропущен или вы повторно используете токен сеанса, сеанс тарифицируется так, как если бы токен сеанса не предоставлялся (каждый запрос оплачивается отдельно).

Мы рекомендуем следующие рекомендации:

• Используйте токены сеанса для всех вызовов Place Autocomplete.
• Генерируйте новый токен для каждого сеанса. Рекомендуется использовать UUID версии 4.
• Убедитесь, что учетные данные, используемые для всех запросов Place Autocomplete, Place Details и Address Validation в рамках сеанса, принадлежат одному и тому же проекту Cloud Console.
• Обязательно передавайте уникальный токен сеанса для каждого нового сеанса. Использование одного и того же токена для нескольких сеансов приведёт к тому, что каждый запрос будет оплачиваться отдельно.

string

Идентификатор. Ссылка, представляющая фотографию этого места, которую можно использовать для повторного поиска этой фотографии (также называется именем «ресурса» API: places/{place_id}/photos/{photo} ).

int32

Максимально доступная ширина в пикселях.

int32

Максимально доступная высота в пикселях.

AuthorAttribution

Авторы этой фотографии.

string

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

string

Ссылка для показа фотографии на Google Maps.

string

Имя ресурса фотоносителя в формате: places/{place_id}/photos/{photo_reference}/media .

string

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

string

Название ресурса этого места в формате places/{place_id} . Может использоваться для поиска места.

string

Уникальный идентификатор места.

LocalizedText

Локализованное название места, подходящее для краткого и понятного описания. Например, «Google Сидней», «Starbucks», «Pyrmont» и т. д.

string

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

string

Основной тип результата. Этот тип должен быть одним из поддерживаемых Places API. Например, «ресторан», «кафе», «аэропорт» и т. д. У места может быть только один основной тип. Полный список возможных значений см. в таблицах A и B по адресу https://developers.google.com/maps/documentation/places/web-service/place-types . Основной тип может отсутствовать, если основной тип места не поддерживается. Если основной тип присутствует, он всегда соответствует одному из типов, указанных в поле types .

LocalizedText

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

string

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

string

Удобный для восприятия номер телефона этого места в международном формате.

string

Полный, понятный человеку адрес этого места.

string

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

PostalAddress

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

AddressComponent

Повторяющиеся компоненты для каждого уровня населённого пункта. Обратите внимание на следующие факты о массиве address_components[]: - Массив компонентов адреса может содержать больше компонентов, чем formatted_address. - Массив не обязательно включает все политические единицы, содержащие адрес, помимо тех, которые включены в formatted_address. Чтобы получить все политические единицы, содержащие определённый адрес, следует использовать обратное геокодирование, передавая широту/долготу адреса в качестве параметра запроса. - Формат ответа не гарантируется одинаковым между запросами. В частности, количество address_components зависит от запрошенного адреса и может меняться со временем для одного и того же адреса. Компонент может изменить положение в массиве. Тип компонента может измениться. В последующем ответе может отсутствовать определённый компонент.

PlusCode

Плюс код местоположения места широта/долгота.

LatLng

Положение этого места.

Viewport

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

double

Рейтинг от 1,0 до 5,0, основанный на отзывах пользователей об этом месте.

string

URL-адрес, предоставляющий более подробную информацию об этом месте.

string

Официальный веб-сайт данного места, например, домашняя страница компании. Обратите внимание, что для мест, входящих в сеть (например, магазина IKEA), это обычно веб-сайт отдельного магазина, а не всей сети.

Review

Список отзывов об этом месте, отсортированный по релевантности. Можно добавить не более 5 отзывов.

OpeningHours

Обычные часы работы. Обратите внимание: если место открыто круглосуточно, поле close не будет установлено. Клиенты могут использовать « open круглосуточно» как период, содержащий day со значением 0 , hour со значением 0 и minute со значением 0 .

TimeZone

Часовой пояс базы данных часовых поясов IANA. Например, «America/New_York».

Photo

Информация (включая ссылки) о фотографиях этого места. Можно вернуть не более 10 фотографий.

string

Адрес места в микроформате adr: http://microformats.org/wiki/adr .

BusinessStatus

Бизнес-статус места.

PriceLevel

Уровень цен в данном месте.

Attribution

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

string

Укороченный URL-адрес маски значка. Пользователь может получить доступ к значкам разных типов, добавив суффикс типа в конец имени (например, «.svg» или «.png»).

string

Цвет фона для icon_mask в шестнадцатеричном формате, например #909CE1.

OpeningHours

Часы работы на следующие семь дней (включая сегодняшний). Период начинается в полночь в день запроса и заканчивается в 23:59 через шесть дней. Это поле включает подполе special_days для всех часов, заданных для дат с особыми часами работы.

OpeningHours

Contains an array of entries for the next seven days including information about secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.

OpeningHours

Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.

LocalizedText

Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.

PaymentOptions

Payment options the place accepts. If a payment option data is not available, the payment option field will be unset.

ParkingOptions

Options of parking provided by the place.

SubDestination

A list of sub-destinations related to the place.

FuelOptions

The most recent information about fuel options in a gas station. This information is updated regularly.

EVChargeOptions

Information of ev charging options.

GenerativeSummary

AI-generated summary of the place.

ContainingPlace

List of places in which the current place is located.

AddressDescriptor

The address descriptor of the place. Address descriptors include additional information that help describe a location using landmarks and areas. See address descriptor regional coverage in https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage .

GoogleMapsLinks

Links to trigger different Google Maps actions.

PriceRange

The price range associated with a Place.

ReviewSummary

AI-generated summary of the place using user reviews.

EvChargeAmenitySummary

The summary of amenities near the EV charging station.

NeighborhoodSummary

A summary of points of interest near the place.

ConsumerAlert

The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies.

string

If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in places/{place_id} format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved.

string

If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved.

int32

Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, eg X hours and 15 minutes.

int32

The total number of reviews (with or without text) for this place.

bool

Specifies if the business supports takeout.

bool

Specifies if the business supports delivery.

bool

Specifies if the business supports indoor or outdoor seating options.

bool

Specifies if the business supports curbside pickup.

bool

Specifies if the place supports reservations.

bool

Specifies if the place serves breakfast.

bool

Specifies if the place serves lunch.

bool

Specifies if the place serves dinner.

bool

Specifies if the place serves beer.

bool

Specifies if the place serves wine.

bool

Specifies if the place serves brunch.

bool

Specifies if the place serves vegetarian food.

bool

Place provides outdoor seating.

bool

Place provides live music.

bool

Place has a children's menu.

bool

Place serves cocktails.

bool

Place serves dessert.

bool

Place serves coffee.

bool

Place is good for children.

bool

Place allows dogs.

bool

Place has restroom.

bool

Place accommodates groups.

bool

Place is suitable for watching sports.

AccessibilityOptions

Information about the accessibility options a place offers.

bool

Indicates whether the place is a pure service area business. Pure service area business is a business that visits or delivers to customers directly but does not serve customers at their business address. For example, businesses like cleaning services or plumbers. Those businesses may not have a physical address or location on Google Maps.

bool

Place offers wheelchair accessible parking.

bool

Places has wheelchair accessible entrance.

bool

Place has wheelchair accessible restroom.

bool

Place has wheelchair accessible seating.

string

The full text description or name of the address component. For example, an address component for the country Australia may have a long_name of "Australia".

string

An abbreviated textual name for the address component, if available. For example, an address component for the country of Australia may have a short_name of "AU".

string

An array indicating the type(s) of the address component.

string

The language used to format this components, in CLDR notation.

string

Name of the Place's data provider.

string

URI to the Place's data provider.

string

The overview of the consumer alert message.

Details

The details of the consumer alert message.

string

The language code of the consumer alert message. This is a BCP 47 language code.

string

The title to show together with the description.

string

The description of the consumer alert message.

Link

The link to show together with the description to provide more information.

string

The title to show for the link.

string

The uri of the link.

string

The resource name of the place in which this place is located.

string

The place id of the place in which this place is located.

ContentBlock

An overview of the available amenities. This is guaranteed to be provided.

ContentBlock

A summary of the nearby coffee options.

ContentBlock

A summary of the nearby restaurants.

ContentBlock

A summary of the nearby stores.

string

A link where users can flag a problem with the summary.

LocalizedText

The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available.

LocalizedText

The overview of the place.

string

A link where users can flag a problem with the overview summary.

LocalizedText

The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available.

string

A link to show the directions to the place. The link only populates the destination location and uses the default travel mode DRIVE .

string

A link to show this place.

string

A link to write a review for this place on Google Maps.

string

A link to show reviews of this place on Google Maps.

string

A link to show photos of this place on Google Maps.

ContentBlock

An overview summary of the neighborhood.

ContentBlock

A detailed description of the neighborhood.

string

A link where users can flag a problem with the summary.

LocalizedText

The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available.

Period

The periods that this place is open during the week. The periods are in chronological order, in the place-local timezone. An empty (but not absent) value indicates a place that is never open, eg because it is closed temporarily for renovations.

The starting day of periods is NOT fixed and should not be assumed to be Sunday. The API determines the start day based on a variety of factors. For example, for a 24/7 business, the first period may begin on the day of the request. For other businesses, it might be the first day of the week that they are open.

NOTE: The ordering of the periods array is independent of the ordering of the weekday_descriptions array. Do not assume they will begin on the same day.

string

Localized strings describing the opening hours of this place, one string for each day of the week.

NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the periods array is independent of the ordering of the weekday_descriptions array. Do not assume they will begin on the same day.

Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00"

SecondaryHoursType

A type string used to identify the type of secondary hours.

SpecialDay

Structured information for special days that fall within the period that the returned opening hours cover. Special days are days that could impact the business hours of a place, eg Christmas day. Set for current_opening_hours and current_secondary_opening_hours if there are exceptional hours.

Timestamp

The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request.

Timestamp

The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request.

bool

Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active.

Point

The time that the place starts to be open.

Point

The time that the place starts to be closed.

Date

Date in the local timezone for the place.

bool

Whether or not this endpoint was truncated. Truncation occurs when the real hours are outside the times we are willing to return hours between, so we truncate the hours back to these boundaries. This ensures that at most 24 * 7 hours from midnight of the day of the request are returned.

int32

A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is Monday, etc.

int32

The hour in 24 hour format. Ranges from 0 to 23.

int32

The minute. Ranges from 0 to 59.

Date

The date of this special day.

bool

Place offers free parking lots.

bool

Place offers paid parking lots.

bool

Place offers free street parking.

bool

Place offers paid street parking.

bool

Place offers valet parking.

bool

Place offers free garage parking.

bool

Place offers paid garage parking.

bool

Place accepts credit cards as payment.

bool

Place accepts debit cards as payment.

bool

Place accepts cash only as payment. Places with this attribute may still accept other payment methods.

bool

Place accepts NFC payments.

string

Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).

string

Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.

LocalizedText

The summary of user reviews.

string

A link where users can flag a problem with the summary.

LocalizedText

The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available.

string

A link to show reviews of this place on Google Maps.

string

The resource name of the sub-destination.

string

The place id of the sub-destination.

string

An encoded polyline , as returned by the Routes API by default . See the encoder and decoder tools.

Money

The low end of the price range (inclusive). Price should be at or above this amount.

Money

The high end of the price range (exclusive). Price should be lower than this amount.

string

A reference representing this place review which may be used to look up this place review again (also called the API "resource" name: places/{place_id}/reviews/{review} ).

string

A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.

LocalizedText

The localized text of the review.

LocalizedText

The review text in its original language.

double

A number between 1.0 and 5.0, also called the number of stars.

AuthorAttribution

This review's author.

Timestamp

Timestamp for the review.

string

A link where users can flag a problem with the review.

string

A link to show the review on Google Maps.

Date

The date when the author visited the place. This is truncated to the year and month of the visit.

bool

Optional. When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER TravelMode .

bool

Optional. When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER TravelMode .

bool

Optional. When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the DRIVE and TWO_WHEELER TravelMode .

bool

Optional. When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the WALK TravelMode .

LatLng

Optional. An explicit routing origin that overrides the origin defined in the polyline. By default, the polyline origin is used.

TravelMode

Optional. The travel mode.

RouteModifiers

Optional. The route modifiers.

RoutingPreference

Optional. Specifies how to compute the routing summaries. The server attempts to use the selected routing preference to compute the route. The traffic aware routing preference is only available for the DRIVE or TWO_WHEELER travelMode .

Leg

The legs of the trip.

When you calculate travel duration and distance from a set origin, legs contains a single leg containing the duration and distance from the origin to the destination. When you do a search along route, legs contains two legs: one from the origin to place, and one from the place to the destination.

string

A link to show directions on Google Maps using the waypoints from the given routing summary. The route generated by this link is not guaranteed to be the same as the route used to generate the routing summary. The link uses information provided in the request, from fields including routingParameters and searchAlongRouteParameters when applicable, to generate the directions link.

Duration

The time it takes to complete this leg of the trip.

int32

The distance of this leg of the trip.

string

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport .

string

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law.

For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html .

Note that 3-digit region codes are not currently supported.

string

Included Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types .

Up to 50 types from Table A may be specified.

If there are any conflicting types, ie a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Excluded Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types .

Up to 50 types from Table A may be specified.

If the client provides both included_types (eg restaurant) and excluded_types (eg cafe), then the response should include places that are restaurant but not cafe. The response includes places that match at least one of the included_types and none of the excluded_types.

If there are any conflicting types, ie a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Included primary Place type (eg "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types . A place can only have a single primary type from the supported types table associated with it.

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, ie a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Excluded primary Place type (eg "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types .

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, ie a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

int32

Maximum number of results to return. It must be between 1 and 20 (default), inclusively. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.

LocationRestriction

Required. The region to search.

RankPreference

How results will be ranked in the response.

RoutingParameters

Optional. Parameters that affect the routing to the search results.

Circle

A circle defined by center point and radius.

Place

A list of places that meets user's requirements like places types, number of places and specific location restriction.

RoutingSummary

A list of routing summaries where each entry associates to the corresponding place in the same index in the places field. If the routing summary is not available for one of the places, it will contain an empty entry. This list should have as many entries as the list of places if requested.

string

Required. The text query for textual search.

string

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport .

string

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law.

For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html .

Note that 3-digit region codes are not currently supported.

RankPreference

How results will be ranked in the response.

string

The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types . Only support one included type.

bool

Used to restrict the search to places that are currently open. The default is false.

double

Filter out results whose average user rating is strictly less than this limit. A valid value must be a float between 0 and 5 (inclusively) at a 0.5 cadence ie [0, 0.5, 1.0, ... , 5.0] inclusively. The input rating will round up to the nearest 0.5(ceiling). For instance, a rating of 0.6 will eliminate all results with a less than 1.0 rating.

int32

Deprecated: Use page_size instead.

The maximum number of results per page that can be returned. If the number of available results is larger than max_result_count , a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be coerced to 20. Negative values will return an INVALID_ARGUMENT error.

If both max_result_count and page_size are specified, max_result_count will be ignored.

int32

Optional. The maximum number of results per page that can be returned. If the number of available results is larger than page_size , a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be set to 20. Negative values will return an INVALID_ARGUMENT error.

If both max_result_count and page_size are specified, max_result_count will be ignored.

string

Optional. A page token, received from a previous TextSearch call. Provide this to retrieve the subsequent page.

When paginating, all parameters other than page_token , page_size , and max_result_count provided to TextSearch must match the initial call that provided the page token. Otherwise an INVALID_ARGUMENT error is returned.

PriceLevel

Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels.

bool

Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false.

LocationBias

The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with location_restriction.

LocationRestriction

The region to search. This location serves as a restriction which means results outside given location will not be returned. Cannot be set along with location_bias.

EVOptions

Optional. Set the searchable EV options of a place search request.

RoutingParameters

Optional. Additional parameters for routing to results.

SearchAlongRouteParameters

Optional. Additional parameters proto for searching along a route.

bool

Optional. Include pure service area businesses if the field is set to true. Pure service area business is a business that visits or delivers to customers directly but does not serve customers at their business address. For example, businesses like cleaning services or plumbers. Those businesses do not have a physical address or location on Google Maps. Places will not return fields including location , plus_code , and other location related fields for these businesses.

double

Optional. Minimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out.

EVConnectorType

Optional. The list of preferred EV connector types. A place that does not support any of the listed connector types is filtered out.

Viewport

A rectangle box defined by northeast and southwest corner. rectangle.high() must be the northeast point of the rectangle viewport. rectangle.low() must be the southwest point of the rectangle viewport. rectangle.low().latitude() cannot be greater than rectangle.high().latitude() . This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees.

Circle

A circle defined by center point and radius.

Viewport

A rectangle box defined by northeast and southwest corner. rectangle.high() must be the northeast point of the rectangle viewport. rectangle.low() must be the southwest point of the rectangle viewport. rectangle.low().latitude() cannot be greater than rectangle.high().latitude() . This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees.

Polyline

Required. The route polyline.

Place

A list of places that meet the user's text search criteria.

RoutingSummary

A list of routing summaries where each entry associates to the corresponding place in the same index in the places field. If the routing summary is not available for one of the places, it will contain an empty entry. This list will have as many entries as the list of places if requested.

ContextualContent

Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.

A list of contextual contents where each entry associates to the corresponding place in the same index in the places field. The contents that are relevant to the text_query in the request are preferred. If the contextual content is not available for one of the places, it will return non-contextual content. It will be empty only when the content is unavailable for this place. This list will have as many entries as the list of places if requested.

string

A token that can be sent as page_token to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.

string

A link allows the user to search with the same text query as specified in the request on Google Maps.