Skip to content

Commit 751cdc5

Browse files
yoshi-automationsofisl
authored andcommitted
feat(places): update the API
#### places:v1 The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/maps-platform.places.getphotomedia.description - schemas.GoogleMapsPlacesV1Polyline.description - schemas.GoogleMapsPlacesV1Polyline.id - schemas.GoogleMapsPlacesV1Polyline.properties.encodedPolyline.description - schemas.GoogleMapsPlacesV1Polyline.properties.encodedPolyline.type - schemas.GoogleMapsPlacesV1Polyline.type - schemas.GoogleMapsPlacesV1RouteModifiers.description - schemas.GoogleMapsPlacesV1RouteModifiers.id - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidFerries.description - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidFerries.type - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidHighways.description - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidHighways.type - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidIndoor.description - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidIndoor.type - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidTolls.description - schemas.GoogleMapsPlacesV1RouteModifiers.properties.avoidTolls.type - schemas.GoogleMapsPlacesV1RouteModifiers.type - schemas.GoogleMapsPlacesV1RoutingParameters.description - schemas.GoogleMapsPlacesV1RoutingParameters.id - schemas.GoogleMapsPlacesV1RoutingParameters.properties.origin.$ref - schemas.GoogleMapsPlacesV1RoutingParameters.properties.origin.description - schemas.GoogleMapsPlacesV1RoutingParameters.properties.routeModifiers.$ref - schemas.GoogleMapsPlacesV1RoutingParameters.properties.routeModifiers.description - schemas.GoogleMapsPlacesV1RoutingParameters.properties.routingPreference.description - schemas.GoogleMapsPlacesV1RoutingParameters.properties.routingPreference.enum - schemas.GoogleMapsPlacesV1RoutingParameters.properties.routingPreference.enumDescriptions - schemas.GoogleMapsPlacesV1RoutingParameters.properties.routingPreference.type - schemas.GoogleMapsPlacesV1RoutingParameters.properties.travelMode.description - schemas.GoogleMapsPlacesV1RoutingParameters.properties.travelMode.enum - schemas.GoogleMapsPlacesV1RoutingParameters.properties.travelMode.enumDescriptions - schemas.GoogleMapsPlacesV1RoutingParameters.properties.travelMode.type - schemas.GoogleMapsPlacesV1RoutingParameters.type - schemas.GoogleMapsPlacesV1RoutingSummary.description - schemas.GoogleMapsPlacesV1RoutingSummary.id - schemas.GoogleMapsPlacesV1RoutingSummary.properties.legs.description - schemas.GoogleMapsPlacesV1RoutingSummary.properties.legs.items.$ref - schemas.GoogleMapsPlacesV1RoutingSummary.properties.legs.type - schemas.GoogleMapsPlacesV1RoutingSummary.type - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.description - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.id - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.properties.distanceMeters.description - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.properties.distanceMeters.format - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.properties.distanceMeters.type - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.properties.duration.description - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.properties.duration.format - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.properties.duration.type - schemas.GoogleMapsPlacesV1RoutingSummaryLeg.type - schemas.GoogleMapsPlacesV1SearchNearbyRequest.properties.routingParameters.$ref - schemas.GoogleMapsPlacesV1SearchNearbyRequest.properties.routingParameters.description - schemas.GoogleMapsPlacesV1SearchNearbyResponse.properties.routingSummaries.description - schemas.GoogleMapsPlacesV1SearchNearbyResponse.properties.routingSummaries.items.$ref - schemas.GoogleMapsPlacesV1SearchNearbyResponse.properties.routingSummaries.type - schemas.GoogleMapsPlacesV1SearchTextRequest.properties.routingParameters.$ref - schemas.GoogleMapsPlacesV1SearchTextRequest.properties.routingParameters.description - schemas.GoogleMapsPlacesV1SearchTextRequest.properties.searchAlongRouteParameters.$ref - schemas.GoogleMapsPlacesV1SearchTextRequest.properties.searchAlongRouteParameters.description - schemas.GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters.description - schemas.GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters.id - schemas.GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters.properties.polyline.$ref - schemas.GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters.properties.polyline.description - schemas.GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters.type - schemas.GoogleMapsPlacesV1SearchTextResponse.properties.routingSummaries.description - schemas.GoogleMapsPlacesV1SearchTextResponse.properties.routingSummaries.items.$ref - schemas.GoogleMapsPlacesV1SearchTextResponse.properties.routingSummaries.type The following keys were changed: - resources.places.resources.photos.methods.getMedia.scopes
1 parent 0f56c0f commit 751cdc5

File tree

2 files changed

+259
-2
lines changed

2 files changed

+259
-2
lines changed

discovery/places-v1.json

