Integration Guide QdsInappWrapperLib für iOS

Die Einbindung der QdsInappWrapperLib erfolgt analog zur IOLib (siehe Implementierung iOS App).

Folgende Hinweise sind bei der Einbindung zusätzlich zu beachten:

Die QdsInappWrapperLib wird als "Framework" mit einer Shelldatei für den Build Prozess geliefert. Das Verzeichnis "QdsInappWrapperLib" wird in das Wurzelverzeichnis des Xcode-Projekts kopiert. Das Framework "QdsInappWrapperLib.framework" wird in das Xcode-Projekt gezogen.

Im anschließend erscheinenden Dialogfenster wird "Copy items if needed" angehakt. Außerdem sollte "Create groups" aktiviert sein. Dadurch sollte das Framework automatisch im Bereich "Linked Frameworks and Libraries" erscheinen. Falls das Framework nicht im Bereich "Linked Frameworks and Libraries" auftaucht, muss das Framework durch Ziehen und Ablegen vom Xcode Project Explorer dem Bereich "Linked Frameworks and Libraries" hinzugefügt werden.

Zudem sollte Xcode auch unter dem Reiter "Build Settings" in der Einstellung "Framework Search Paths" den Pfad zum Framework eingetragen haben. Ist dies nicht der Fall, muss dieser manuell nachgetragen werden.

Nun muss nur noch das Shell-Skript unter "Build Phases" eingebunden werden. Dazu muss auf dem "Build Phases"-Reiter über "New Run Script Phase" eine neue "Run Script"-Konfiguration angelegt werden. Ist das Verzeichnis "QdsInappWrapperLib", wie beschrieben, in das Wurzelverzeichnis des Xcode-Projekts kopiert worden erfolgt die Einbindung in der neuen "Run Script"-Phase mit:

$(PROJECT_DIR)/QdsInappWrapperLib/copy-framework.sh.

Als zusätzliche weitere "Linked Frameworks and Libraries" müssen "SystemConfiguration.framework" und "AdSupport.framework" eingebunden sein (siehe IOLib).

Um Zugriff auf alle benötigten Schnittstellen zu erhalten, muss die entsprechende Quelldatei die benötigte Header-Datei folgendermaßen importieren:

#import <QdsInappWrapperLib/QdsInappWrapperLib.h>

Funtionsweise

Die  QdsInappWrapperLib wird durch die Klasse QdsInappWrapper repräsentiert.  Eine konkrete Instanz dieser Klasse wird erzeugt mit:

[[QdsInappWrapper alloc] init];

Die QdsInappWrapperLib muss beim Aufruf der App initialisiert werden. Dieses geschieht über den oben erwähnten Aufruf.

Um das Anzeigen einer Befragungseinladung zu ermöglichen muss die Methode

startSession:offerIdentifier
  withCountryCode:countryCode

aufgerufen werden. Hier müssen der offerIdentifier und der Ländercode (mit "at") übergeben werden.
Der Parameter offerIdentifier ist die eindeutige Kennung des Angebots der jeweiligen App.
Der offerIdentifier wird von der ÖWA pro App und pro Betriebssystem eindeutig vergeben.

Wichtig:
Beim Start einer Session sollten im besten Fall alle anfänglichen Ladeprozesse abgeschlossen sein,
da unmittelbar nach dem Aufruf von startSession eine Befragungseinladung angezeigt werden kann.

[[[QdsInappWrapper alloc] init] startSession:@"offerIdentifier"
   withCountryCode:@"at"];

Falls beim Start der App Ladedialoge angezeigt werden, sollte startSession erst im Anschluss aufgerufen werden, da sonst der Dialog mit der Einladung zu früh angezeigt werden kann. Generell bedeutet der Aufruf von startSession, dass nach dem Aufruf der Methode ein Dialog mit einer Befragungseinladung angezeigt werden kann. startSession sollte dann aufgerufen werden, wenn die App bereit ist, bei Bedarf einen Fragebogen anzuzeigen. Grundsätzlich kann startSession immer wieder aufgerufen werden.

Hinweise:

Nach erfolgreicher Integration der QdsInappWrapperLib sollte die Einblendung der Befragungseinladung direkt nach dem initialen Starten der App und bei jedem Wechsel in den Vordergrund erfolgen. Falls dies aus technischen Gründen nicht möglich ist, muss als Alternative ein geeigneter Einstiegspunkt vom Entwickler gewählt werden. Wichtig ist, dass der Benutzer die Möglichkeit bekommt mit dem potentiellen Umfragedialog zu interagieren.

Die Opt-Out-Funktion wird von der QdsInappWrapperLib über die Befragungseinladung gesteuert, somit ist dafür keine weitere Aktion notwendig. Studien- und Datenschutzinformationen zur ÖWA Studie werden dem Befragungsteilnehmer innerhalb der Befragung bei Bedarf zur Verfügung gestellt.

Test-Einblendung Dialogfenster:

Um das Gerät als Testgerät zu markieren, verwenden Sie bitte den ÖWA-Checker. Die Dokumentation zum ÖWA-Checker erhalten Sie unter http://oewa.at/oewa-checker

Bitte überprüfen Sie die Einblendung des Befragungsfensters, die Klickbarkeit aller Schaltflächen sowie das Öffnen des Fragebogens durch einen Klick auf die Teilnehmen Schaltfläche.

Der Kunde ist für den Einbau der QdsInappWrapperLib im Einklang mit den jeweils gültigen Richtlinien der ÖWA verantwortlich. Der Kunde ist dafür verantwortlich, dass auch bei einer Änderung der App die Implementierung der Library korrekt ist.