Customizing the Venue Widget
Companies and venue managers may customize the TripPlanz Widget for use with any corporate website or venue page, any blog or any enterprise system that lists/aggregates company lists or venues.
It can be hard coded with a single venue’s information, or an organization that has multiple venues or that lists/aggregates venues can use our dynamic widget. For the dynamic version of the widget, you would pass the variable parameters to us at time of display of the widget, customizing literally hundreds or thousands of pages.
There are several parameters that need to be passed to the venue widget to operate correctly. These must be rendered in the web page as JSON data dictionary within an Html script tag like the sample at the bottom of this page.
The widget can be hardcoded with all of this information for your company or venue (such as on the CONTACT US or VISIT US page on your corporate website). If the widget is being used for a system that has multiple venues, you will substitute the %VARIABLE NAMES% with the correct data from your landing page for the venue at transaction time.
The Widget Variables
|wdgt_image_URL||The URL for the image on the graphical widget||N||Optional. If you do not have your own image, you can use the Where Should I Stay button from TripPlanz.|
|wdgt_link_URL||The URL for the link from the image||N||This link only works if you have an image. The link can take you to any other website, blog, page represented by a URL.|
|header_text||Widget title, which defaults to “Plan your trip near”||Y||This can also be a more complete description of an event or venue, in which case you would ensure that the append poi flag is set to N.
|poi_name||Name of the venue to appear on the booking results page||Y||This should be the short version of the name of the venue.|
|append_poi||Append the POI to the widget title.||N||If append_poi is set to Yes, the header text and poi_name will be appended.|
|tabs||Ability to turn on/off widget tabs using a mask value. Please see the tabs possible values table at the bottom of this page.||N||Default setting is 0x111, which is our complete widget with hotel, driving directions and car rental, plus air.|
|latitude||Geographic coordinate.||N||Optional, but will override the street address if included.|
|longitude||Geographic coordinate.||N||Optional, but will override the street address if included.|
|refid||This field determines the branding on the booking back end header and footer.||Y||The default is 5135 for the TripPlanz brand.
Your account director will provide the correct refid.
|refclickid||Customer ID from the customer’s client base.||Y||Mandatory that this field include the refclickid code provided by your account director, as this is used to track analytics for widget use and bookings.
Optionally you may append up to 35 characters to be used for tracking of the bookings from your account. This can include your customer numbers, event numbers or the channel used (email, web, blog).
Your account director will work with you to determine how to structure.
|cname||Booking backend URL||N||Optional (default to booking.tripplanz.com).
This must be a valid CNAME for the host site.
|address||If no geographic coordinates are provided these parameters will be used to calculate the proximity for the hotel search.
The address must be searchable on Google Maps API in order to result in a valid search.
|N||Optional if geographic coordinates were provided.|
|city||Y||Mandatory if lat/long is not used.|
|stateprovince||Y||Mandatory if lat/long is not used.|
|postalcode||N||Optional if geographic coordinates were provided.|
|country||Two-digit country code||Y||Two-digit code for the country. Defaults to US.|
|airport||Three-character airport code||N||IATA 3-character code representing the closest airport.|
|airport_city||If using Air tab, this is the name of the city where the closest airport is located.||N||Uses the venue city if left blank.|
|airport_stateprovince||If using Air tab, this is the name of the state or province where the closest airport is located.||N||Uses the venue stateprovince info if left blank.|
|currency||Currency code (ie. USD, CAD)||N||The default is to take it from the browser’s language as determined by the IP Address.|
|check_in||Numbers of days between today and the default check in date.||Y||This is for venues (default 7)|
|check_out||Number of days between today and the default check out date||Y||This is for venues (default 9)|
|lengthOfStay||(no longer used on venue widget)||N|
|guests||Default selected number of guests.||Y||Default to 2|
|rooms||Default selected number of rooms.||Y||Default to 1|
|hotel_stars||Default hotel star ratings to be included in the hotel results.||N||Optional (default 3,4,5)|
|pick_up||Numbers of days between today and the default pick up date for car rental.||N||Defaults to 7 if Driving Directions is used|
|drop_off||Numbers of days between today and the default drop_off date for car rental.||N||Defaults to 9 if Driving Directions is used|
|departure||Numbers of days between today and the default departure date.||Y||Defaults to 7 if AIR is used|
|return||Numbers of days between today and the default return date.||Y||Defaults to 9 if AIR is used|
|social||Include social sharing. Also known as tvite version of the widget.||N||tVite version of the widget = Y (default)
basic widget = N
|tabs possible values
This section shows you how to adjust the tabs value to include or exclude the I’m Driving and I’m Flying tabs from the widget.Please note the following masks: hotel = 0x001; car = 0x010; flight = 0x100;
|0x001||HOTEL ONLY – I’m Staying Only (if this is the only widget it does NOT have a tab)|
|0x011||HOTEL and DRIVE – I’m Staying plus I’m Driving. This is NOT recommended for venues on an island.|
|0x101||HOTEL and FLYING – I’m Staying plus I’m Flying. At this time, this is not recommended internationally.|
|0x111||ALL TABS – I’m Staying plus I’m Driving plus I’m Flying. At this time, this is not recommended internationally.|