Průvodce - API

Widget

Dotazník je zobrazen jako widget ve spodu webové stránky.

Může obsahovat pouze jednu otázku (celá studie se provádí pomocí widgetu) nebo několik otázek (pouze první otázka je prezentována ve widgetu, zatímco ostatní otázky budou otevřeny v nové záložce nebo na vrstvě na navštívené webové stránce). Nepostradatelná forma studie pro majitele webových stránek, kteří chtějí sbírat názory na svých webových stránkách.

Popis možných konfigurací widgetu

Název Popis Možné hodnoty
title Nadpis hlavičky widgetu
titleColor Barva hlavičky widgetu Každá barva v hexadecimálním zápisu
Výchozí barva: #6AA84F
position Pozice widgetu v okně prohlížeče left – levý spodní roh
right – pravý spodní roh
width Šířka widgetu v pixelech
height Výška widgetu v pixelech
initState Nastaví počáteční stav widgetu hidden – schovaný
sample – minimalizovaný
open – otevřený
disableAfterFill Určuje, zda bude widget skryt po vyplnění dotazníku true or false
disableAfterClose Určuje, zda bude widget schován po kliknutí na X true or false
capping Určuje, po kolika zobrazeních se widget již nezobrazí. Hodnota 0 znamená, že se widget bude zobrazovat neustále.
url Adresa dotazníku
surveyID ID dotazníku

Funkce pro volání

Funkce může být volána pouze po iniciaci widgetu s kódem staženým ze záložky Sběr.

  • Widget kompletně schován: feedbackWidgetBox.hide();
  • Widget minimalizován: feedbackWidgetBox.invitation();
  • Widget maximalizován: feedbackWidgetBox.show();
  • Přepne mezi maximalizovaným a minimalizovaným widgetem: feedbackWidgetBox.toggle();
  • Zobrazit hodnotu cappingu: feedbackWidgetBox.getCapping(); – tato funkce vrací počet zobrazení widgetu
  • Resetování cappingu: feedbackWidgetBox.resetCapping(); – tato funkce určuje počet zobrazení widgetu na 0

Události ke zpracování

Události mohou být definovány po iniciaci widgetu s kódem staženým ze záložky Sběr.

Funkce Důvod volání
feedbackWidgetBox.oninit Called after the initialization of the widget script is finished
feedbackWidgetBox.onchangeState Called when the state of the widget display is changed, function parameter returns the name of the state – show/hide/invitation
feedbackWidgetBox.onfilledSurvey Called after the survey is completed in the widget
feedbackWidgetBox.onclose Called when a user close the widget with X
feedbackWidgetBox.onshownAgain Called when the widget is not displayed because it was closed with X or the completed survey
feedbackWidgetBox.oncappingGained Called when the widget is not displayed because a set number of displays has been reached (capping)

Způsob definování funkcí a ukázky použití:

feedbackWidgetBox.oninit = function() {
    console.log('Widget inicializován');
    console.log('Hodnota cappingu: '+ feedbackWidgetBox.getCapping());
};

feedbackWidgetBox.onchangeState = function(state) {
    console.log('Změna stavu zobrazení widgetu (zobrazit/schovat/pozvánka): '+ state;
};

feedbackWidgetBox.onfilledSurvey = function() {
    console.log('Uživatel vyplnil dotazník ve widgetu');
};

feedbackWidgetBox.onclose = function() {
    console.log('Uživatel uzavřel widget s X');
};

feedbackWidgetBox.onshownAgain = function() {
    console.log('Uživatel vyplnil dotazník předtím nebo ho uzavřel - widget není zobrazen');
};

feedbackWidgetBox.oncappingGained = function() {
    console.log('Uživatel již widget viděl dostatečněkrát - capping byl naplněn')
};

Technická dokumentace pro widget na webovou stránku. Widget lze získat tím, že vytvoříte dotazník typu: „Widget“.

Pomohl Vám tento článek?

Děkujeme za odpověď