googleapis
Version:
Google APIs Client Library for Node.js
985 lines • 127 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace places_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Places API (New)
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const places = google.places('v1');
* ```
*/
export class Places {
context: APIRequestContext;
places: Resource$Places;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` \> `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` \> `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 \}, "high": { "latitude": 40.91618, "longitude": -73.70018 \} \}
*/
export interface Schema$GoogleGeoTypeViewport {
/**
* Required. The high point of the viewport.
*/
high?: Schema$GoogleTypeLatLng;
/**
* Required. The low point of the viewport.
*/
low?: Schema$GoogleTypeLatLng;
}
/**
* A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location.
*/
export interface Schema$GoogleMapsPlacesV1AddressDescriptor {
/**
* A ranked list of containing or adjacent areas. The most recognizable and precise areas are ranked first.
*/
areas?: Schema$GoogleMapsPlacesV1AddressDescriptorArea[];
/**
* A ranked list of nearby landmarks. The most recognizable and nearby landmarks are ranked first.
*/
landmarks?: Schema$GoogleMapsPlacesV1AddressDescriptorLandmark[];
}
/**
* Area information and the area's relationship with the target location. Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location.
*/
export interface Schema$GoogleMapsPlacesV1AddressDescriptorArea {
/**
* Defines the spatial relationship between the target location and the area.
*/
containment?: string | null;
/**
* The area's display name.
*/
displayName?: Schema$GoogleTypeLocalizedText;
/**
* The area's resource name.
*/
name?: string | null;
/**
* The area's place id.
*/
placeId?: string | null;
}
/**
* Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location.
*/
export interface Schema$GoogleMapsPlacesV1AddressDescriptorLandmark {
/**
* The landmark's display name.
*/
displayName?: Schema$GoogleTypeLocalizedText;
/**
* The landmark's resource name.
*/
name?: string | null;
/**
* The landmark's place id.
*/
placeId?: string | null;
/**
* Defines the spatial relationship between the target location and the landmark.
*/
spatialRelationship?: string | null;
/**
* The straight line distance, in meters, between the center point of the target and the center point of the landmark. In some situations, this value can be longer than `travel_distance_meters`.
*/
straightLineDistanceMeters?: number | null;
/**
* The travel distance, in meters, along the road network from the target to the landmark, if known. This value does not take into account the mode of transportation, such as walking, driving, or biking.
*/
travelDistanceMeters?: number | null;
/**
* A set of type tags for this landmark. For a complete list of possible values, see https://developers.google.com/maps/documentation/places/web-service/place-types.
*/
types?: string[] | null;
}
/**
* Information about the author of the UGC data. Used in Photo, and Review.
*/
export interface Schema$GoogleMapsPlacesV1AuthorAttribution {
/**
* Name of the author of the Photo or Review.
*/
displayName?: string | null;
/**
* Profile photo URI of the author of the Photo or Review.
*/
photoUri?: string | null;
/**
* URI of the author of the Photo or Review.
*/
uri?: string | null;
}
/**
* Request proto for AutocompletePlaces.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesRequest {
/**
* Optional. Included primary Place type (for example, "restaurant" or "gas_station") in Place Types (https://developers.google.com/maps/documentation/places/web-service/place-types), or only `(regions)`, or only `(cities)`. 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.
*/
includedPrimaryTypes?: string[] | null;
/**
* 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.
*/
includedRegionCodes?: string[] | null;
/**
* 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.
*/
includePureServiceAreaBusinesses?: boolean | null;
/**
* Optional. If true, the response will include both Place and query predictions. Otherwise the response will only return Place predictions.
*/
includeQueryPredictions?: boolean | null;
/**
* Required. The text string on which to search.
*/
input?: string | null;
/**
* 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`.
*/
inputOffset?: number | null;
/**
* 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`.
*/
languageCode?: string | null;
/**
* 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.
*/
locationBias?: Schema$GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias;
/**
* 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.
*/
locationRestriction?: Schema$GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction;
/**
* 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.
*/
origin?: Schema$GoogleTypeLatLng;
/**
* 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`.
*/
regionCode?: string | null;
/**
* 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.
*/
sessionToken?: string | null;
}
/**
* The region to search. The results may be biased around the specified region.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias {
/**
* A circle defined by a center point and radius.
*/
circle?: Schema$GoogleMapsPlacesV1Circle;
/**
* A viewport defined by a northeast and a southwest corner.
*/
rectangle?: Schema$GoogleGeoTypeViewport;
}
/**
* The region to search. The results will be restricted to the specified region.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction {
/**
* A circle defined by a center point and radius.
*/
circle?: Schema$GoogleMapsPlacesV1Circle;
/**
* A viewport defined by a northeast and a southwest corner.
*/
rectangle?: Schema$GoogleGeoTypeViewport;
}
/**
* Response proto for AutocompletePlaces.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponse {
/**
* Contains a list of suggestions, ordered in descending order of relevance.
*/
suggestions?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion[];
}
/**
* An Autocomplete suggestion result.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion {
/**
* A prediction for a Place.
*/
placePrediction?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction;
/**
* A prediction for a query.
*/
queryPrediction?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction;
}
/**
* Text representing a Place or query prediction. The text may be used as is or formatted.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText {
/**
* 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.
*/
matches?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange[];
/**
* Text that may be used as is or formatted with `matches`.
*/
text?: string | null;
}
/**
* Prediction results for a Place Autocomplete prediction.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction {
/**
* The length of the geodesic in meters from `origin` if `origin` is specified. Certain predictions such as routes may not populate this field.
*/
distanceMeters?: number | null;
/**
* The resource name of the suggested Place. This name can be used in other APIs that accept Place names.
*/
place?: string | null;
/**
* The unique identifier of the suggested Place. This identifier can be used in other APIs that accept Place IDs.
*/
placeId?: string | null;
/**
* 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.
*/
structuredFormat?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat;
/**
* 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`.
*/
text?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText;
/**
* 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.
*/
types?: string[] | null;
}
/**
* Prediction results for a Query Autocomplete prediction.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction {
/**
* 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.
*/
structuredFormat?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat;
/**
* 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`.
*/
text?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText;
}
/**
* Identifies a substring within a given text.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange {
/**
* Zero-based offset of the last Unicode character (exclusive).
*/
endOffset?: number | null;
/**
* Zero-based offset of the first Unicode character of the string (inclusive).
*/
startOffset?: number | null;
}
/**
* 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.
*/
export interface Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat {
/**
* Represents the name of the Place or query.
*/
mainText?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText;
/**
* Represents additional disambiguating features (such as a city or region) to further identify the Place or refine the query.
*/
secondaryText?: Schema$GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText;
}
/**
* Circle with a LatLng as center and radius.
*/
export interface Schema$GoogleMapsPlacesV1Circle {
/**
* 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].
*/
center?: Schema$GoogleTypeLatLng;
/**
* Required. Radius measured in meters. The radius must be within [0.0, 50000.0].
*/
radius?: number | null;
}
/**
* A block of content that can be served individually.
*/
export interface Schema$GoogleMapsPlacesV1ContentBlock {
/**
* Content related to the topic.
*/
content?: Schema$GoogleTypeLocalizedText;
/**
* The list of resource names of the referenced places. This name can be used in other APIs that accept Place resource names.
*/
referencedPlaces?: string[] | null;
}
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Content that is contextual to the place query.
*/
export interface Schema$GoogleMapsPlacesV1ContextualContent {
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place.
*/
justifications?: Schema$GoogleMapsPlacesV1ContextualContentJustification[];
/**
* Information (including references) about photos of this place, contextual to the place query.
*/
photos?: Schema$GoogleMapsPlacesV1Photo[];
/**
* List of reviews about this place, contextual to the place query.
*/
reviews?: Schema$GoogleMapsPlacesV1Review[];
}
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place. Justifications answers the question of why a place could interest an end user.
*/
export interface Schema$GoogleMapsPlacesV1ContextualContentJustification {
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.
*/
businessAvailabilityAttributesJustification?: Schema$GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification;
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.
*/
reviewJustification?: Schema$GoogleMapsPlacesV1ContextualContentJustificationReviewJustification;
}
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user.
*/
export interface Schema$GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification {
/**
* If a place provides delivery.
*/
delivery?: boolean | null;
/**
* If a place provides dine-in.
*/
dineIn?: boolean | null;
/**
* If a place provides takeout.
*/
takeout?: boolean | null;
}
/**
* Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. User review justifications. This highlights a section of the user review that would interest an end user. For instance, if the search query is "firewood pizza", the review justification highlights the text relevant to the search query.
*/
export interface Schema$GoogleMapsPlacesV1ContextualContentJustificationReviewJustification {
highlightedText?: Schema$GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText;
/**
* The review that the highlighted text is generated from.
*/
review?: Schema$GoogleMapsPlacesV1Review;
}
/**
* The text highlighted by the justification. This is a subset of the review itself. The exact word to highlight is marked by the HighlightedTextRange. There could be several words in the text being highlighted.
*/
export interface Schema$GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText {
/**
* The list of the ranges of the highlighted text.
*/
highlightedTextRanges?: Schema$GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange[];
text?: string | null;
}
/**
* The range of highlighted text.
*/
export interface Schema$GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange {
endIndex?: number | null;
startIndex?: number | null;
}
/**
* 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.
*/
export interface Schema$GoogleMapsPlacesV1EVChargeOptions {
/**
* A list of EV charging connector aggregations that contain connectors of the same type and same charge rate.
*/
connectorAggregation?: Schema$GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation[];
/**
* 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.
*/
connectorCount?: number | null;
}
/**
* 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.
*/
export interface Schema$GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation {
/**
* The timestamp when the connector availability information in this aggregation was last updated.
*/
availabilityLastUpdateTime?: string | null;
/**
* Number of connectors in this aggregation that are currently available.
*/
availableCount?: number | null;
/**
* Number of connectors in this aggregation.
*/
count?: number | null;
/**
* The static max charging rate in kw of each connector in the aggregation.
*/
maxChargeRateKw?: number | null;
/**
* Number of connectors in this aggregation that are currently out of service.
*/
outOfServiceCount?: number | null;
/**
* The connector type of this aggregation.
*/
type?: string | null;
}
/**
* The most recent information about fuel options in a gas station. This information is updated regularly.
*/
export interface Schema$GoogleMapsPlacesV1FuelOptions {
/**
* 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.
*/
fuelPrices?: Schema$GoogleMapsPlacesV1FuelOptionsFuelPrice[];
}
/**
* Fuel price information for a given type.
*/
export interface Schema$GoogleMapsPlacesV1FuelOptionsFuelPrice {
/**
* The price of the fuel.
*/
price?: Schema$GoogleTypeMoney;
/**
* The type of fuel.
*/
type?: string | null;
/**
* The time the fuel price was last updated.
*/
updateTime?: string | null;
}
/**
* Information about a photo of a place.
*/
export interface Schema$GoogleMapsPlacesV1Photo {
/**
* This photo's authors.
*/
authorAttributions?: Schema$GoogleMapsPlacesV1AuthorAttribution[];
/**
* A link where users can flag a problem with the photo.
*/
flagContentUri?: string | null;
/**
* A link to show the photo on Google Maps.
*/
googleMapsUri?: string | null;
/**
* The maximum available height, in pixels.
*/
heightPx?: number | null;
/**
* 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\}`).
*/
name?: string | null;
/**
* The maximum available width, in pixels.
*/
widthPx?: number | null;
}
/**
* A photo media from Places API.
*/
export interface Schema$GoogleMapsPlacesV1PhotoMedia {
/**
* The resource name of a photo media in the format: `places/{place_id\}/photos/{photo_reference\}/media`.
*/
name?: string | null;
/**
* A short-lived uri that can be used to render the photo.
*/
photoUri?: string | null;
}
/**
* All the information representing a Place.
*/
export interface Schema$GoogleMapsPlacesV1Place {
/**
* Information about the accessibility options a place offers.
*/
accessibilityOptions?: Schema$GoogleMapsPlacesV1PlaceAccessibilityOptions;
/**
* 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.
*/
addressComponents?: Schema$GoogleMapsPlacesV1PlaceAddressComponent[];
/**
* 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.
*/
addressDescriptor?: Schema$GoogleMapsPlacesV1AddressDescriptor;
/**
* The place's address in adr microformat: http://microformats.org/wiki/adr.
*/
adrFormatAddress?: string | null;
/**
* Place allows dogs.
*/
allowsDogs?: boolean | null;
/**
* A set of data provider that must be shown with this result.
*/
attributions?: Schema$GoogleMapsPlacesV1PlaceAttribution[];
/**
* The business status for the place.
*/
businessStatus?: string | null;
/**
* The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies.
*/
consumerAlert?: Schema$GoogleMapsPlacesV1PlaceConsumerAlert;
/**
* List of places in which the current place is located.
*/
containingPlaces?: Schema$GoogleMapsPlacesV1PlaceContainingPlace[];
/**
* Specifies if the business supports curbside pickup.
*/
curbsidePickup?: boolean | null;
/**
* 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.
*/
currentOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours;
/**
* 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.
*/
currentSecondaryOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours[];
/**
* Specifies if the business supports delivery.
*/
delivery?: boolean | null;
/**
* Specifies if the business supports indoor or outdoor seating options.
*/
dineIn?: boolean | null;
/**
* The localized name of the place, suitable as a short human-readable description. For example, "Google Sydney", "Starbucks", "Pyrmont", etc.
*/
displayName?: Schema$GoogleTypeLocalizedText;
/**
* 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.
*/
editorialSummary?: Schema$GoogleTypeLocalizedText;
/**
* The summary of amenities near the EV charging station.
*/
evChargeAmenitySummary?: Schema$GoogleMapsPlacesV1PlaceEvChargeAmenitySummary;
/**
* Information of ev charging options.
*/
evChargeOptions?: Schema$GoogleMapsPlacesV1EVChargeOptions;
/**
* A full, human-readable address for this place.
*/
formattedAddress?: string | null;
/**
* The most recent information about fuel options in a gas station. This information is updated regularly.
*/
fuelOptions?: Schema$GoogleMapsPlacesV1FuelOptions;
/**
* AI-generated summary of the place.
*/
generativeSummary?: Schema$GoogleMapsPlacesV1PlaceGenerativeSummary;
/**
* Place is good for children.
*/
goodForChildren?: boolean | null;
/**
* Place accommodates groups.
*/
goodForGroups?: boolean | null;
/**
* Place is suitable for watching sports.
*/
goodForWatchingSports?: boolean | null;
/**
* Links to trigger different Google Maps actions.
*/
googleMapsLinks?: Schema$GoogleMapsPlacesV1PlaceGoogleMapsLinks;
/**
* A URL providing more information about this place.
*/
googleMapsUri?: string | null;
/**
* Background color for icon_mask in hex format, e.g. #909CE1.
*/
iconBackgroundColor?: string | null;
/**
* A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").
*/
iconMaskBaseUri?: string | null;
/**
* The unique identifier of a place.
*/
id?: string | null;
/**
* A human-readable phone number for the place, in international format.
*/
internationalPhoneNumber?: string | null;
/**
* Place provides live music.
*/
liveMusic?: boolean | null;
/**
* The position of this place.
*/
location?: Schema$GoogleTypeLatLng;
/**
* Place has a children's menu.
*/
menuForChildren?: boolean | null;
/**
* 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.
*/
movedPlace?: string | null;
/**
* 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.
*/
movedPlaceId?: string | null;
/**
* This Place's resource name, in `places/{place_id\}` format. Can be used to look up the Place.
*/
name?: string | null;
/**
* A human-readable phone number for the place, in national format.
*/
nationalPhoneNumber?: string | null;
/**
* A summary of points of interest near the place.
*/
neighborhoodSummary?: Schema$GoogleMapsPlacesV1PlaceNeighborhoodSummary;
/**
* Place provides outdoor seating.
*/
outdoorSeating?: boolean | null;
/**
* Options of parking provided by the place.
*/
parkingOptions?: Schema$GoogleMapsPlacesV1PlaceParkingOptions;
/**
* Payment options the place accepts. If a payment option data is not available, the payment option field will be unset.
*/
paymentOptions?: Schema$GoogleMapsPlacesV1PlacePaymentOptions;
/**
* Information (including references) about photos of this place. A maximum of 10 photos can be returned.
*/
photos?: Schema$GoogleMapsPlacesV1Photo[];
/**
* Plus code of the place location lat/long.
*/
plusCode?: Schema$GoogleMapsPlacesV1PlacePlusCode;
/**
* The address in postal address format.
*/
postalAddress?: Schema$GoogleTypePostalAddress;
/**
* Price level of the place.
*/
priceLevel?: string | null;
/**
* The price range associated with a Place.
*/
priceRange?: Schema$GoogleMapsPlacesV1PriceRange;
/**
* The primary type of the given result. This type must be 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. The primary type may be missing if the place's primary type is not a supported type. When a primary type is present, it is always one of the types in the `types` field.
*/
primaryType?: string | null;
/**
* 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. The primary type may be missing if the place's primary type is not a supported type.
*/
primaryTypeDisplayName?: Schema$GoogleTypeLocalizedText;
/**
* 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.
*/
pureServiceAreaBusiness?: boolean | null;
/**
* A rating between 1.0 and 5.0, based on user reviews of this place.
*/
rating?: number | null;
/**
* The regular hours of operation. Note that if a place is always open (24 hours), the `close` field will not be set. Clients can rely on always open (24 hours) being represented as an [`open`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Period) period containing [`day`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`, [`hour`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`, and [`minute`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`.
*/
regularOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours;
/**
* 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.
*/
regularSecondaryOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours[];
/**
* Specifies if the place supports reservations.
*/
reservable?: boolean | null;
/**
* Place has restroom.
*/
restroom?: boolean | null;
/**
* List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned.
*/
reviews?: Schema$GoogleMapsPlacesV1Review[];
/**
* AI-generated summary of the place using user reviews.
*/
reviewSummary?: Schema$GoogleMapsPlacesV1PlaceReviewSummary;
/**
* Specifies if the place serves beer.
*/
servesBeer?: boolean | null;
/**
* Specifies if the place serves breakfast.
*/
servesBreakfast?: boolean | null;
/**
* Specifies if the place serves brunch.
*/
servesBrunch?: boolean | null;
/**
* Place serves cocktails.
*/
servesCocktails?: boolean | null;
/**
* Place serves coffee.
*/
servesCoffee?: boolean | null;
/**
* Place serves dessert.
*/
servesDessert?: boolean | null;
/**
* Specifies if the place serves dinner.
*/
servesDinner?: boolean | null;
/**
* Specifies if the place serves lunch.
*/
servesLunch?: boolean | null;
/**
* Specifies if the place serves vegetarian food.
*/
servesVegetarianFood?: boolean | null;
/**
* Specifies if the place serves wine.
*/
servesWine?: boolean | null;
/**
* A short, human-readable address for this place.
*/
shortFormattedAddress?: string | null;
/**
* A list of sub-destinations related to the place.
*/
subDestinations?: Schema$GoogleMapsPlacesV1PlaceSubDestination[];
/**
* Specifies if the business supports takeout.
*/
takeout?: boolean | null;
/**
* IANA Time Zone Database time zone. For example "America/New_York".
*/
timeZone?: Schema$GoogleTypeTimeZone;
/**
* 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
*/
types?: string[] | null;
/**
* The total number of reviews (with or without text) for this place.
*/
userRatingCount?: number | null;
/**
* 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.
*/
utcOffsetMinutes?: number | null;
/**
* A viewport suitable for displaying the place on an average-sized map. This viewport should not be used as the physical boundary or the service area of the business.
*/
viewport?: Schema$GoogleGeoTypeViewport;
/**
* 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.
*/
websiteUri?: string | null;
}
/**
* Information about the accessibility options a place offers.
*/
export interface Schema$GoogleMapsPlacesV1PlaceAccessibilityOptions {
/**
* Places has wheelchair accessible entrance.
*/
wheelchairAccessibleEntrance?: boolean | null;
/**
* Place offers wheelchair accessible parking.
*/
wheelchairAccessibleParking?: boolean | null;
/**
* Place has wheelchair accessible restroom.
*/
wheelchairAccessibleRestroom?: boolean | null;
/**
* Place has wheelchair accessible seating.
*/
wheelchairAccessibleSeating?: boolean | null;
}
/**
* The structured components that form the formatted address, if this information is available.
*/
export interface Schema$GoogleMapsPlacesV1PlaceAddressComponent {
/**
* The language used to format this components, in CLDR notation.
*/
languageCode?: string | null;
/**
* 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".
*/
longText?: string | null;
/**
* 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".
*/
shortText?: string | null;
/**
* An array indicating the type(s) of the address component.
*/
types?: string[] | null;
}
/**
* Information about data providers of this place.
*/
export interface Schema$GoogleMapsPlacesV1PlaceAttribution {
/**
* Name of the Place's data provider.
*/
provider?: string | null;
/**
* URI to the Place's data provider.
*/
providerUri?: string | null;
}
/**
* The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies.
*/
export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlert {
/**
* The details of the consumer alert message.
*/
details?: Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetails;
/**
* The language code of the consumer alert message. This is a BCP 47 language code.
*/
languageCode?: string | null;
/**
* The overview of the consumer alert message.
*/
overview?: string | null;
}
/**
* The details of the consumer alert message.
*/
export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetails {
/**
* The link to show together with the description to provide more information.
*/
aboutLink?: Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink;
/**
* The description of the consumer alert message.
*/
description?: string | null;
/**
* The title to show together with the description.
*/
title?: string | null;
}
/**
* The link to show together with the description to provide more information.
*/
export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink {
/**
* The title to show for the link.
*/
title?: string | null;
/**
* The uri of the link.
*/
uri?: string | null;
}
/**
* Info about the place in which this place is located.
*/
export interface Schema$GoogleMapsPlacesV1PlaceContainingPlace {
/**
* The place id of the place in which this place is located.
*/
id?: string | null;
/**
* The resource name of the place in which this place is located.
*/
name?: string | null;
}
/**
* The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional.
*/
export interface Schema$GoogleMapsPlacesV1Place