@googlemaps/places 1.0.1 → 1.2.0

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

@@ -16,9 +16,12 @@ syntax = "proto3";
 
 package google.maps.places.v1;
 
-import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
 import "google/geo/type/viewport.proto";
-import "google/protobuf/timestamp.proto";
+import "google/maps/places/v1/ev_charging.proto";
+import "google/maps/places/v1/fuel_options.proto";
+import "google/maps/places/v1/photo.proto";
+import "google/maps/places/v1/review.proto";
 import "google/type/date.proto";
 import "google/type/latlng.proto";
 import "google/type/localized_text.proto";
@@ -34,6 +37,13 @@ option php_namespace = "Google\\Maps\\Places\\V1";
 
 // All the information representing a Place.
 message Place {
+  option (google.api.resource) = {
+    type: "places.googleapis.com/Place"
+    pattern: "places/{place_id}"
+    plural: "places"
+    singular: "place"
+  };
+
   // The structured components that form the formatted address, if this
   // information is available.
   message AddressComponent {
@@ -58,62 +68,22 @@ message Place {
   // global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle,
   // and compound code, replacing the prefix with a reference location.
   message PlusCode {
-    // Place's global (full) code, such as `9FWM33GV+HQ`, representing an
+    // Place's global (full) code, such as "9FWM33GV+HQ", representing an
     // 1/8000 by 1/8000 degree area (~14 by 14 meters).
     string global_code = 1;
 
-    // Place's compound code, such as `33GV+HQ, Ramberg, Norway`, containing
+    // 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.
     string compound_code = 2;
   }
 
-  // Information about a review of the place.
-  message Review {
-    // Timestamp for the review, expressed in seconds since epoch.
-    google.protobuf.Timestamp publish_time = 1;
-
-    // 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;
-
-    // The localized text of the review.
-    google.type.LocalizedText text = 9;
-
-    // The name of the review author.
-    string author = 4;
-
-    // A link to the review author's profile.
-    string author_uri = 5;
-
-    // The author's profile photo.
-    string author_photo_uri = 6;
-
-    // A whole number between 1.0 and 5.0, a.k.a. the number of stars.
-    double rating = 7;
-
-    // A BCP-47 language code indicating the original language of the review.
-    // If the review has been translated, then original_language != language.
-    // This field contains the main language tag only, and not the secondary tag
-    // indicating country or region. For example, all the English reviews are
-    // tagged as 'en', and not 'en-AU' or 'en-UK' and so on.This field is empty
-    // if there is only a rating with no review text.
-    string original_language_code = 10;
-
-    // A boolean value indicating if the review was translated from the original
-    // language it was written in. If a review has been translated,
-    // corresponding to a value of true, Google recommends that you indicate
-    // this to your users. For example, you can add the following string,
-    // “Translated by Google”, to the review.
-    bool translated = 11;
-  }
-
   // Information about business hour of the place.
   message OpeningHours {
     // A period the place remains in open_now status.
-    message OpeningHoursPeriod {
+    message Period {
       // Status changing points.
-      message OpeningHoursPoint {
+      message Point {
         // A day of the week, as an integer in the range 0-6.  0 is Sunday, 1 is
         // Monday, etc.
         optional int32 day = 1;
@@ -124,32 +94,28 @@ message Place {
         // The minute in 2 digits. Ranges from 00 to 59.
         optional int32 minute = 3;
 
-        // Date of the endpoint expressed in `RFC3339` format in the local
-        // timezone for the place. For example 2010-12-31.
-        string date_deprecated = 4 [deprecated = true];
-
         // Date in the local timezone for the place.
         google.type.Date date = 6;
 
         // 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
+        // ensures that at most 24 * 7 hours from midnight of the day of the
         // request are returned.
         bool truncated = 5;
       }
 
       // The time that the place starts to be open.
-      OpeningHoursPoint open = 1;
+      Point open = 1;
 
       // The time that the place starts to be closed.
-      OpeningHoursPoint close = 2;
+      Point close = 2;
     }
 
     // A type used to identify the type of secondary hours.
-    enum SecondaryHourType {
+    enum SecondaryHoursType {
       // Default value when secondary hour type is not specified.
-      SECONDARY_HOUR_TYPE_UNSPECIFIED = 0;
+      SECONDARY_HOURS_TYPE_UNSPECIFIED = 0;
 
       // The drive-through hour for banks, restaurants, or pharmacies.
       DRIVE_THROUGH = 1;
@@ -201,13 +167,13 @@ message Place {
 
     // Is this place open right now?  Always present unless we lack time-of-day
     // or timezone data for these opening hours.
-    bool open_now = 1;
+    optional bool open_now = 1;
 
     // 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.
-    repeated OpeningHoursPeriod periods = 2;
+    repeated Period periods = 2;
 
     // 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
@@ -215,7 +181,7 @@ message Place {
     repeated string weekday_descriptions = 3;
 
     // A type string used to identify the type of secondary hours.
-    SecondaryHourType secondary_hour_type = 4;
+    SecondaryHoursType secondary_hours_type = 4;
 
     // Structured information for special days that fall within the period that
     // the returned opening hours cover. Special days are days that could impact
@@ -249,25 +215,104 @@ message Place {
     string provider_uri = 2;
   }
 
-  // Contains a summary of the place.
-  message EditorialSummary {
-    // 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.
-    google.type.LocalizedText overview = 1;
+  // Payment options the place accepts.
+  message PaymentOptions {
+    // Place accepts credit cards as payment.
+    optional bool accepts_credit_cards = 1;
+
+    // Place accepts debit cards as payment.
+    optional bool accepts_debit_cards = 2;
+
+    // Place accepts cash only as payment. Places with this attribute may still
+    // accept other payment methods.
+    optional bool accepts_cash_only = 3;
+
+    // Place accepts NFC payments.
+    optional bool accepts_nfc = 4;
+  }
+
+  // Information about parking options for the place. A parking lot could
+  // support more than one option at the same time.
+  message ParkingOptions {
+    // Place offers free parking lots.
+    optional bool free_parking_lot = 1;
+
+    // Place offers paid parking lots.
+    optional bool paid_parking_lot = 2;
+
+    // Place offers free street parking.
+    optional bool free_street_parking = 3;
+
+    // Place offers paid street parking.
+    optional bool paid_street_parking = 4;
+
+    // Place offers valet parking.
+    optional bool valet_parking = 5;
+
+    // Place offers free garage parking.
+    optional bool free_garage_parking = 6;
+
+    // Place offers paid garage parking.
+    optional bool paid_garage_parking = 7;
+  }
+
+  // Place resource name and id of sub destinations that relate to the place.
+  // For example, different terminals are different destinations of an airport.
+  message SubDestination {
+    // The resource name of the sub destination.
+    string name = 1 [
+      (google.api.resource_reference) = { type: "places.googleapis.com/Place" }
+    ];
+
+    // The place id of the sub destination.
+    string id = 2;
+  }
+
+  // Information about the accessibility options a place offers.
+  message AccessibilityOptions {
+    // Place offers wheelchair accessible parking.
+    optional bool wheelchair_accessible_parking = 1;
+
+    // Places has wheelchair accessible entrance.
+    optional bool wheelchair_accessible_entrance = 2;
+
+    // Place has wheelchair accessible restroom.
+    optional bool wheelchair_accessible_restroom = 3;
+
+    // Place has wheelchair accessible seating.
+    optional bool wheelchair_accessible_seating = 4;
   }
 
-  // Required. The unique identifier of a place.
-  string id = 2 [(google.api.field_behavior) = REQUIRED];
+  // An ID representing this place which may be used to look up this place
+  // again (a.k.a. the API "resource" name: places/place_id).
+  string name = 1;
+
+  // The unique identifier of a place.
+  string id = 2;
 
   // The localized name of the place, suitable as a short human-readable
   // description. For example, "Google Sydney", "Starbucks", "Pyrmont", etc.
   google.type.LocalizedText display_name = 31;
 
   // A set of type tags for this result. For example, "political" and
-  // "locality".
+  // "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
   repeated string types = 5;
 
+  // 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
+  string primary_type = 50;
+
+  // 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
+  google.type.LocalizedText primary_type_display_name = 32;
+
   // A human-readable phone number for the place, in national format.
   string national_phone_number = 7;
 
@@ -277,7 +322,23 @@ message Place {
   // A full, human-readable address for this place.
   string formatted_address = 9;
 
+  // A short, human-readable address for this place.
+  string short_formatted_address = 51;
+
   // 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.
   repeated AddressComponent address_components = 10;
 
   // Plus code of the place location lat/long.
@@ -301,16 +362,19 @@ message Place {
   // chain.
   string website_uri = 16;
 
-  // List of reviews about this place.
-  repeated Review reviews = 20;
+  // List of reviews about this place, sorted by relevance.
+  repeated Review reviews = 53;
 
   // The regular hours of operation.
-  OpeningHours opening_hours = 21;
+  OpeningHours regular_opening_hours = 21;
 
   // 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.
-  int32 utc_offset_minutes = 22;
+  optional int32 utc_offset_minutes = 22;
+
+  // Information (including references) about photos of this place.
+  repeated Photo photos = 54;
 
   // The place's address in adr microformat: http://microformats.org/wiki/adr.
   string adr_format_address = 24;
@@ -325,9 +389,9 @@ message Place {
   repeated Attribution attributions = 27;
 
   // The total number of reviews (with or without text) for this place.
-  int32 user_rating_count = 28;
+  optional int32 user_rating_count = 28;
 
-  // A truncated URL to an v2 icon mask. User can access different icon type by
+  // A truncated URL to an icon mask. User can access different icon type by
   // appending type suffix to the end (eg, ".svg" or ".png").
   string icon_mask_base_uri = 29;
 
@@ -346,9 +410,6 @@ message Place {
   // Specifies if the business supports curbside pickup.
   optional bool curbside_pickup = 36;
 
-  // Specifies if the place has an entrance that is wheelchair-accessible.
-  optional bool wheelchair_accessible_entrance = 37;
-
   // Specifies if the place supports reservations.
   optional bool reservable = 38;
 
@@ -395,12 +456,65 @@ message Place {
   // 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.
-  repeated OpeningHours secondary_opening_hours = 49;
+  repeated OpeningHours regular_secondary_opening_hours = 49;
 
   // 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 editorial_summary = 48;
+  google.type.LocalizedText editorial_summary = 52;
+
+  // Place provides outdoor seating.
+  optional bool outdoor_seating = 55;
+
+  // Place provides live music.
+  optional bool live_music = 56;
+
+  // Place has a children's menu.
+  optional bool menu_for_children = 57;
+
+  // Place serves cocktails.
+  optional bool serves_cocktails = 58;
+
+  // Place serves dessert.
+  optional bool serves_dessert = 59;
+
+  // Place serves coffee.
+  optional bool serves_coffee = 60;
+
+  // Place is good for children.
+  optional bool good_for_children = 62;
+
+  // Place allows dogs.
+  optional bool allows_dogs = 63;
+
+  // Place has restroom.
+  optional bool restroom = 64;
+
+  // Place accommodates groups.
+  optional bool good_for_groups = 65;
+
+  // Place is suitable for watching sports.
+  optional bool good_for_watching_sports = 66;
+
+  // Payment options the place accepts. If a payment option data is not
+  // available, the payment option field will be unset.
+  PaymentOptions payment_options = 67;
+
+  // Options of parking provided by the place.
+  ParkingOptions parking_options = 70;
+
+  // A list of sub destinations related to the place.
+  repeated SubDestination sub_destinations = 71;
+
+  // Information about the accessibility options a place offers.
+  optional AccessibilityOptions accessibility_options = 72;
+
+  // The most recent information about fuel options in a gas station. This
+  // information is updated regularly.
+  FuelOptions fuel_options = 78;
+
+  // Information of ev charging options.
+  EVChargeOptions ev_charge_options = 79;
 }
 
 // Price level of the place.
@@ -408,17 +522,18 @@ enum PriceLevel {
   // Place price level is unspecified or unknown.
   PRICE_LEVEL_UNSPECIFIED = 0;
 
-  FREE = 1;
+  // Place provides free services.
+  PRICE_LEVEL_FREE = 1;
 
   // Place provides inexpensive services.
-  INEXPENSIVE = 2;
+  PRICE_LEVEL_INEXPENSIVE = 2;
 
   // Place provides moderately priced services.
-  MODERATE = 3;
+  PRICE_LEVEL_MODERATE = 3;
 
   // Place provides expensive services.
-  EXPENSIVE = 4;
+  PRICE_LEVEL_EXPENSIVE = 4;
 
-  // Place provides very expensive services.
-  VERY_EXPENSIVE = 5;
+  // Place provides very expensive service s.
+  PRICE_LEVEL_VERY_EXPENSIVE = 5;
 }