TripAdvisor Content Syndication Widgets Options and Settings

Transcription

1 TripAdvisor Content Syndication Widgets Options and Settings Version 1.1 Updated: September 23, 2008 Contents 1 Scope of this Document Overview Partner Widget URL Options Destination Snapshot Widgets Samples Color Options Configuration Options Property Widgets Samples Configuration Options Check Rates Widget Samples Configuration Options Questions and Support...10

2 1 Scope of this Document This document describes the options that can be provided for each of the content syndication gatedaccess partner widgets. Note: Content syndication widgets that are freely available are not covered in this document, as they are provided via downloadable code that already has all the options set correctly, and modifying any part of this code will cause the widget not to display. For a complete list of available widgets, please visit 2 Overview Partner widgets support both options that are set in a partner configuration file, and options that can be specified via URL parameters for each widget call. Configuration file options apply to all invocations of that widget for that partner, and consist of settings that enable the features contractually agreed upon for that partner. URL parameters apply only to one particular widget invocation, and consist of settings such as the property or destination ID for which to retrieve content, and the language in which to display the widget. Partner widgets are intended to be displayed in an iframe on the partner site. A sample iframe with a widget invocation might look like: <iframe src=" WIDGET_KEY? display=true& partnerid=partner_key& lang=en_us& locationid=224948" width="240" height="510" scrolling="no" frameborder="0" marginheight="0" marginwidth="0" style="vertical-align:top;"> </iframe> All widget URLs include the /WidgetEmbed TripAdvisor page followed by the key value for the widget being requested. This is followed by a question mark and the key/value pairs of URL parameters. 3 Partner Widget URL Options URL parameter settings are consistent across all widgets. Option Name partnerid locationid lang colorset Description Required. The partner key provided by TripAdvisor to allow partner access to widgets. Required. For property widgets, this will be the ID of the property requested. For destination widgets, this will be the ID of the geo requested. This value can be either a TA ID, or a partner ID if TA has done a property mapping. Optional. The language in which to display the widget. Supported values are: en_us, en_uk, de, es, fr, it. Default is en_us. Optional. Currently destination widget only. Overrides the configured color settings for that partner. Supported values are: blue, grey, brown, default. The "default" set is TripAdvisor green. Version 1.1 Page 2 of 10

3 4 Destination Snapshot Widgets These widgets provide a snapshot of the most highly recommended properties in a destination, including the hotels, attractions and restaurants rated highest by TripAdvisor travelers. Partners may customize the number of top properties to show, which types of properties to include, and the basic color options. 4.1 Samples DESTINATION SNAPSHOT SAMPLE: Showing top 10 properties with separate tabs for hotels, attractions and restaurants DESTINATION SNAPSHOT SAMPLE: Showing top 5 properties for hotels only Version 1.1 Page 3 of 10

4 Clicking the name of one of the top properties will open a pop-up which provides details about the property, such as its overall TripAdvisor rating, photos and recent traveler reviews. See Property Detail widget sample below. 4.2 Color Options Color options for this widget include the following: Green (default) Blue Grey Brown Version 1.1 Page 4 of 10

5 4.3 Configuration Options Option Name Show Hotels tab Show Attractions tab Show Restaurants tab Default Tab Number of Properties Map Property IDs Color Options Description Whether to include tab containing list of top hotels for the destination. True/false. Whether to include tab containing list of top attractions for the destination. True/false. Whether to include tab containing list of top restaurants for the destination. True/false. If more than one tab is included, which tab should be shown when the widget is loaded. Values are "Hotels", "Attractions", or "Restaurants". Number of top properties to display in each tab. Must be between 3 and 10, inclusive. Whether to use an existing TripAdvisor partner property mapping to look up location IDs. Allows partners to put their own IDs into the widget URL. True/false. Partners may provide an iframe background color and may select one of the predefined color sets (blue, brown, grey, default). Color sets determine the color of the title bar, border and heading of the widget. Default is TripAdvisor green. Color set may be overridden by a URL parameter (see above). Version 1.1 Page 5 of 10

6 5 Property Widgets The Property Widget actually consists of two widgets, Property Summary and Property Detail. Partners can implement the smaller Property Summary widget on their page, and configure that widget to have a link to show the Property Detail widget in a popup (or in a new window). Either widget can also be used alone. 5.1 Samples PROPERTY SUMMARY SAMPLES: Various configurations Showing overall traveler rating with widget border suppressed. Showing overall traveler rating and breakdown of rating scores. Showing overall traveler rating and 3 most recent review titles. Showing overall traveler rating, traveler photos, and 3 most recent review titles. Version 1.1 Page 6 of 10

