Parameter an die Buchungsstrecke u. a. übergeben (Deeplinking)
Roger Wesemann
Saskia Schneider
Um Einfluss auf die Ergebnisse innerhalb einer Integration nehmen zu können, haben Sie die Möglichkeit, mit Hilfe von Parametern die Ergebnisse einzuschränken oder den Einstiegspunkt (bspw. in der Buchungsstrecke) selbst festlegen zu können.
Wie kann man Parameter übergeben?
Je nach Einsatzzweck gibt es zwei Möglichkeiten, die Parameter zu übergeben:
1. Parameter im Script-Aufruf übergeben
Möchten Sie spezielle Integrationen vorfiltern oder vorselektieren, so können Sie das JavaScript-Snippet Ihrer Integration anpassen.
Beispiel:
<div id="vri-container-123"></div> <script type="text/javascript" charset="UTF-8"> ( function( v, i, o, m, a ){ if ( !( o in v ) ) { v.vioma_vri=o; v[o] || ( v[o] = function( ){ ( v[o].q = v[o].q || [] ).push( arguments ); } ); m = i.createElement( 'script' ), a = i.scripts[0]; m.src = 'https://cst-client-hotel-blaue-linde.viomassl.com/js/vri/vri.js'; a.parentNode.insertBefore( m, a ); } } )( window, document, 'vcst' ); vcst( {load: 'init', url: 'https://cst-client-hotel-blaue-linde.viomassl.com/', set_language: 'de'} ); vcst( {'id': 123} ); </script>
Um bei obigen Beispiel Parameter mit zu übergeben, können Sie (in Zeile 13) nach der ID, das Object erweitern und weitere Parameter übergeben. Hierbei ist zu beachten, dass die einzelnen Parameter kommasepariert und die Werte im Stil name:wert übergeben werden. Bitte achten Sie auch darauf, ob die Werte als String oder Integer übergeben werden müssen. Arrays werden als String übergeben.
vcst( {'id': 123,'calendar_date_from':'2015-07-20','calendar_stays':14,'persons_adults':3,'package':12345} );
Warnung
Bitte achten Sie darauf, dass der Syntax Ihres JavaScript-Snippets korrekt ist, sonst erzeugt das Snipptet einen JavaScript-Fehler auf Ihrer Seite und wird nicht geladen. Um sicher zu gehen, dass Ihr Snippet keine Fehler enthält, lassen Sie es von einem Online-Compiler überprüfen, bspw. Googles Closure Compiler.
2. Parameter als GET-Parameter in der URL mit übergeben
Bei der Übergabe der Parameter in der URL, hängt es zusätzlich davon ab, welche Seite Sie aufrufen. Je nach Integration sind es folgende Seiten:
Buchungsstrecke
vsc.php
Pauschalenliste
package-list.php
Zimmerliste
hotel-room-list.php
Programmliste
hotel-program-list.php
Die Parameter können dann im bekannten GET-Parameter-Stil übergeben werden:
http://www.hotel_domain/hotel_seite.html#/vsc.php?calendar_date_from=2015-07-20&calendar_stays=14&persons_adults=3&package=12345
Hinweis
Bitte beachten Sie die Zeichen "#/" hinter der aufgerufenen Seite. Dadurch werden die Parameter in die eingebettete Buchungsstrecke durchgeschleift.
Wichtig
Die URL-Parameter werden nur von der Integration beachtet, wenn zuvor in den Einstellung der Remote-Integration die Einstellung "URL-Parameter erlauben" aktiviert wurde:
Ausschnitt Einstellung der Remote-Integration
Das ist wichtig, da es möglich sein kann, dass auf einer Seite mehrere Remote-Integrationen eingebunden sind. Die Parameter würden sonst von allen Integrationen übernommen werden.
Globale Parameter
Bei allen Integrationen können Sie die gewünschte Sprache mit übergeben.
Hinweis
Bitte beachten Sie, dass Ihre Inhalte auch in der gewünschten Sprache gepflegt sein müssen, damit Sie in der entsprechenden Sprache erscheinen.
Parameter | Wert | Beispiel | Beschreibung |
---|---|---|---|
| String | 'de' | Mögliche Sprachen:
|
Parameter für die Buchungsstrecke
Für die Buchungsstrecke existieren folgende Parameter, die Sie übergeben können:
Kalender
Parameter | Beispiel | Beschreibung |
---|---|---|
| 2014-07-20 | Anreisetag in ISO-Format (YYYY-MM-DD) |
| 2014-07-20 | Abreisetag in ISO-Format (YYYY-MM-DD) |
| 14 | Anzahl Übernachtungen (als Integer) |
Es macht Sinn, "calendar_dates_to" oder "calendar_stays" zu verwenden. Wenn beide Parameter übergeben werden, wird der zuletzt angegebene Parameter berücksichtigt.
Personen
Parameter | Beispiel | Beschreibung |
---|---|---|
| 2 | Anzahl Erwachsene (als Integer) |
| 2 | Anzahl der Kinder (als Integer) |
| 3,7 | Alter der Kinder (als Integer Liste) |
Zimmer
Parameter | Beispiel | Beschreibung |
---|---|---|
| hrt:12345 , hrt:12345:123 , hrt:12345:123:2:3,7 oder hrt:::2:3,7 | "hrt" (hotel room type) + Zimmertyp ID (+ Pension + Erwachsene + Kinderalter) Der Parameter "items[]" kann mehrmals vorkommen (Siehe Beispiel 2) |
Programme
Parameter | Beispiel | Beschreibung |
---|---|---|
|
| "hp" (hotel program) + Programm ID ( + Anzahl) Der Parameter "items[]" kann mehrmals vorkommen (Siehe Beispiel 2) |
Pauschalen
Parameter | Beispiel | Beschreibung |
---|---|---|
| 1234 | Die ID der einzelnen Pauschale (als Integer) |
| 1234 | Die ID einer Pauschalengruppe (als Integer) |
Beispiel 1
Deeplink vom 05.01.2016 bis 07.01.2016, 3 Erwachsene und 3 Kinder im Alter 1, 4 und 7 mit automatischer Zimmerverteilung:
http://www.hotel_domain/hotel_seite.html#/vsc.php?calendar_date_from=2016-01-05&calendar_date_to=2016-01-07&persons_adults=3&persons_children_ages=1,4,7
Analog dazu das Snippet:
<div id="vri-container-123"></div> <script type="text/javascript" charset="UTF-8"> ( function( v, i, o, m, a ){ if ( !( o in v ) ) { v.vioma_vri=o; v[o] || ( v[o] = function( ){ ( v[o].q = v[o].q || [] ).push( arguments ); } ); m = i.createElement( 'script' ), a = i.scripts[0]; m.src = 'https://cst-client-hotel-blaue-linde.viomassl.com/js/vri/vri.js'; a.parentNode.insertBefore ( m, a ); } } )( window, document, 'vcst' ); vcst( {load: 'init', url: 'https://cst-client-hotel-blaue-linde.viomassl.com/', set_language: 'de'} ); vcst( { 'id':123, 'calendar_date_from':'2016-01-05', 'calendar_date_to':'2016-01-07', 'persons_adults':3, 'persons_children_ages':'1,4,7' } ); </script>
Beispiel 2
Deeplink bei Anreise am 05.01.2016 mit 2 Übernachtungen, 1 Zimmer mit 1 Erwachsenen im Einzelzimmer mit ID 11111 und Pension ID 2222, 1 Zimmer mit 2 Erwachsene und 2 Kinder im alter 4 und 7, 3x das Programm mit ID 12345:
http://www.hotel_domain/hotel_seite.html#/vsc.php?calendar_date_from=2016-01-05&calendar_stays=2&items[]=hrt:11111:2222:1&items[]=hrt:::2:4,7&items[]=hp:12345:3
Analog dazu das Snippet:
<div id="vri-container-123"></div> <script type="text/javascript" charset="UTF-8"> ( function( v, i, o, m, a ){ if ( !( o in v ) ) { v.vioma_vri=o; v[o] || ( v[o] = function( ){ ( v[o].q = v[o].q || [] ).push( arguments ); } ); m = i.createElement( 'script' ), a = i.scripts[0]; m.src = 'https://cst-client-hotel-blaue-linde.viomassl.com/js/vri/vri.js'; a.parentNode.insertBefore ( m, a ); } } )( window, document, 'vcst' ); vcst( {load: 'init', url: 'https://cst-client-hotel-blaue-linde.viomassl.com/', set_language: 'de'} ); vcst( { 'id': 123, 'calendar_date_from':'2016-01-05', 'calendar_stays':2, 'items[0]':'hrt:11111:2222:1', 'items[1]':'hrt:::2:4,7', 'items[2]':'hp:12345:3' } ); </script>
Parameter für das Gutscheinverkaufssystem
Aktuell gibt es keine Parameter, die an das Gutscheinverkaufssystem übergeben werden können.
Parameter für Listen (Zimmerliste, Pauschalenliste etc.)
Für die Integrationen, die Listen enthalten, gibt es ebenfalls Parameter. Diese sind bereits in den Einstellungen hinterlegt:
Zimmerlistenparameter
Parameter | Beispiel | Beschreibung |
---|---|---|
c[details_opened] | 1 | Wird der Wert 1 gesetzt, werden die Details automatisch aufgeklappt |
hotel | 1234 | Hotel-ID Anzeige von Zimmertypen für ein bestimmtes Hotel (Nur Multi-Property) |
c[id_list_room_types] | 1234, | Zimmertyp-ID Filter nach bestimmten Zimmertyp(en) |
c[id_list_room_groups] | 1234, | Zimmergruppen-ID Filter nach bestimmten Zimmergruppe(n) (Einzelzimmer, Doppelzimmer, Suite, etc.) |
c[id_list_roomtype_indicators] | 1234 | Indikatoren-ID Filter nach bestimmten Indikator(en) |
c[int_roomtype_catering] | 1234 | Verpflegungs-ID Filter nach einer bestimmten Verpflegungsart |
pension_id | 1234 | Pensions-ID Filter nach einer bestimmten Pension, bzw. Rate |
Pauschalenlistenparameter
Parameter | Beispiel | Beschreibung |
---|---|---|
c[details_opened] | 1 | Wird der Wert 1 gesetzt, werden die Details automatisch aufgeklappt |
type | 1 | Pauschalentyp-ID Filter nach bestimmten Pauschalentyp (bspw. Last Minute) |
hotel | 1234 | Hotel-ID Anzeige von Zimmertypen für ein bestimmtes Hotel (Nur Multi-Property) |
c[ids_hotels][] | c[ids_hotels][]=1234&c[ids_hotels][]=2345 | Hotel-IDs Filter nach mehreren Hotels (Nur Multi-Property) |
c[id_list_hotels] | c[id_list_hotels]=3884,4259 | Hotel-IDs - Alternative Filter nach mehreren Hotels (Nur Multi-Property) |
c[int_limit] | 5 | Anzahl pro Items Maximale Anzahl an Listenelementen |
c[int_limit_per_hotel] | 5 | Anzahl pro Items pro Hotel Maximale Anzahl an Listenelementen pro Hotel (Nur Multi-Property) |
c[int_list_stays] | 5 | Anzahl Übernachtungen |
[ints_stays][] | 5 | Anzahl Übernachtungen - Alternative |
c[int_stays] | 5 | Anzahl Übernachtungen - Alternative |
c[ids_packages][] | c[ids_packages][]=1234&c[ids_packages][]=2345 | Pauschalen-IDs Liste an speziellen Pauschalen |
c[id_variant_group] | 1234 | Pauschalen-Varianten Liste einer Pauschale inkl. aller Varianten. Die Varianten-ID kann man sich in der Pauschalenübersicht als Spalte einblenden lassen (hpa_variant_group). |
c[id_list_packages] | c[id_list_packages]=1234,2345 | Pauschalen-IDs - Alternative Liste an speziellen Pauschalen |
c[id_package] | 1234 | Pauschalen-Id Eine bestimmte Pauschale |
c[ids_roomtypes][] | c[ids_roomtypes][]=1234&c[ids_roomtypes][]=2345 | Zimmertypen-IDs Liste an speziellen Zimmertypen |
c[id_list_package_indicators] | 1234,2345 | Indikatoren-IDs Liste an speziellen Indikatoren |
c[id_package_indicator_ne] | 1234 | Ausschließende Indikatoren-ID Speziellen Indikator ausschliessen |
c[date_from] | 17.12.2015 | Anreisedatum |
c[date_to] | 17.12.2015 | Abreisedatum |
c[date_to_latest] | 17.12.2015 | Datum bis spätestens |
c[id_pension] | 1234 | Pensions-ID Filter nach einer bestimmten Pension, bzw. Rate |
c[id_pension_type] | 1234 | Pensionstyp-ID Filter nach einem bestimmten Pensionstyp |
c[bool_return_requestable] | 1 | Auf Anfrage Pauschalen, die nur "Auf Anfrage" erhältlich sind, werden mit diesem Paramenter mit ausgegeben |
Programmlistenparameter
Parameter | Beispiel | Beschreibung |
---|---|---|
hotel | 1234 | Hotel-ID Anzeige von Zimmertypen für ein bestimmtes Hotel (Nur Multi-Property) |
c[id_list_programs] | 1234,2345,3456 | Programm-IDs Filter von bestimmten Programmen |
c[id_list_program_indicators] | 1234,2345,3456 | Indikator-IDs Liste an speziellen Indikatoren |
Parameter der Restplatzbörse
Parameter | Beispiel | Beschreibung |
---|---|---|
days | 31 | Standardmäßig werden die Buchungslücken der nächsten 14 Tage angezeigt. Mit dem Parameter "days" können Sie die Anzahl der Tage verändern. |
limit_rooms | 2 | Die Variable "limit_rooms" limitiert die Anzahl der Verfügbaren Zeiträume pro Zimmer. |
limit_stays | 2 | Die Variable " limit_stays" limitiert die maximale Anzahl der angebotenen Übernachtungen. "limit_stays=2" bspw. gibt nur verfügbare Zeiträume aus mit max. 2 Übernachtungen. |