Protocol Documentation

Table of Contents

• engine/shop/lodging/v1/offer.proto
  • OfferAmenities
  • OfferSummary
• engine/shop/lodging/v1/room.proto
  • Bedding
  • RoomDescription
• Scalar Value Types

Top

engine/shop/lodging/v1/offer.proto

OfferAmenities

OfferAmenities represent the value added by the individual offer to be evaluated against other offers. OfferAmenities do not include amenities conferred by the Property. For example, if a given Property provides free breakfast to all guests, none of the Offers for that property will have Free Breakfast as an amenity.

Field	Type	Label	Description
free_breakfast	engine.common.v1.AmenityAvailability		Describes the availability of free breakfast for the offer or booking.
free_parking	engine.common.v1.AmenityAvailability		Describes the availability of free parking for the offer or booking.
other_amenities	string	repeated	Textual descriptions for display purposes of assorted amenities of the offer or booking that have not been explicitly hoisted to their own attribute.

OfferSummary

A summary of the attributes available to a specific Offer.

Field	Type	Label	Description
property_id	string		The Engine identifier for the Property to which this Offer belongs.
description	string		A textual description of the Offer.
price	engine.common.v1.PriceWithPerUnit		The pricing details for the Offer.
offer_amenities	OfferAmenities		Amenities that may only apply to this Offer. For example, some Offers may include parking.
conditions	engine.common.v1.Conditions		The conditions covering refundability and cancellation.
is_loyalty_eligible	bool		If true, this Offer may earn loyalty points.

Top

engine/shop/lodging/v1/room.proto

Bedding

A description of the quantity and type of beds in the room.

Field	Type	Label	Description
count	int32		The number of this bed type in the room.
description	string		A textual description of the type of this bed in the room. For example, "KING", "QUEEN", or "SLEEPER".

RoomDescription

Generalized details of the room to which an Offer applies.

Field	Type	Label	Description
title	string		The title of a room. For example, "Standard 1 King Bed", or "Suite 1 King Bed", "The Canary Suite".
description	string		A textual marketing description of the room. For example, "SKYLINE VIEW KING ROOM -CITY OR RIVER VIEW 1 KING -430 SQF"
beds	Bedding	repeated	The available bedding for the room.
photos	string	repeated	URIs to photos of this room.

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)