7 PROPERTY DETAIL SAMPLE: Includes hotel name and address, traveler photos, TripAdvisor popularity index ranking, description, overall traveler rating, breakdown of rating scores, and recent traveler reviews. Reviews may be expanded inline so users may read the full text. Version 1.1 Page 7 of 10

8 5.2 Configuration Options Options described below are available in both the Detail and Summary version of the property widget unless specifically noted. Option Name Description Show Title Bar Whether to include TripAdvisor logo and tagline. True/false. (Summary widget only) Show Location Name Whether to include property name. True/false. (Summary widget only) Show Traveler Rating Whether to include overall traveler rating. True/false. Show Rating Whether to include chart breaking down number of reviews by rating. True/false. Breakdown Show Photos Whether to include candid property photos. True/false. Show Whether to include "What to Expect" and "Recommended For" rating categories. Recommendations True/false. Show Popularity Index Whether to include popularity index. True/false. (Detail widget only) Show Traveler's Whether to include a Traveler's Choice logo and category for any properties that Choice Awards have won a Traveler's Choice award. True/false. (Detail widget only) Show Description Whether to include description, if available, for hotels and attractions, or cuisine (Detail widget only) types for restaurants. True/false. Number of review titles (Summary widget) or review text snippets (Detail widget) Number of Reviews to display. Show Review Sort box (Detail widget only) Whether to include a "Sort by" dropdown for the reviews shown. True/false. The dropdown includes: Date: Newest first (default), Date: Oldest first, Member rating: Highest first, Member rating: Lowest first. Configuration of link at the bottom of the Summary widget that invokes the Detail Find out More link widget for that property. Values are "popup" (open link in a popup), "new" (open (Summary widget only) link in a new window), or disabled (no link shown). Popularity index link Configuration of link on the popularity index text. Values are "popup" (open link in (Detail widget only) a popup), "new" (open link in a new window), or disabled (no link shown). Write a Review link (Detail widget only) Read Reviews link (Detail widget only) Color Options Configuration of link to TripAdvisor's (or cobranded if available) Write a Review page for that property. Values are "popup" (open link in a popup), "new" (open link in a new window), or disabled (no link shown). Configuration of link to TripAdvisor's (or cobranded if available) Reviews page for that property. Values are "popup" (open link in a popup), "new" (open link in a new window), or disabled (no link shown). Partners may provide a widget background color, an iframe background color (for areas of the iframe outside the widget, if any), and choose whether to have a border. Version 1.1 Page 8 of 10

9 6 Check Rates Widget The Check Rates widget may be used alone or as a feature within a property detail widget. It is used to check availability and rates for a specific hotel. 6.1 Samples CHECK RATES BUTTON SAMPLES: Several button options may be placed on your hotel detail pages. Buttons are available in English, French, German, Italian and Spanish. CHECK RATES BUTTON WITHIN PROPERTY DETAIL WIDGET: A button may optionally be included in our property detail widget to allow users to search availability of a hotel. CHECK RATES POP-UP: Clicking the check rates button invokes a pop-up which lists providers with inventory available for the selected property. Users may select which providers to search. Version 1.1 Page 9 of 10

10 6.2 Configuration Options In addition to the configuration options below, the Check Rates widget supports the following optional URL options: "checkin" and "checkout". Both checkin and checkout must be specified, and must be valid dates in the format YYYYMMDD. If valid checkin and checkout dates are provided, these will be used to populate the default values for the hotel stay in the Check Rates popup window. The user can modify these default values if desired before generating the actual rate quotes. Option Name Button Image Button Text Border Color Other Color Options Partner Logo Description Image to use for the embeddable Check Rates button; must be an existing TripAdvisor image button. Do not use this option for text buttons. Resource string to use for an embeddable Check Rates text button, or for the alt text if an image button is provided. For text buttons, sets both the button border and text color. For text buttons, partners may provide a button background color and an iframe background color. The iframe background color will fill the iframe if no Check Rates inventory is available for the requested property. Partners may provide a logo image (235 pixels wide by 60 pixels high) that will be displayed at the top of the Check Rates popup. There is no link or ad call available from this image. 7 Questions and Support Please contact us at widgets@tripadvisor.com to find out more about TripAdvisor widgets for your site. Version 1.1 Page 10 of 10