Lines changed: 157 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
"https://www.googleapis.com/auth/maps-platform.places.details": {
1515
"description": "Private Service: https://www.googleapis.com/auth/maps-platform.places.details"
1616
},
17+
"https://www.googleapis.com/auth/maps-platform.places.getphotomedia": {
18+
"description": "Private Service: https://www.googleapis.com/auth/maps-platform.places.getphotomedia"
19+
},
1720
"https://www.googleapis.com/auth/maps-platform.places.nearbysearch": {
1821
"description": "Private Service: https://www.googleapis.com/auth/maps-platform.places.nearbysearch"
1922
},
@@ -268,15 +271,16 @@
268271
},
269272
"scopes": [
270273
"https://www.googleapis.com/auth/cloud-platform",
271-
"https://www.googleapis.com/auth/maps-platform.places"
274+
"https://www.googleapis.com/auth/maps-platform.places",
275+
"https://www.googleapis.com/auth/maps-platform.places.getphotomedia"
272276
]
273277
}
274278
}
275279
}
276280
}
277281
}
278282
},
279-
"revision": "20240825",
283+
"revision": "20240920",
280284
"rootUrl": "https://places.googleapis.com/",
281285
"schemas": {
282286
"GoogleGeoTypeViewport": {
@@ -1494,6 +1498,17 @@
14941498
},
14951499
"type": "object"
14961500
},
1501+
"GoogleMapsPlacesV1Polyline": {
1502+
"description": "A route polyline. Only supports an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), which can be passed as a string and includes compression with minimal lossiness. This is the Routes API default output.",
1503+
"id": "GoogleMapsPlacesV1Polyline",
1504+
"properties": {
1505+
"encodedPolyline": {
1506+
"description": "An [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), as returned by the [Routes API by default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). See the [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) and [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) tools.",
1507+
"type": "string"
1508+
}
1509+
},
1510+
"type": "object"
1511+
},
14971512
"GoogleMapsPlacesV1References": {
14981513
"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Reference that the generative content is related to.",
14991514
"id": "GoogleMapsPlacesV1References",
@@ -1552,6 +1567,109 @@
15521567
},
15531568
"type": "object"
15541569
},
1570+
"GoogleMapsPlacesV1RouteModifiers": {
1571+
"description": "Encapsulates a set of optional conditions to satisfy when calculating the routes.",
1572+
"id": "GoogleMapsPlacesV1RouteModifiers",
1573+
"properties": {
1574+
"avoidFerries": {
1575+
"description": "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`.",
1576+
"type": "boolean"
1577+
},
1578+
"avoidHighways": {
1579+
"description": "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`.",
1580+
"type": "boolean"
1581+
},
1582+
"avoidIndoor": {
1583+
"description": "Optional. When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the `WALK` `TravelMode`.",
1584+
"type": "boolean"
1585+
},
1586+
"avoidTolls": {
1587+
"description": "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`.",
1588+
"type": "boolean"
1589+
}
1590+
},
1591+
"type": "object"
1592+
},
1593+
"GoogleMapsPlacesV1RoutingParameters": {
1594+
"description": "Parameters to configure the routing calculations to the places in the response, both along a route (where result ranking will be influenced) and for calculating travel times on results.",
1595+
"id": "GoogleMapsPlacesV1RoutingParameters",
1596+
"properties": {
1597+
"origin": {
1598+
"$ref": "GoogleTypeLatLng",
1599+
"description": "Optional. An explicit routing origin that overrides the origin defined in the polyline. By default, the polyline origin is used."
1600+
},
1601+
"routeModifiers": {
1602+
"$ref": "GoogleMapsPlacesV1RouteModifiers",
1603+
"description": "Optional. The route modifiers."
1604+
},
1605+
"routingPreference": {
1606+
"description": "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`.",
1607+
"enum": [
1608+
"ROUTING_PREFERENCE_UNSPECIFIED",
1609+
"TRAFFIC_UNAWARE",
1610+
"TRAFFIC_AWARE",
1611+
"TRAFFIC_AWARE_OPTIMAL"
1612+
],
1613+
"enumDescriptions": [
1614+
"No routing preference specified. Default to `TRAFFIC_UNAWARE`.",
1615+
"Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For `TravelMode` `DRIVE` and `TWO_WHEELER`, the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.",
1616+
"Calculates routes taking live traffic conditions into consideration. In contrast to `TRAFFIC_AWARE_OPTIMAL`, some optimizations are applied to significantly reduce latency.",
1617+
"Calculates the routes taking live traffic conditions into consideration, without applying most performance optimizations. Using this value produces the highest latency."
1618+
],
1619+
"type": "string"
1620+
},
1621+
"travelMode": {
1622+
"description": "Optional. The travel mode.",
1623+
"enum": [
1624+
"TRAVEL_MODE_UNSPECIFIED",
1625+
"DRIVE",
1626+
"BICYCLE",
1627+
"WALK",
1628+
"TWO_WHEELER"
1629+
],
1630+
"enumDescriptions": [
1631+
"No travel mode specified. Defaults to `DRIVE`.",
1632+
"Travel by passenger car.",
1633+
"Travel by bicycle. Not supported with `search_along_route_parameters`.",
1634+
"Travel by walking. Not supported with `search_along_route_parameters`.",
1635+
"Motorized two wheeled vehicles of all kinds such as scooters and motorcycles. Note that this is distinct from the `BICYCLE` travel mode which covers human-powered transport. Not supported with `search_along_route_parameters`. Only supported in those countries listed at [Countries and regions supported for two-wheeled vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled)."
1636+
],
1637+
"type": "string"
1638+
}
1639+
},
1640+
"type": "object"
1641+
},
1642+
"GoogleMapsPlacesV1RoutingSummary": {
1643+
"description": "The duration and distance from the routing origin to a place in the response, and a second leg from that place to the destination, if requested. **Note:** Adding `routingSummaries` in the field mask without also including either the `routingParameters.origin` parameter or the `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the request causes an error.",
1644+
"id": "GoogleMapsPlacesV1RoutingSummary",
1645+
"properties": {
1646+
"legs": {
1647+
"description": "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.",
1648+
"items": {
1649+
"$ref": "GoogleMapsPlacesV1RoutingSummaryLeg"
1650+
},
1651+
"type": "array"
1652+
}
1653+
},
1654+
"type": "object"
1655+
},
1656+
"GoogleMapsPlacesV1RoutingSummaryLeg": {
1657+
"description": "A leg is a single portion of a journey from one location to another.",
1658+
"id": "GoogleMapsPlacesV1RoutingSummaryLeg",
1659+
"properties": {
1660+
"distanceMeters": {
1661+
"description": "The distance of this leg of the trip.",
1662+
"format": "int32",
1663+
"type": "integer"
1664+
},
1665+
"duration": {
1666+
"description": "The time it takes to complete this leg of the trip.",
1667+
"format": "google-duration",
1668+
"type": "string"
1669+
}
1670+
},
1671+
"type": "object"
1672+
},
15551673
"GoogleMapsPlacesV1SearchNearbyRequest": {
15561674
"description": "Request proto for Search Nearby. ",
15571675
"id": "GoogleMapsPlacesV1SearchNearbyRequest",
@@ -1614,6 +1732,10 @@
16141732
"regionCode": {
16151733
"description": "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.",
16161734
"type": "string"
1735+
},
1736+
"routingParameters": {
1737+
"$ref": "GoogleMapsPlacesV1RoutingParameters",
1738+
"description": "Optional. Parameters that affect the routing to the search results."
16171739
}
16181740
},
16191741
"type": "object"
@@ -1639,6 +1761,13 @@
16391761
"$ref": "GoogleMapsPlacesV1Place"
16401762
},
16411763
"type": "array"
1764+
},
1765+
"routingSummaries": {
1766+
"description": "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.",
1767+
"items": {
1768+
"$ref": "GoogleMapsPlacesV1RoutingSummary"
1769+
},
1770+
"type": "array"
16421771
}
16431772
},
16441773
"type": "object"
@@ -1732,6 +1861,14 @@
17321861
"description": "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.",
17331862
"type": "string"
17341863
},
1864+
"routingParameters": {
1865+
"$ref": "GoogleMapsPlacesV1RoutingParameters",
1866+
"description": "Optional. Additional parameters for routing to results."
1867+
},
1868+
"searchAlongRouteParameters": {
1869+
"$ref": "GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters",
1870+
"description": "Optional. Additional parameters proto for searching along a route."
1871+
},
17351872
"strictTypeFiltering": {
17361873
"description": "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.",
17371874
"type": "boolean"
@@ -1812,6 +1949,17 @@
18121949
},
18131950
"type": "object"
18141951
},
1952+
"GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters": {
1953+
"description": "Specifies a precalculated polyline from the [Routes API](https://developers.google.com/maps/documentation/routes) defining the route to search. Searching along a route is similar to using the `locationBias` or `locationRestriction` request option to bias the search results. However, while the `locationBias` and `locationRestriction` options let you specify a region to bias the search results, this option lets you bias the results along a trip route. Results are not guaranteed to be along the route provided, but rather are ranked within the search area defined by the polyline and, optionally, by the `locationBias` or `locationRestriction` based on minimal detour times from origin to destination. The results might be along an alternate route, especially if the provided polyline does not define an optimal route from origin to destination.",
1954+
"id": "GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters",
1955+
"properties": {
1956+
"polyline": {
1957+
"$ref": "GoogleMapsPlacesV1Polyline",
1958+
"description": "Required. The route polyline."
1959+
}
1960+
},
1961+
"type": "object"
1962+
},
18151963
"GoogleMapsPlacesV1SearchTextResponse": {
18161964
"description": "Response proto for SearchText. ",
18171965
"id": "GoogleMapsPlacesV1SearchTextResponse",
@@ -1833,6 +1981,13 @@
18331981
"$ref": "GoogleMapsPlacesV1Place"
18341982
},
18351983
"type": "array"
1984+
},
1985+
"routingSummaries": {
1986+
"description": "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.",
1987+
"items": {
1988+
"$ref": "GoogleMapsPlacesV1RoutingSummary"
1989+
},
1990+
"type": "array"
18361991
}
18371992
},
18381993
"type": "object"

0 commit comments

Comments
 (0)