Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- de:survey:url [20.01.2016 14:03] – [Interview-Kennung (i)] admin
+++ de:survey:url [20.03.2024 21:19] (aktuell) – alte Version wiederhergestellt (19.12.2023 07:31) admin
@@ Zeile 3: / Zeile 3: @@
 Jede Internetseite hat eine eindeutige Adresse, die URL. So auch der Fragebogen. Damit Internetnutzer auf den Fragebogen zugreifen können, benötigen sie diese Adresse. Normalerweise wird diese Adresse als Link auf einer Website verknüpft oder man schickt sie direkt (z.B. via E-Mail) an die potenziellen Teilnehmer.
-Dieses Kapitel gibt einige Tipps, welchen URL man am besten verwendet und welche Möglichkeiten es gibt.
-===== Die URL des Fragebogens =====
+===== Die URL des Befragungsprojekts =====
 Zunächst einmal setzt sich die Adresse des Fragebogen aus der URL von SoSci Survey (z.B. ''%%https://www.soscisurvey.de%%'') und dem Projektverzeichnis (z.B. ''demo'') zusammen. Zwischen den beiden Bestandteilen steht ein Schrägstrich (''/''). Ebenso steht ein Schrägstrich am Ende, weil ja ein (Projekt-)Verzeichnis und keine Datei gemeint ist: ''%%https://www.soscisurvey.de/demo/%%''.
-Lässt man den Schrägstrich am Ende weg, wird der Teilnehmer dennoch automatisch auf das Verzeichnis weitergeleitet -- daran zu sehen, dass der Schrägstrich in der Adressezeile des Browsers ergänzt wird. Diese Weiterleitung dauert allerdings einen kurzen Moment.
+Den Link zu Ihrem Befragungsprojekt finden Sie unter **Befragungsprojekt** -> **Projekt-Einstellungen** -> Karteireiter //Fragebogen veröffentlichen// -> //Projektverzeichnis//. Dort können Sie das Projektverzeichnis auch ändern -- allerdings nur solange der //Befragungszeitraum// noch nicht angelaufen ist. Sie können den Befragungszeitraum bei Bedarf jederzeit ändern (z.B. den Beginn des Zeitraums auf das morgige Datum einstellen).
-===== Parameter im Link =====
+**Hinweis:** Lässt man den Schrägstrich am Ende weg, wird der Teilnehmer dennoch automatisch auf das Verzeichnis weitergeleitet -- daran zu sehen, dass der Schrägstrich in der Adressezeile des Browsers ergänzt wird. Diese Weiterleitung dauert allerdings einen kurzen Moment.
-Um weitere Optionen im Link festzulegen, sollte man die GET-Syntax des HTTP-Protokolls kennen. Man muss SoSci Survey nämlich durch den Link mitteilen, was man gerne hätte.
-So gibt es z.B. einen Parameter ''q'' (//questionnaire//), mit dem man einen von mehreren Fragebögen im Projekt auswählen kann. Ein anderer Parameter ist ''r'' (//reference//); mit diesem kann man den Link "markieren" (s. unten).
+===== Parameter im Fragebogen-Link =====
-Solche Parameter bestehen immer aus dem Namen der Variable (also z.B. ''q'' oder ''r'') und dem zugehörigen Wert. Dazwischen steht ein Gleichheitszeichen (''=''). Wenn also der gewünschte Fragebogen die Kennung "fb1" hat und als Referenz "banner" gespeichert werden soll, dann lauten die Parameter ''q=fb1'' und ''r=banner''. Mehrere Parameter werden mit dem kaufmännischen Und (''&'') verbunden, also ''q=fb1&r=banner''.
+Im Link kann man SoSci Survey weitere Anweisungen und Informationen übermitteln. Etwa welcher Fragebogen geöffnet werden soll (wenn es im Projekt mehrere gibt) oder dass der Datensatz eine Markierung/Referenz erhält (z.B. in welche Teilgruppe der Teilnehmer gehört).
-Zu guter Letzt werden die Parameter mit einem Fragezeichen (''?'') an die eigentliche URL angehängt, also ''%%https://www.soscisurvey.de/demo/?q=fb1&r=banner%%''.
-Wenn man nun diese Adresse im Internetbrowser aufruft, so wird die Internetseite %%https://www.soscisurvey.de/demo/%% aufgerufen und ihr werden die beiden Parameter für ''q'' und ''r'' geschickt. Da es sich nicht um irgend eine Internetseite handelt, sondern um ein Befragungsprojekt, wird ''q'' zur Auswahl des Fragebogens verwendet und der Wert für ''r'' im Datensatz gespeichert.
+==== Parameter ====
+Die Anweisungen/Informationen (Parameter) sind immer gleich aufgebaut: Es gibt einen Schlüssel, der angibt um welchen Parameter es sich handelt, und einen Wert, der für diesen Parameter übermittelt werden soll. Parameter bzw. Schlüssel sind verfügbar:
+  * [[#auswahl_des_fragebogens_q|q - Auswahl des Fragebogens]] (falls im Projekt mehrere Fragebögen angelegt wurden)
+  * [[#einen_link_markieren_r|r - Referenz/Markierung des Datensatzes]] (Variable REF)
+  * [[#teilnahmecode_uebergeben_s|s - Teilnahmecode des Teilnehmers]] (Variable SERIAL)
+  * [[#sprachversion_vorgeben_l|l - Sprachversion vorgeben]] (für mehrsprachige Befragungsprojekte)
+  * [[#passwort_password|password - Passwort für passwortgeschützten Fragebogen]]
+  * [[#interview-kennung_i|i - Interne Kennung des Interviews]] (zum Fortsetzen eines unterbrochenen Interviews)
+  * [[#teilnahmecode_serienmails_d|d - Teilnahmecode für Serienmails]] (wird von Serienmails automatisch erzeugt)
+  * Darüber hinaus können Sie [[#benutzerdefinierte_variablen|eigene Parameter]] übermitteln
+==== Verwendung im Link ====
+Um Parameter im Link festzulegen, muss man sich ein wenig mit der GET-Syntax des HTTP-Protokolls befassen:
+  * Zwischen Schlüssel und Wert steht ein Gleichheitszeichen (''='')\\ ''q=fragebogen2''
+  * Mehrere Parameter werden durch ein kaufmännisches Und (''&'') getrennt\\ ''q=fragebogen2&r=g1''
+  * Zwischen dem Link zum Befragungsprojekt (s. oben) und dem Parameter steht ein Fragezeichen (''?'')\\ ''%%https://www.soscisurvey.de/demo/?q=fragebogen2&r=g1%%''
+==== Hinweise ====
+**Warnung:** Wenn Sie einen Link in Outlook oder Word einfügen, dann wird unterschieden zwischen dem Text, der angezeigt wird und wohin der Link tatsächlich verweist (zum Ausprobieren: [[https://duckduckgo.com/?q=hyperlink|www.soscisurvey.de]]). Wenn Sie den Link in einer E-Mail oder einem Dokument ändern, dann stellen Sie bitte sicher (z.B. mittels Rechtsklick -> //Hyperlink bearbeiten//), dass nicht nur der angezeigte Text, sondern auch der dahinter liegende Link geändert wurde.
+**Hinweis:** Um die nachfolgend dokumentierten Parameter zu verwenden, sind __keine__ Anpassungen in SoSci Survey bzw. in den Projekt-Einstellungen erforderlich. Kopieren Sie einfach den [[#die_url_des_befragungsprojekts|regulären Link zum Fragebogen]] (z.B. ''%%https://www.soscisurvey.de/example/%%''), schreiben Sie die Parameter (z.B. ''%%?r=Berlin%%'') dahinter und fügen Sie den so ergänzten Link (''%%https://www.soscisurvey.de/example/?r=Berlin%%'') in einer E-Mail oder als Link auf einer Website ein.
+**Hinweis:** Lesen Sie bitte [[#verwendung_im_link|oben]], was es mit dem Fragezeichen (''?'') und dem kaufmännischen Und (''&'') auf sich hat und wie diese im Link verwendet werden.
+**Hinweis:** Die Schlüssel für die Parameter kann man ggf. unter **Befragungsprojekt** -> **Projekt-Einstellungen** -> Karteireiter //Spezielles// -> //Variablen im Link zum Fragebogen// anpassen. Normalerweise ist das aber __nicht__ notwendig und wir raten i.A. davon ab, die Schlüssel zu ändern.
+===== Beispiel =====
+In einem Befragungsprojekt werden 3 Zielgruppen adressiert. Im Befragungprojekt sind zwei Fragebögen "q1" und "q2" angelegt. Die Zielgruppen "A" und "B" sollen den Fragebogen "q1" bekommen und Zielgruppe "C" den Fragebogen "q2". Im Datensatz soll anschließend erkennbar sein, zu welcher Zielgruppe jede Datenzeile gehört.
+Zielgruppe "A" wird in einem Forum angesprochen. Dort wird folgender Link platziert:
+    https://www.soscisurvey.de/demo/?r=A&q=q1
+Zielgruppe "B" wird über einen Banner rekrutiert. Der Banner ruft folgenden Link auf:
+    https://www.soscisurvey.de/demo/?r=B&q=q1
+Und Zielgruppe "C" wird per E-Mail eingeladen. Über den E-Mail-Verteiler des Unternehmens wird folgender Link verschickt:
+    https://www.soscisurvey.de/demo/?r=C&q=q2
+Wird der Fragebogen über den ersten Link aufgerufen, wird im Datensatz in Variable "REF" der Wert "A" gespeichert - entsprechend "B" und "C" für die anderen beiden Links.
+**Wichtig:** Lesen Sie bitte die [[#hinweise|Hinweise]] (oben).
 ===== Auswahl des Fragebogens (q) =====
-Falls man im Befragungsprojekt mehrere Fragebögen angelegt hat, kann man entscheiden, welcher Fragebogen angezeigt wird. Dafür gibt es zwei Möglichkeiten (s. auch [[:de:create:random_questionnaire|Zufallsauswahl für Fragebögen]]):
+Falls man im Befragungsprojekt mehrere Fragebögen angelegt hat, kann man entscheiden, welcher Fragebogen angezeigt wird.
+Unter **Fragebogen zusammenstellen** -> **Fragebögen verwalten** können Sie einen //Standard-Fragebogen// auswählen. Dieser wird immer dann verwendet, wenn der Link zum Befragungsprojekt ohne genauere Spezifikation eines Fragebogens aufgerufen wird. Falls notwendig, kann man in diesem Fragebogen auch eine [[:de:create:random_questionnaire]] einbauen.
+Die Auswahl eines Fragebogens im Link erfolgt über den Parameter ''q'' und die Kennung des gewünschten Fragebogens. Zur Auswahl des Fragebogens "fb" im Projekt "demo" würde man also z.B. folgenden Link versenden:
+<code>
+https://www.soscisurvey.de/demo/?q=fb
+</code>
+**Tipp:** Wenn Sie mehrere Fragebögen im Befragungsprojekt erstellt haben, finden Sie unter **Fragebogen zusammenstellen** -> **Fragebögen verwalten** bereits alle entsprechenden //Internet-Adressen (URLs) zum Aufruf eines Fragebogens// aufgelistet.
+**Tipp:** Wenn Sie [[:de:survey:mailing|Serienmail versenden]], dann legen Sie den gewünschten Fragebogen direkt in der Serienmail im Karteireiter //Fragebogen-Link// fest. Die Auswahl des Fragebogens wird dann zusammen mit den weiteren Einstellungen im individuellen Teilnahmelink hinterlegt.
-  - //Standard-Fragebogen:// Wenn von mehreren angelegten Fragebögen nur einer verwendet werden soll, so definiert man diesen unter **Fragebogen zusammenstellen** -> //Zufallsauswahl für Fragebögen// als Standard-Fragebogen. Wann immer man das Projektverzeichnis __ohne__ weitere Angaben aufruft, wird nun dieser Fragebogen angezeigt.
-  - //Gezielte Auswahl:// Um gezielt einen Fragebogen auszuwählen, verwendet man den Parameter ''q'' und die Kennung des Fragebogens. Zur Auswahl der Fragebogens "fb" im Projekt "demo" also z.B. ''%%https://www.soscisurvey.de/demo/?q=fb%%''.
-  - //Zufällige Auswahl:// Falls man möchte, dass SoSci Survey zwischen mehreren Fragebögen zufällig einen auswählt, kann man dies unter **Fragebogen zusammenstellen** -> //Zufallsauswahl für Fragebögen// einstellen. Wann immer man das Projektverzeichnis __ohne__ Angabe von ''q'' aufruft, wird dann einer der gewählten Fragebögen verwendet.
 ===== Einen Link markieren (r) =====
@@ Zeile 41: / Zeile 99: @@
 **Hinweis:** Prinzipiell kann man in der Referenz alle Zeichen bis auf einfache (''%%'%%'') und doppelte Anführungszeichen (''%%"%%'') sowie ist-gleich-Zeichen (''%%=%%'') und das kaufmännische Und (''&'') verwenden. Leerzeichen und Sonderzeichen können Probleme machen, sie werden u.U. vom Browser falsch übertragen. Falls man Probleme vermeiden will, sollte man sich daher in der Referenz auf Buchstaben, Zahlen und den Unterstrich (_) beschränken.
-===== Seriennummer übergeben (s) =====
+**Hinweis:** Bitte lesen Sie die [[#hinweise|Hinweise]] (oben).
-Eine besondere Form der Markierung stellt die Seriennummer dar. Dies ist ein Einmal-Passwort, das einem Teilnehmer Zugang zum Fragebogen mit [[:de:create:access|Zugriffsbeschränkung]] //Seriennummer// gewährt.
-Damit das funktioniert, muss jeder Teilnehmer eine gültige Seriennummer bekommen. Natürlich soll er sie nicht unbedingt per Hand eintippen -- deshalb kann die Seriennummer mit dem Parameter ''s'' an den Link geheftet werden: ''%%https://www.soscisurvey.de/demo/?s=AB123456%%''.
+===== Teilnahmecode übergeben (s) =====
-**Tipp:** Wenn man mittels Seriennummer personalisierte Links verschickt, dann können die Teilnehmer die Befragung unterbrechen und später mit dem personalisieren Link wieder fortsetzen. Das funktioniert auch, wenn der Fragebogen prinzipiell öffentlich zugänglich ist. Allerdings muss jeder Teilnehmer eine individuelle Seriennummer erhalten, also vorab bekannt sein.
+Eine besondere Form der Markierung stellt der Teilnahmecode dar ([[:de:survey:serials]]). Dies ist ein Einmal-Passwort, das einem Teilnehmer Zugang zum Fragebogen mit [[:de:create:access|Zugriffsbeschränkung]] //Teilnahmecode// gewährt.
-**Wichtig:** Mit einer Seriennummer kann man im Befragungsprojekt genau einen Fragebogen vollständig ausfüllen. Anschließend ist die Seriennummer verbraucht.
+Damit das funktioniert, muss jeder Teilnehmer einen gültigen Teilnahmecode bekommen. Natürlich soll er diesen nicht unbedingt per Hand eintippen -- deshalb kann der Teilnahmecode mit dem Parameter ''s'' an den Link geheftet werden: ''%%https://www.soscisurvey.de/demo/?s=AB123456%%''.
-===== Teilnahmecode Serienmails (d) =====
+Teilnahmecodes dürfen nur Buchstaben (A-Z) und Ziffern (0-9) enthalten.
-Verschickt man eine [[mailing|Serienmail]] via SoSci Survey und verwendet den Platzhalter ''%link%'' für personalisierte Links, so fügt SoSci Survey den Parameter ''d'' (delivery ID) an.
+**Tipp:** Wenn man mittels Teilnahmecode personalisierte Links verschickt, dann können die Teilnehmer die Befragung unterbrechen und später mit dem personalisieren Link wieder fortsetzen. Das funktioniert auch, wenn der Fragebogen prinzipiell öffentlich zugänglich ist. Allerdings muss jeder Teilnehmer einen individuellen Teilnahmecode erhalten, also vorab bekannt sein.
+**Wichtig:** Mit einem Teilnahmecode kann man den Fragebogen nur einmal vollständig ausfüllen. Mehr Details s. [[:/de:survey:mailing#Teilnahmecodes|Serienummern]].
-Hierbei handelt es sich um einen Programm-internen Code, der pro Serienmail und Teilnehmer neu erstellt wird. Den Parameter ''d'' sollte man daher i.d.R. SoSci Survey überlassen und nicht selbst verwenden.
 ===== Sprachversion vorgeben (l) =====
@@ Zeile 62: / Zeile 120: @@
 Beispiel: ''%%https://www.soscisurvey.de/demo/?l=eng%%''
 ===== Passwort (password) =====
 Falls man den Fragebogen durch ein Passwort geschützt hat, kann man selbiges im Link übergeben. Der Parameter dafür lautet ''password''. Lautet das Passwort "geheim", so würde folgender Link Zugriff auf den Fragebogen gewähren: ''%%https://www.soscisurvey.de/demo/?password=geheim%%''.
+Die Adresse des Fragebogens im Projektverzeichnis wird jedoch nicht geändert und lautet daher nach wie vor ''%%https://www.soscisurvey.de/demo/%%''.
 Es macht natürlich wenig Sinn, einen Link mit Passwort auf einer Website zu platzieren. Wenn jeder den Link anklicken kann, ist der Passwort-Schutz wertlos. Sinnvoller ist die Übergabe des Passworts, wenn man eine E-Mail verschickt. Die sichere Lösung ist hier aber die Serienmail.
-Mit dem Parameter ''password'' kann man übrigens auch das Passwort für den Pretest im Link verschicken (s. Beispiel unten).
-===== Pretest-Modus variieren (debug) =====
-Wenn ein Fragebogen im Pretest ist, dann können die Tester entweder eine spezielle Pretest-Version mit Möglichkeit zum Feedback sehen -- oder den Original-Fragebogen. Der Pretest-Modus ist während des Pretests Standard. Durch Angabe des Parameters ''debug'' (hier muss ausnahmsweise kein Wert angegeben werden) wird hingegen der Original-Modus aktiviert: ''%%https://www.soscisurvey.de/demo/?debug%%''.
-Wenn man den Fragebogen im Original-Layout zeigen möchte und dem Empfänger keine Passwort-Eingabe zumuten möchte, dann kann man die beiden Parameter auch kombinieren, z.B. ''%%https://www.soscisurvey.de/demo/?debug&password=geheim%%''.
 ===== Interview-Kennung (i) =====
@@ Zeile 82: / Zeile 137: @@
 Ist die Kennung eines laufenden Interviews bekannt (z.B. weil sie an eine externe Website übergeben wurde), so kann das Interview durch Angabe des Parameters ''i'' fortgesetzt werden:  ''%%https://www.soscisurvey.de/demo/?i=12345abcde%%''.
+===== Teilnahmecode Serienmails (d) =====
+Verschickt man eine [[mailing|Serienmail]] via SoSci Survey und verwendet den Platzhalter ''%link%'' für personalisierte Links, so fügt SoSci Survey den Parameter ''d'' (delivery ID) an.
+Hierbei handelt es sich um einen Programm-internen Code, der pro Serienmail und Teilnehmer neu erstellt wird. Den Parameter ''d'' sollte man daher i.d.R. SoSci Survey überlassen und nicht selbst verwenden.
 ===== Benutzerdefinierte Variablen =====
-Mit der PHP-Funktion ''[[:de:create:functions:readget|readGET()]]'' kann man unter bestimmten Voraussetzungen beliebige Variablen aus dem Fragebogen-Link einlesen.
+Mit dem Fragetyp [[:de:create:questions:client|Gerät und übermittelte Variablen]] kann man unter bestimmten Voraussetzungen beliebige Variablen aus dem Fragebogen-Link einlesen.
-Neben den oben genannten Variablen (''q'', ''r'', ''s'', ''d'', ''l'', ''password'', ''debug'') sollten folgende reservierte Variablen nicht verwendet werden, um benutzerdefinierte Daten zu übermitteln: ''a'', ''act'', ''adid'', ''ajax'', ''file'', ''image'', ''info'', ''script'', ''sp'', ''t''
+Neben den oben genannten Variablen (''q'', ''r'', ''s'', ''d'', ''l'', ''password'') sollten folgende reservierte Variablen nicht verwendet werden, um benutzerdefinierte Daten zu übermitteln: ''a'', ''act'', ''adid'', ''ajax'', ''debug'', ''file'', ''image'', ''info'', ''library'', ''script'', ''sp'', ''t''
 Wenn Sie sicherstellen möchten, dass eine benutzerdefinierte Variable nicht mit Standard-Variablen von SoSci Survey kollidiert, wählen Sie einen Namen, der mit ''u'' beginnt. Solche Variablen sind explizit für die benutzerdefinierte Nutzung reserviert.