docs: Fix typo in PriceLevel enum

Google APIs · copybara-github · commit 828b4baa380d · 2024-03-29T12:53:18.000-07:00
docs: Document the maximum number of reviews and photos returned
docs: Correct requirements on Autocomplete and Details session token field

PiperOrigin-RevId: 620317804
diff --git a/google/maps/places/v1/place.proto b/google/maps/places/v1/place.proto
@@ -362,7 +362,8 @@ message Place {
   // chain.
   string website_uri = 16;
 
-  // List of reviews about this place, sorted by relevance.
+  // List of reviews about this place, sorted by relevance. A maximum of 5
+  // reviews can be returned.
   repeated Review reviews = 53;
 
   // The regular hours of operation.
@@ -373,7 +374,8 @@ message Place {
   // fractions of an hour, e.g. X hours and 15 minutes.
   optional int32 utc_offset_minutes = 22;
 
-  // Information (including references) about photos of this place.
+  // Information (including references) about photos of this place. A maximum of
+  // 10 photos can be returned.
   repeated Photo photos = 54;
 
   // The place's address in adr microformat: http://microformats.org/wiki/adr.
@@ -534,6 +536,6 @@ enum PriceLevel {
   // Place provides expensive services.
   PRICE_LEVEL_EXPENSIVE = 4;
 
-  // Place provides very expensive service s.
+  // Place provides very expensive services.
   PRICE_LEVEL_VERY_EXPENSIVE = 5;
 }
diff --git a/google/maps/places/v1/places_service.proto b/google/maps/places/v1/places_service.proto
@@ -465,21 +465,23 @@ message GetPlaceRequest {
   // Note that 3-digit region codes are not currently supported.
   string region_code = 3 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. An arbitrary string which identifies an autocomplete session for
-  // billing purposes. Must be at most 36 characters in length. Otherwise an
-  // INVALID_ARGUMENT error is returned.
+  // 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
-  // selection. 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).
+  // 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.
@@ -538,8 +540,8 @@ message AutocompletePlacesRequest {
   LocationRestriction location_restriction = 3
       [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Included primary Place type (e.g. "restaurant" or "gas_station")
-  // from
+  // 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
@@ -582,21 +584,23 @@ message AutocompletePlacesRequest {
   // predictions. Otherwise the response will only return Place predictions.
   bool include_query_predictions = 10 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. An arbitrary string which identifies an autocomplete session for
-  // billing purposes. Must be at most 36 characters in length. Otherwise an
-  // INVALID_ARGUMENT error is returned.
+  // 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
-  // selection. 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).
+  // 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.
@@ -632,7 +636,7 @@ message AutocompletePlacesResponse {
       // 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 (e.g. spell
+      // determined by criteria other than string matching (for example, spell
       // corrections or transliterations).
       //
       // These values are Unicode character offsets of `text`. The ranges are
@@ -713,7 +717,8 @@ message AutocompletePlacesResponse {
     // Prediction results for a Query Autocomplete prediction.
     message QueryPrediction {
       // The predicted text. This text does not represent a Place, but rather a
-      // text query that could be used in a search endpoint (e.g. TextSearch).
+      // text query that could be used in a search endpoint (for example,
+      // TextSearch).
       //
       // `text` is recommended for developers who wish to show a single UI
       // element. Developers who wish to show two separate, but related, UI
diff --git a/google/maps/places/v1/places_v1.yaml b/google/maps/places/v1/places_v1.yaml
@@ -20,7 +20,7 @@ publishing:
   doc_tag_prefix: places
   organization: GEO
   library_settings:
-  - version: google.maps.api.v1
+  - version: google.maps.places.v1
     launch_stage: GA
     java_settings:
       common:
