Package google.maps.places.v1

Index

Places

Service definition for the Places API. Note: every request (except for Autocomplete requests) requires a field mask set outside of the request proto (all/*, is not assumed). The field mask can be set via the HTTP header X-Goog-FieldMask. See: https://developers.google.com/maps/documentation/places/web-service/choose-fields

AutocompletePlaces

rpc AutocompletePlaces(AutocompletePlacesRequest) returns (AutocompletePlacesResponse)

Returns predictions for the given input.

GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

Get a photo media with a photo reference string.

GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

Get the details of a place based on its resource name, which is a string in the places/{place_id} format.

SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

Search for places near locations.

SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

Text query based place search.

AuthorAttribution

Information about the author of the UGC data. Used in Photo, and Review.

Fields
display_name

string

Name of the author of the Photo or Review.

uri

string

URI of the author of the Photo or Review.

photo_uri

string

Profile photo URI of the author of the Photo or Review.

AutocompletePlacesRequest

Request proto for AutocompletePlaces.

Fields
input

string

Required. The text string on which to search.

location_bias

LocationBias

Optional. Bias results to a specified location.

At most one of location_bias or location_restriction should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.

location_restriction

LocationRestriction

Optional. Restrict results to a specified location.

At most one of location_bias or location_restriction should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.

included_primary_types[]

string

Optional. Included primary Place type (for example, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.

included_region_codes[]

string

Optional. Only include results in the specified regions, specified as up to 15 CLDR two-character region codes. An empty set will not restrict the results. If both location_restriction and included_region_codes are set, the results will be located in the area of intersection.

language_code

string

Optional. The language in which to return results. Defaults to en-US. The results may be in mixed languages if the language used in input is different from language_code or if the returned Place does not have a translation from the local language to language_code.

region_code

string

Optional. The region code, specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned. This does not restrict results to the specified region. To restrict results to a region, use region_code_restriction.

origin

LatLng

Optional. The origin point from which to calculate geodesic distance to the destination (returned as distance_meters). If this value is omitted, geodesic distance will not be returned.

input_offset

int32

Optional. A zero-based Unicode character offset of input indicating the cursor position in input. The cursor position may influence what predictions are returned.

If empty, defaults to the length of input.

include_query_predictions

bool

Optional. If true, the response will include both Place and query predictions. Otherwise the response will only return Place predictions.

session_token

string

Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned.

The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the session_token parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

We recommend the following guidelines:

  • Use session tokens for all Place Autocomplete calls.
  • Generate a fresh token for each session. Using a version 4 UUID is recommended.
  • Ensure that the credentials used for all Place Autocomplete, Place Details, and Address Validation requests within a session belong to the same Cloud Console project.
  • Be sure to pass a unique session token for each new session. Using the same token for more than one session will result in each request being billed individually.

LocationBias

The region to search. The results may be biased around the specified region.

Fields

Union field type.

type can be only one of the following:

rectangle

Viewport

A viewport defined by a northeast and a southwest corner.

circle

Circle

A circle defined by a center point and radius.

LocationRestriction

The region to search. The results will be restricted to the specified region.

Fields

Union field type.

type can be only one of the following:

rectangle

Viewport

A viewport defined by a northeast and a southwest corner.

circle

Circle

A circle defined by a center point and radius.

AutocompletePlacesResponse

Response proto for AutocompletePlaces.

Fields
suggestions[]

Suggestion

Contains a list of suggestions, ordered in descending order of relevance.

Suggestion

An Autocomplete suggestion result.

Fields

Union field kind.

kind can be only one of the following:

place_prediction

PlacePrediction

A prediction for a Place.

query_prediction

QueryPrediction

A prediction for a query.

FormattableText

Text representing a Place or query prediction. The text may be used as is or formatted.

Fields
text

string

Text that may be used as is or formatted with matches.

matches[]

StringRange

A list of string ranges identifying where the input request matched in text. The ranges can be used to format specific parts of text. The substrings may not be exact matches of input if the matching was determined by criteria other than string matching (for example, spell corrections or transliterations).

These values are Unicode character offsets of text. The ranges are guaranteed to be ordered in increasing offset values.

PlacePrediction

Prediction results for a Place Autocomplete prediction.

Fields
place

string

The resource name of the suggested Place. This name can be used in other APIs that accept Place names.

place_id

string

The unique identifier of the suggested Place. This identifier can be used in other APIs that accept Place IDs.

text

FormattableText

Contains the human-readable name for the returned result. For establishment results, this is usually the business name and address.

text is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use structured_format instead. They are two different ways to represent a Place prediction. Users should not try to parse structured_format into text or vice versa.

This text may be different from the display_name returned by GetPlace.

May be in mixed languages if the request input and language_code are in different languages or if the Place does not have a translation from the local language to language_code.

structured_format

StructuredFormat

A breakdown of the Place prediction into main text containing the name of the Place and secondary text containing additional disambiguating features (such as a city or region).

structured_format is recommended for developers who wish to show two separate, but related, UI elements. Developers who wish to show a single UI element may want to use text instead. They are two different ways to represent a Place prediction. Users should not try to parse structured_format into text or vice versa.

types[]

string

List of types that apply to this Place from Table A or Table B in https://developers.google.com/maps/documentation/places/web-service/place-types.

A type is a categorization of a Place. Places with shared types will share similar characteristics.

distance_meters

int32

The length of the geodesic in meters from origin if origin is specified. Certain predictions such as routes may not populate this field.

QueryPrediction

Prediction results for a Query Autocomplete prediction.

Fields
text

FormattableText

The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, Text Search).

text is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use structured_format instead. They are two different ways to represent a query prediction. Users should not try to parse structured_format into text or vice versa.

May be in mixed languages if the request input and language_code are in different languages or if part of the query does not have a translation from the local language to language_code.

structured_format

StructuredFormat

A breakdown of the query prediction into main text containing the query and secondary text containing additional disambiguating features (such as a city or region).

structured_format is recommended for developers who wish to show two separate, but related, UI elements. Developers who wish to show a single UI element may want to use text instead. They are two different ways to represent a query prediction. Users should not try to parse structured_format into text or vice versa.

StringRange

Identifies a substring within a given text.

Fields
start_offset

int32

Zero-based offset of the first Unicode character of the string (inclusive).

end_offset

int32

Zero-based offset of the last Unicode character (exclusive).

StructuredFormat

Contains a breakdown of a Place or query prediction into main text and secondary text.

For Place predictions, the main text contains the specific name of the Place. For query predictions, the main text contains the query.

The secondary text contains additional disambiguating features (such as a city or region) to further identify the Place or refine the query.

Fields
main_text

FormattableText

Represents the name of the Place or query.

secondary_text

FormattableText

Represents additional disambiguating features (such as a city or region) to further identify the Place or refine the query.

Circle

Circle with a LatLng as center and radius.

Fields
center

LatLng

Required. Center latitude and longitude.

The range of latitude must be within [-90.0, 90.0]. The range of the longitude must be within [-180.0, 180.0].

radius

double

Required. Radius measured in meters. The radius must be within [0.0, 50000.0].

EVChargeOptions

Information about the EV Charge Station hosted in Place. Terminology follows https://afdc.energy.gov/fuels/electricity_infrastructure.html One port could charge one car at a time. One port has one or more connectors. One station has one or more ports.

Fields
connector_count

int32

Number of connectors at this station. However, because some ports can have multiple connectors but only be able to charge one car at a time (e.g.) the number of connectors may be greater than the total number of cars which can charge simultaneously.

connector_aggregation[]

ConnectorAggregation

A list of EV charging connector aggregations that contain connectors of the same type and same charge rate.

ConnectorAggregation

EV charging information grouped by [type, max_charge_rate_kw]. Shows EV charge aggregation of connectors that have the same type and max charge rate in kw.

Fields
type

EVConnectorType

The connector type of this aggregation.

max_charge_rate_kw

double

The static max charging rate in kw of each connector in the aggregation.

count

int32

Number of connectors in this aggregation.

availability_last_update_time

Timestamp

The timestamp when the connector availability information in this aggregation was last updated.

available_count

int32

Number of connectors in this aggregation that are currently available.

out_of_service_count

int32

Number of connectors in this aggregation that are currently out of service.

EVConnectorType

See http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=6872107 for additional information/context on EV charging connector types.

Enums
EV_CONNECTOR_TYPE_UNSPECIFIED Unspecified connector.
EV_CONNECTOR_TYPE_OTHER Other connector types.
EV_CONNECTOR_TYPE_J1772 J1772 type 1 connector.
EV_CONNECTOR_TYPE_TYPE_2 IEC 62196 type 2 connector. Often referred to as MENNEKES.
EV_CONNECTOR_TYPE_CHADEMO CHAdeMO type connector.
EV_CONNECTOR_TYPE_CCS_COMBO_1 Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 connector
EV_CONNECTOR_TYPE_CCS_COMBO_2 Combined Charging System (AC and DC). Based on Type-2 Mennekes connector
EV_CONNECTOR_TYPE_TESLA The generic TESLA connector. This is NACS in the North America but can be non-NACS in other parts of the world (e.g. CCS Combo 2 (CCS2) or GB/T). This value is less representative of an actual connector type, and more represents the ability to charge a Tesla brand vehicle at a Tesla owned charging station.
EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types.
EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET Unspecified wall outlet.

FuelOptions

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

Fields
fuel_prices[]

FuelPrice

The last known fuel price for each type of fuel this station has. There is one entry per fuel type this station has. Order is not important.

FuelPrice

Fuel price information for a given type.

Fields
type

FuelType

The type of fuel.

price

Money

The price of the fuel.

update_time

Timestamp

The time the fuel price was last updated.

FuelType

Types of fuel.

Enums
FUEL_TYPE_UNSPECIFIED Unspecified fuel type.
DIESEL Diesel fuel.
REGULAR_UNLEADED Regular unleaded.
MIDGRADE Midgrade.
PREMIUM Premium.
SP91 SP 91.
SP91_E10 SP 91 E10.
SP92 SP 92.
SP95 SP 95.
SP95_E10 SP95 E10.
SP98 SP 98.
SP99 SP 99.
SP100 SP 100.
LPG LPG.
E80 E 80.
E85 E 85.
METHANE Methane.
BIO_DIESEL Bio-diesel.
TRUCK_DIESEL Truck diesel.

GetPhotoMediaRequest

Request for fetching a photo of a place using a photo resource name.

Fields
name

string

Required. The resource name of a photo media in the format: places/{place_id}/photos/{photo_reference}/media.

The resource name of a photo as returned in a Place object's photos.name field comes with the format places/{place_id}/photos/{photo_reference}. You need to append /media at the end of the photo resource to get the photo media resource name.

max_width_px

int32

Optional. Specifies the maximum desired width, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned.

At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.

max_height_px

int32

Optional. Specifies the maximum desired height, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned.

At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.

skip_http_redirect

bool

Optional. If set, skip the default HTTP redirect behavior and render a text format (for example, in JSON format for HTTP use case) response. If not set, an HTTP redirect will be issued to redirect the call to the image media. This option is ignored for non-HTTP requests.

GetPlaceRequest

Request for fetching a Place based on its resource name, which is a string in the places/{place_id} format.

Fields
name

string

Required. The resource name of a place, in the places/{place_id} format.

language_code

string

Optional. Place details will be displayed with the preferred language if available.

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

region_code

string

Optional. 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.

session_token

string

Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned.

The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the session_token parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

We recommend the following guidelines:

  • Use session tokens for all Place Autocomplete calls.
  • Generate a fresh token for each session. Using a version 4 UUID is recommended.
  • Ensure that the credentials used for all Place Autocomplete, Place Details, and Address Validation requests within a session belong to the same Cloud Console project.
  • Be sure to pass a unique session token for each new session. Using the same token for more than one session will result in each request being billed individually.

Photo

Information about a photo of a place.

Fields
name

string

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

width_px

int32

The maximum available width, in pixels.

height_px

int32

The maximum available height, in pixels.

author_attributions[]

AuthorAttribution

This photo's authors.

PhotoMedia

A photo media from Places API.

Fields
name

string

The resource name of a photo media in the format: places/{place_id}/photos/{photo_reference}/media.

photo_uri

string

A short-lived uri that can be used to render the photo.

Place

All the information representing a Place.

Fields
name

string

This Place's resource name, in places/{place_id} format. Can be used to look up the Place.

id

string

The unique identifier of a place.

display_name

LocalizedText

The localized name of the place, suitable as a short human-readable description. For example, "Google Sydney", "Starbucks", "Pyrmont", etc.

types[]

string

A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types

primary_type

string

The primary type of the given result. This type must one of the Places API supported types. For example, "restaurant", "cafe", "airport", etc. A place can only have a single primary type. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types

primary_type_display_name

LocalizedText

The display name of the primary type, localized to the request language if applicable. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types

national_phone_number

string

A human-readable phone number for the place, in national format.

international_phone_number

string

A human-readable phone number for the place, in international format.

formatted_address

string

A full, human-readable address for this place.

short_formatted_address

string

A short, human-readable address for this place.

address_components[]

AddressComponent

Repeated components for each locality level. Note the following facts about the address_components[] array: - The array of address components may contain more components than the formatted_address. - The array does not necessarily include all the political entities that contain an address, apart from those included in the formatted_address. To retrieve all the political entities that contain a specific address, you should use reverse geocoding, passing the latitude/longitude of the address as a parameter to the request. - The format of the response is not guaranteed to remain the same between requests. In particular, the number of address_components varies based on the address requested and can change over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response.

plus_code

PlusCode

Plus code of the place location lat/long.

location

LatLng

The position of this place.

viewport

Viewport

A viewport suitable for displaying the place on an average-sized map.

rating

double

A rating between 1.0 and 5.0, based on user reviews of this place.

google_maps_uri

string

A URL providing more information about this place.

website_uri

string

The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain.

reviews[]

Review

List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned.

regular_opening_hours

OpeningHours

The regular hours of operation.

photos[]

Photo

Information (including references) about photos of this place. A maximum of 10 photos can be returned.

adr_format_address

string

The place's address in adr microformat: http://microformats.org/wiki/adr.

business_status

BusinessStatus

The business status for the place.

price_level

PriceLevel

Price level of the place.

attributions[]

Attribution

A set of data provider that must be shown with this result.

icon_mask_base_uri

string

A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").

icon_background_color

string

Background color for icon_mask in hex format, e.g. #909CE1.

current_opening_hours

OpeningHours

The hours of operation for the next seven days (including today). The time period starts at midnight on the date of the request and ends at 11:59 pm six days later. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.

current_secondary_opening_hours[]

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.

regular_secondary_opening_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.

editorial_summary

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.

payment_options

PaymentOptions

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

parking_options

ParkingOptions

Options of parking provided by the place.

sub_destinations[]

SubDestination

A list of sub destinations related to the place.

fuel_options

FuelOptions

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

ev_charge_options

EVChargeOptions

Information of ev charging options.

utc_offset_minutes

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, e.g. X hours and 15 minutes.

user_rating_count

int32

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

takeout

bool

Specifies if the business supports takeout.

delivery

bool

Specifies if the business supports delivery.

dine_in

bool

Specifies if the business supports indoor or outdoor seating options.

curbside_pickup

bool

Specifies if the business supports curbside pickup.

reservable

bool

Specifies if the place supports reservations.

serves_breakfast

bool

Specifies if the place serves breakfast.

serves_lunch

bool

Specifies if the place serves lunch.

serves_dinner

bool

Specifies if the place serves dinner.

serves_beer

bool

Specifies if the place serves beer.

serves_wine

bool

Specifies if the place serves wine.

serves_brunch

bool

Specifies if the place serves brunch.

serves_vegetarian_food

bool

Specifies if the place serves vegetarian food.

outdoor_seating

bool

Place provides outdoor seating.

live_music

bool

Place provides live music.

menu_for_children

bool

Place has a children's menu.

serves_cocktails

bool

Place serves cocktails.

serves_dessert

bool

Place serves dessert.

serves_coffee

bool

Place serves coffee.

good_for_children

bool

Place is good for children.

allows_dogs

bool

Place allows dogs.

restroom

bool

Place has restroom.

good_for_groups

bool

Place accommodates groups.

good_for_watching_sports

bool

Place is suitable for watching sports.

accessibility_options

AccessibilityOptions

Information about the accessibility options a place offers.

AccessibilityOptions

Information about the accessibility options a place offers.

Fields
wheelchair_accessible_parking

bool

Place offers wheelchair accessible parking.

wheelchair_accessible_entrance

bool

Places has wheelchair accessible entrance.

wheelchair_accessible_restroom

bool

Place has wheelchair accessible restroom.

wheelchair_accessible_seating

bool

Place has wheelchair accessible seating.

AddressComponent

The structured components that form the formatted address, if this information is available.

Fields
long_text

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".

short_text

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".

types[]

string

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

language_code

string

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

Attribution

Information about data providers of this place.

Fields
provider

string

Name of the Place's data provider.

provider_uri

string

URI to the Place's data provider.

BusinessStatus

Business status for the place.

Enums
BUSINESS_STATUS_UNSPECIFIED Default value. This value is unused.
OPERATIONAL The establishment is operational, not necessarily open now.
CLOSED_TEMPORARILY The establishment is temporarily closed.
CLOSED_PERMANENTLY The establishment is permanently closed.

OpeningHours

Information about business hour of the place.

Fields
periods[]

Period

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

weekday_descriptions[]

string

Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00"

secondary_hours_type

SecondaryHoursType

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

special_days[]

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, e.g. Christmas day. Set for current_opening_hours and current_secondary_opening_hours if there are exceptional hours.

open_now

bool

Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours.

Period

A period the place remains in open_now status.

Fields
open

Point

The time that the place starts to be open.

close

Point

The time that the place starts to be closed.

Point

Status changing points.

Fields
date

Date

Date in the local timezone for the place.

truncated

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.

day

int32

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

hour

int32

The hour in 2 digits. Ranges from 00 to 23.

minute

int32

The minute in 2 digits. Ranges from 00 to 59.

SecondaryHoursType

A type used to identify the type of secondary hours.

Enums
SECONDARY_HOURS_TYPE_UNSPECIFIED Default value when secondary hour type is not specified.
DRIVE_THROUGH The drive-through hour for banks, restaurants, or pharmacies.
HAPPY_HOUR The happy hour.
DELIVERY The delivery hour.
TAKEOUT The takeout hour.
KITCHEN The kitchen hour.
BREAKFAST The breakfast hour.
LUNCH The lunch hour.
DINNER The dinner hour.
BRUNCH The brunch hour.
PICKUP The pickup hour.
ACCESS The access hours for storage places.
SENIOR_HOURS The special hours for seniors.
ONLINE_SERVICE_HOURS The online service 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, e.g. Christmas day.

Fields
date

Date

The date of this special day.

ParkingOptions

Information about parking options for the place. A parking lot could support more than one option at the same time.

Fields
free_parking_lot

bool

Place offers free parking lots.

paid_parking_lot

bool

Place offers paid parking lots.

free_street_parking

bool

Place offers free street parking.

paid_street_parking

bool

Place offers paid street parking.

valet_parking

bool

Place offers valet parking.

free_garage_parking

bool

Place offers free garage parking.

paid_garage_parking

bool

Place offers paid garage parking.

PaymentOptions

Payment options the place accepts.

Fields
accepts_credit_cards

bool

Place accepts credit cards as payment.

accepts_debit_cards

bool

Place accepts debit cards as payment.

accepts_cash_only

bool

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

accepts_nfc

bool

Place accepts NFC payments.

PlusCode

Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location.

Fields
global_code

string

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

compound_code

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.

SubDestination

Place resource name and id of sub destinations that relate to the place. For example, different terminals are different destinations of an airport.

Fields
name

string

The resource name of the sub destination.

id

string

The place id of the sub destination.

PriceLevel

Price level of the place.

Enums
PRICE_LEVEL_UNSPECIFIED Place price level is unspecified or unknown.
PRICE_LEVEL_FREE Place provides free services.
PRICE_LEVEL_INEXPENSIVE Place provides inexpensive services.
PRICE_LEVEL_MODERATE Place provides moderately priced services.
PRICE_LEVEL_EXPENSIVE Place provides expensive services.
PRICE_LEVEL_VERY_EXPENSIVE Place provides very expensive services.

Review

Information about a review of a place.

Fields
name

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}).

relative_publish_time_description

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.

text

LocalizedText

The localized text of the review.

original_text

LocalizedText

The review text in its original language.

rating

double

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

author_attribution

AuthorAttribution

This review's author.

publish_time

Timestamp

Timestamp for the review.

SearchNearbyRequest

Request proto for Search Nearby.

Fields
language_code

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.

region_code

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.

included_types[]

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, i.e. 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".

excluded_types[]

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 (e.g. restaurant) and excluded_types (e.g. 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, i.e. 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".

included_primary_types[]

string

Included primary Place type (e.g. "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, i.e. 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".

excluded_primary_types[]

string

Excluded primary Place type (e.g. "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, i.e. 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".

max_result_count

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.

location_restriction

LocationRestriction

Required. The region to search.

rank_preference

RankPreference

How results will be ranked in the response.

LocationRestriction

The region to search.

Fields

Union field type.

type can be only one of the following:

circle

Circle

A circle defined by center point and radius.

RankPreference

How results will be ranked in the response.

Enums
RANK_PREFERENCE_UNSPECIFIED RankPreference value not set. Will use rank by POPULARITY by default.
DISTANCE Ranks results by distance.
POPULARITY Ranks results by popularity.

SearchNearbyResponse

Response proto for Search Nearby.

Fields
places[]

Place

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

SearchTextRequest

Request proto for SearchText.

Fields
text_query

string

Required. The text query for textual search.

language_code

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.

region_code

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.

rank_preference

RankPreference

How results will be ranked in the response.

included_type

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.

open_now

bool

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

min_rating

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 i.e. [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.

max_result_count

int32

Maximum number of results to return. It must be between 1 and 20, inclusively. The default is 20. 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.

price_levels[]

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.

strict_type_filtering

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.

location_bias

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.

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.

ev_options

EVOptions

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

EVOptions

Searchable EV options of a place search request.

Fields
minimum_charging_rate_kw

double

Optional. Filtering places by minimum charging rate. Any places with charging a rate less than the minimum charging rate are filtered out.

connector_types[]

EVConnectorType

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

LocationBias

The region to search. This location serves as a bias which means results around given location might be returned.

Fields

Union field type.

type can be only one of the following:

rectangle

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

Circle

A circle defined by center point and radius.

LocationRestriction

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

Fields

Union field type.

type can be only one of the following:

rectangle

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.

RankPreference

How results will be ranked in the response.

Enums
RANK_PREFERENCE_UNSPECIFIED RankPreference value not set. Will default to DISTANCE.
DISTANCE Ranks results by distance.
RELEVANCE Ranks results by relevance. Sort order determined by normal ranking stack.

SearchTextResponse

Response proto for SearchText.

Fields
places[]

Place

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