Actions

Panel Integration

From LimeSurvey Manual

This page is a translated version of the page Panel integration and the translation is 30% complete.

Other languages:
Deutsch • ‎English • ‎日本語 • ‎Nederlands • ‎中文(中国大陆)‎


Help.png Die folgenden Beispiele und Erklärungen basieren ausschließlich auf den Beiträgen unserer Benutzer. Helfen Sie mit, wenn Sie unser frei-verfügbares Wissen über Panel-Integration erweitern möchten.


Einführung

Auf dieser Registerkarte können Sie einstellen, welche URL-Parameter von Ihrer Umfrage akzeptiert werden (diese Parameter werden an die allgemeine Start-URL der Umfrage angehängt). Diese Option ist wichtig, wenn Sie Ihre Umfrage mit einem professionellen Umfrage-Panel-Anbieter integrieren möchten, der Ihnen die Teilnehmer zur Verfügung stellt. Dieser übergibt in der Regel eine eindeutige ID jedes Umfrageteilnehmers und Sie müssen diese eindeutigen IDs zur weiteren Verwendung speichern/weitergeben.


Important.png
Attention : Bei einigen Anbietern muss die eindeutige ID des Teilnehmers, die aufgrund einer Quotenbeschränkung oder beim Beenden der Umfrage herausfallen, an den Panelanbieter in der End-URL oder Quoten-URL zurückgesendet werden.


Um auf die Panel-Integration Ihrer Umfrage zuzugreifen, gehen Sie in das Umfrage-Menü und klicken Sie auf die Registerkarte Panel-Integration.

Panel integration - tab.png


Umfrage-Panelintegration

Nach dem Zugriff wird eine leere Tabelle mit der Option "Hinzufügen eines URL-Parameters" angezeigt.


Add URL parameter button.png


Zwei Felder müssen ausgefüllt werden:

Add URL parameter.png
  • Parameter: Geben Sie in diesem Feld den Namen des neuen Parameters ein. Sie wird in die URL aufgenommen;
  • Zielfrage: Generell wird der URL-Parameter als Frage gespeichert. Es stellt den Ort dar, an dem die Befragten landen, sobald sie auf den Link klicken, der auch den oben definierten Parameter in seiner URL enthält.
Help.png Sie können den URL-Parameter auch als Antwort auf einen Kurzer Text- oder Mehrfacher kurzer Text- Fragetyp speichern (Sie können eine beliebige Kurztextfrage zum Speichern auswählen). Auch wenn Sie den Wert des URL-Parameters nicht speichern, können Sie diesen Parameter in der End-URL verwenden. Für weitere Dokumentation lesen Sie bitte weiter in der End-URL Wiki Sektion.


Wie benutzt man die Panel-Integrationsfunktion?

A simple example is presented below in which we try to explain how to use the panel integration function.


1) First, create a short/long text question and name it what ever you want (we will use "LS" for the Question code field). Then, enable the always hide this question option, located under the Display tab within the menu of the question.

Important.png
Attention : Make sure you disable the welcome page! Let them land on the page with the short/long free text question. The parameter cannot work in the welcome screen because the parameter has to be loaded into the question first!


2) Go to the panel integration tab, and click on the "Add URL parameter".

Select the short/long text question you created in the first step. The respondents that come from the respective professional panel provider will land on the target question. It can be hidden so that the respondents can directly start completing the survey.


Example - add URL parameter.png


The name you pick for the parameter will have to be included in the entry link that you will later supply to your panel provider. It will be named "LSid" in our example. Don't forget to click on the Save button located in the upper right part of the table!


3) Now, you have to set up the entry link that you will send to the your panel provider. To get your survey URL link, click on the Preview survey buttons.


Find the URL - panel integration.png


Copy the URL you accessed from the address bar:


URL preview question - panel integration.png


Help.png Hint: The "newtest" parameter is used in order to reset the session. This is useful when you wish to test locally the panel integration or when you know that your respondents are using the same device/browser to fill out the survey. Therefore, adding "newtest=Y" in the survey URL creates new answers in the responses table by forcing the creation of a new session regardless of the used device/browser..


Add at the end the newly added parameter: &LSid="xxxxxx". The link should look like this:

http://localhost/index.php/369498?newtest=Y&lang=en&LSid="xxxxxx"

Help.png Hint: The GET parameters use "?" for the first parameter and "&" for the rest of them. If you already have "?" in your URL, you must use "&" to add other GET parameters. Read about the GET parameters and their usage here.


What ever you replace the "xxxxxx" with will be grabbed and stored in the short/long free text question when your respondent lands on that page. For example, I sent to a user the following link:

http://localhost/index.php/369498?newtest=Y&lang=en&LSid=ABCD5

The string after LSid was stored as an answer to the short/long text question.


ABCD5 - panel integration.png


Help.pngRead the URL fields wiki section for more information on URL customization.

Examples

The following examples were created in order to help you easily add:

Help.png Note: parametername={PASSTHRU:parametername}" provides the panel provider the id of the respondent.


Important.png
Attention : The solutions provided below make use of the passthrough fields. Please note that aside "parametername={PASSTHRU:parametername}", everything else has to be provided by your panel provider!


The complete link

The complete link has to be inserted into the end URL field that also has to be loaded automatically for everyone who successfully completes the whole survey.

The URL you have to send back to the panel provider should look like this:

https://panelproviderwebsite.com/?return=complete&parametername={PASSTHRU:parametername}


The screenout link

A screenout excludes the participants from continuing the survey because he or she is not a member of your survey target group. For screenouts, you have to set the quota limit field to "0" (zero) and allow the quota URL to be automatically loaded once it was triggered.

Then, add the following link into the quota URL field:

https://panelproviderwebsite.com/?return=screenout&parametername={PASSTHRU:parametername}

Help.png Note: Read the following wiki section to find out more about the LimeSurvey quota system and its usage.


The quotafull link

A quotafull excludes participants from continuing the survey, because a certain quota has been exceeded. https://panelproviderwebsite.com/?return=quotafull&parametername={PASSTHRU:parametername}

Help.png Note: Read the following wiki section to find out more about the LimeSurvey quota system and its usage.


This is not the only solution you can use to implement quotafull, complete and screenout redirects to your panel provider! For example, the Expression Manager, the SQGA indentifiers, and the URL fields offer you different workarounds to complete the same tasks (and even the more complex ones). For additional help, check also the LimeSurvey forum.