@googlemaps/places 1.1.0 → 1.2.0

package/build/protos/google/maps/places/v1/places_service.proto

@@ -34,10 +34,11 @@ option objc_class_prefix = "GMPSV1";
 option php_namespace = "Google\\Maps\\Places\\V1";
 
 // Service definition for the Places API.
-// Note: every request actually requires a field mask set outside of the request
-// proto (all/'*' is not assumed).  That can be set via either a side channel
-// (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
-// See: https://cloud.google.com/apis/docs/system-parameters
+// Note: every request actually requires a field mask set outside of
+// the request proto (all/'*', is not assumed).  That can be set via either a
+// side channel (SystemParameterContext) over RPC, or a header
+// (X-Goog-FieldMask) over HTTP. See:
+// https://cloud.google.com/apis/docs/system-parameters
 service Places {
   option (google.api.default_host) = "places.googleapis.com";
 
@@ -65,7 +66,7 @@ service Places {
     option (google.api.method_signature) = "name";
   }
 
-  // Get a Place with a place id (in a name) string.
+  // Get place details with a place id (in a name) string.
   rpc GetPlace(GetPlaceRequest) returns (Place) {
     option (google.api.http) = {
       get: "/v1/{name=places/*}"
@@ -75,6 +76,8 @@ service Places {
 }
 
 // Request proto for Search Nearby.
+//
+//
 message SearchNearbyRequest {
   // The region to search.
   message LocationRestriction {
@@ -111,14 +114,18 @@ message SearchNearbyRequest {
   // affect results based on applicable law.
   //
   // For more information, see
-  // http://www.unicode.org/reports/tr35/#unicode_region_subtag.
+  // https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.
   //
   //
   // Note that 3-digit region codes are not currently supported.
   string region_code = 2;
 
   // Included Place type (eg, "restaurant" or "gas_station") from
-  // https://developers.google.com/places/supported_types.
+  // https://developers.google.com/maps/documentation/places/web-service/place-types.
+  //
+  // Up to 50 types from [Table
+  // A](https://developers.google.com/maps/documentation/places/web-service/place-types#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
@@ -127,12 +134,16 @@ message SearchNearbyRequest {
   // 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 are POIs that provide "restaurant"
+  // ["restaurant"]}, the returned places provide "restaurant"
   // related services but do not operate primarily as "restaurants".
   repeated string included_types = 3;
 
   // Excluded Place type (eg, "restaurant" or "gas_station") from
-  // https://developers.google.com/places/supported_types.
+  // https://developers.google.com/maps/documentation/places/web-service/place-types.
+  //
+  // Up to 50 types from [Table
+  // A](https://developers.google.com/maps/documentation/places/web-service/place-types#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
@@ -145,12 +156,18 @@ message SearchNearbyRequest {
   // 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 are POIs that provide "restaurant"
+  // ["restaurant"]}, the returned places provide "restaurant"
   // related services but do not operate primarily as "restaurants".
   repeated string excluded_types = 4;
 
   // Included primary Place type (e.g. "restaurant" or "gas_station") from
-  // https://developers.google.com/places/supported_types.
+  // 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](https://developers.google.com/maps/documentation/places/web-service/place-types#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
@@ -159,12 +176,16 @@ message SearchNearbyRequest {
   // 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 are POIs that provide "restaurant"
+  // ["restaurant"]}, the returned places provide "restaurant"
   // related services but do not operate primarily as "restaurants".
   repeated string included_primary_types = 5;
 
   // Excluded primary Place type (e.g. "restaurant" or "gas_station") from
-  // https://developers.google.com/places/supported_types.
+  // https://developers.google.com/maps/documentation/places/web-service/place-types.
+  //
+  // Up to 50 types from [Table
+  // A](https://developers.google.com/maps/documentation/places/web-service/place-types#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
@@ -173,11 +194,11 @@ message SearchNearbyRequest {
   // 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 are POIs that provide "restaurant"
+  // ["restaurant"]}, the returned places provide "restaurant"
   // related services but do not operate primarily as "restaurants".
   repeated string excluded_primary_types = 6;
 
-  // Maximum number of results to return. It must be between 1 and 20,
+  // 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.
@@ -195,7 +216,7 @@ message SearchNearbyRequest {
 //
 //
 message SearchNearbyResponse {
-  // A list of interesting places that meets user's requirements like places
+  // A list of places that meets user's requirements like places
   // types, number of places and specific location restriction.
   repeated Place places = 1;
 }
@@ -213,7 +234,7 @@ message SearchTextRequest {
     DISTANCE = 1;
 
     // Ranks results by relevance. Sort order determined by normal ranking
-    // stack. See SortRefinement::RELEVANCE.
+    // stack.
     RELEVANCE = 2;
   }
 
@@ -222,6 +243,11 @@ message SearchTextRequest {
   message LocationBias {
     oneof type {
       // 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.
       google.geo.type.Viewport rectangle = 1;
 
       // A circle defined by center point and radius.
@@ -234,6 +260,11 @@ message SearchTextRequest {
   message LocationRestriction {
     oneof type {
       // 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.
       google.geo.type.Viewport rectangle = 1;
     }
   }
@@ -256,7 +287,7 @@ message SearchTextRequest {
   // affect results based on applicable law.
   //
   // For more information, see
-  // http://www.unicode.org/reports/tr35/#unicode_region_subtag.
+  // https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.
   //
   //
   // Note that 3-digit region codes are not currently supported.
@@ -266,26 +297,25 @@ message SearchTextRequest {
   RankPreference rank_preference = 4;
 
   // The requested place type. Full list of types supported:
-  // https://developers.google.com/places/supported_types. Only support one
-  // included type.
+  // https://developers.google.com/maps/documentation/places/web-service/place-types.
+  // Only support one included type.
   string included_type = 6;
 
-  // Used to restrict the search to places that are open at a specific time.
-  // open_now marks if a business is currently open.
+  // Used to restrict the search to places that are currently open.  The default
+  // is false.
   bool open_now = 7;
 
   // Filter out results whose average user rating is strictly less than this
-  // limit. A valid value must be an float between 0 and 5 (inclusively) at a
-  // 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] inclusively. This is to keep
-  // parity with LocalRefinement_UserRating. 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.
+  // 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.
   double min_rating = 9;
 
   // Maximum number of results to return. It must be between 1 and 20,
-  // 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.
+  // 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.
   int32 max_result_count = 10;
 
   // Used to restrict the search to places that are marked as certain price
@@ -317,9 +347,13 @@ message SearchTextResponse {
 
 // Request for fetching a photo of a place using a photo resource name.
 message GetPhotoMediaRequest {
-  // Required. The resource name of a photo. It is returned in Place's
-  // photos.name field. Format:
-  // places/<place_id>/photos/<photo_reference>/media.
+  // 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.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -356,7 +390,7 @@ message GetPhotoMediaRequest {
   // 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
-  // midea. This option is ignored for non-HTTP requests.
+  // media. This option is ignored for non-HTTP requests.
   bool skip_http_redirect = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -369,8 +403,8 @@ message PhotoMedia {
     singular: "photoMedia"
   };
 
-  // The resource name of a photo. It is returned in Place's photos.name field.
-  // Format: places/<place_id>/photos/<photo_reference>/media.
+  // The resource name of a photo media in the format:
+  // `places/{place_id}/photos/{photo_reference}/media`.
   string name = 1;
 
   // A short-lived uri that can be used to render the photo.
@@ -379,8 +413,9 @@ message PhotoMedia {
 
 // Request for fetching a Place with a place id (in a name) string.
 message GetPlaceRequest {
-  // Required. A place_id returned in a Place (with "places/" prefix), or
-  // equivalently the name in the same Place. Format: places/<place_id>.
+  // Required. A place ID returned in a Place (with "places/" prefix), or
+  // equivalently the name in the same Place. Format:
+  // `places/{place_id}`.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = { type: "places.googleapis.com/Place" }
@@ -398,7 +433,7 @@ message GetPlaceRequest {
   // details, like region-specific place name, if available. The parameter can
   // affect results based on applicable law.
   // For more information, see
-  // http://www.unicode.org/reports/tr35/#unicode_region_subtag.
+  // https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.
   //
   //
   // Note that 3-digit region codes are not currently supported.

package/build/protos/google/maps/places/v1/review.proto

@@ -16,7 +16,6 @@ syntax = "proto3";
 
 package google.maps.places.v1;
 
-import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/maps/places/v1/attribution.proto";
 import "google/protobuf/timestamp.proto";
@@ -40,33 +39,27 @@ message Review {
     singular: "review"
   };
 
-  // Output only. A reference representing this place review which may be used
-  // to look up this place review again (a.k.a. the API "resource" name:
-  // places/{place_id}/reviews/{review}).
-  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // A reference representing this place review which may be used to look up
+  // this place review again (also called the API "resource" name:
+  // `places/{place_id}/reviews/{review}`).
+  string name = 1;
 
-  // Output only. A string of formatted recent time, expressing the review time
-  // relative to the current time in a form appropriate for the language and
-  // country.
-  string relative_publish_time_description = 2
-      [(google.api.field_behavior) = OUTPUT_ONLY];
+  // A string of formatted recent time, expressing the review time relative
+  // to the current time in a form appropriate for the language and country.
+  string relative_publish_time_description = 2;
 
-  // Output only. The localized text of the review.
-  google.type.LocalizedText text = 9
-      [(google.api.field_behavior) = OUTPUT_ONLY];
+  // The localized text of the review.
+  google.type.LocalizedText text = 9;
 
-  // Output only. The review text in its original language.
-  google.type.LocalizedText original_text = 12
-      [(google.api.field_behavior) = OUTPUT_ONLY];
+  // The review text in its original language.
+  google.type.LocalizedText original_text = 12;
 
-  // Output only. A number between 1.0 and 5.0, a.k.a. the number of stars.
-  double rating = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // A number between 1.0 and 5.0, also called the number of stars.
+  double rating = 7;
 
-  // Output only. This review's author.
-  AuthorAttribution author_attribution = 13
-      [(google.api.field_behavior) = OUTPUT_ONLY];
+  // This review's author.
+  AuthorAttribution author_attribution = 13;
 
-  // Output only. Timestamp for the review.
-  google.protobuf.Timestamp publish_time = 14
-      [(google.api.field_behavior) = OUTPUT_ONLY];
+  // Timestamp for the review.
+  google.protobuf.Timestamp publish_time = 14;
 }