Protocol Documentation
Table of Contents
Top
engine/content/v1/lodging/lodging_amenity_code.proto
LodgingAmenityCode Enumerates possible lodging amenities
Name Number Description LODGING_AMENITY_CODE_UNKNOWN 0 LODGING_AMENITY_CODE_AIR_CONDITIONING 1 LODGING_AMENITY_CODE_DINING 2 LODGING_AMENITY_CODE_DRY_CLEANING 3 LODGING_AMENITY_CODE_ELECTRIC_VEHICLE_CHARGING 4 LODGING_AMENITY_CODE_FITNESS_CENTER 5 LODGING_AMENITY_CODE_FREE_AIRPORT_SHUTTLE 6 LODGING_AMENITY_CODE_FREE_BREAKFAST 7 LODGING_AMENITY_CODE_FREE_PARKING 8 LODGING_AMENITY_CODE_FULL_KITCHEN 9 LODGING_AMENITY_CODE_HIGH_SPEED_INTERNET 10 LODGING_AMENITY_CODE_KITCHENETTE 11 LODGING_AMENITY_CODE_MEETING_SPACE 12 LODGING_AMENITY_CODE_PET_FRIENDLY 13 LODGING_AMENITY_CODE_SPA 14 LODGING_AMENITY_CODE_SWIMMING_POOL 15 LODGING_AMENITY_CODE_TRUCK_PARKING 16
Top
engine/content/v1/lodging/property.proto
ExternalCatalogIdentifierList A list of external catalog identifiers for a single catalog key.
Field Type Label Description identifiers string repeated Supplier property identifiers for the associated catalog key. May contain multiple identifiers when more than one external record is mapped to the Engine record.
ExternalCatalogIdentifiers External catalog identifiers for property mapping.
ExternalCatalogIdentifiers.CatalogIdentifiersEntry
Property An individual Lodging location identified by Engine .
Field Type Label Description id string The Engine identifier for this Property . name string The full name of this Property . physical_address engine.common.v1.PostalAddress The physical address of this Property . This may differ from the mailing, billing, or other administrative addresses. coordinates engine.common.v1.GeoPoint The geographic location of this Property . hero_image_uri string optional If available, A URI to the image to use as the primary image to identify this Property . description string optional If available, a brief textual description of this Property . phone_number string optional If available, an E.164-compliant primary phone number for this Property . See https://en.wikipedia.org/wiki/E.164 emails engine.common.v1.ContactEmail repeated Contact email addresses for this property. May include general contact, billing, or reservation emails. star_rating string optional Star rating for this property. Represents the official star rating classification system. See https://en.wikipedia.org/wiki/Hotel_rating Examples: "4", "5", "3.5" amenities PropertyAmenity repeated Property amenities for this Property . List of amenity names describing features and services available to guests. Examples: "Free WiFi", "Pool", "Fitness Center", "Free Breakfast" media_items engine.common.v1.MediaItem repeated Media items for property gallery. Collection of media URIs for detailed property viewing and marketing. catalog ExternalCatalogIdentifiers External catalog identifiers for this property. Used for integration with external booking systems. check_in_time string optional Check-in time in local time HH:MM 24-hour format (e.g., "15:00") for the Property . check_out_time string optional Check-out time in local time HH:MM 24-hour format (e.g., "11:00") for the Property . loyalty_rewards_program engine.common.v1.LoyaltyRewardsProgram optional The loyalty rewards program associated with the Property . time_zone string optional The time zone for the Property in the IANA format. See https://www.iana.org/time-zones Examples: "America/Denver", "Atlantic/Madeira"
PropertyAmenity Property amenity containing name for property features and services.
Field Type Label Description amenity_name string Amenity name describing a Property feature or service. Examples: "Free WiFi", "Free Breakfast" amenity_code LodgingAmenityCode optional Amenity code, providing an easily machine readable representation of a Property feature or service, if mapped.
Top
engine/content/v1/lodging/room.proto
RoomAmenity Room amenity containing name for room features and services.
Field Type Label Description amenity_name string Amenity name describing room features and services. Examples: "Housekeeping on request", "Free WiFi"
Scalar Value Types .proto Type Notes C++ Java Python Go C# PHP Ruby double double double float float64 double float Float float float float float float32 float float Float int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required) int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required) uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required) sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required) sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required) fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required) sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum bool bool boolean boolean bool bool boolean TrueClass/FalseClass string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8) bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)