Erweiterte Einstellungen - Vungle iOS SDK v.1.0 - v.4.1

Inhaltsverzeichnis

  1. Die Vungle SDK-Instanz
  2. Angepasste Werbeerlebnisse
  3. Zusätzliche VungleSDK-Protokolle

Bevor Sie anfangen...

In diesem Artikel werden die erweiterten Einstellungen für das Vungle iOS SDK behandelt. Falls Sie mit unserem iOS SDK noch nicht vertraut sind, sollten Sie zunächst das Handbuch Erste Schritte für iOS lesen.

Die VungleSDK-Instanz

Instanzeigenschaften

Die VungleSDK-Singleton-Instanz bietet einige Eigenschaften, mit denen Sie das Werbeerlebnis der Endbenutzer anpassen oder wichtige Ereignisdaten erhalten können.  Sie sind nachfolgend aufgeführt:

muted (BOOL): Steuert, ob präsentierte Werbevideos beim Starten stummgeschaltet sind oder nicht
delegate (id<VungleSDKDelegate>): Eigenschaft, die nach dem VungleSDKDelegate-Protokoll zugewiesen werden kann und es Apps ermöglicht, asynchrone Rückrufe für bestimmte SDK-Ereignisse zu empfangen
assetLoader (id<VungleAssetLoader>): Eigenschaft, die nach dem VungleAssetLoader-Protokoll zugewiesen werden kann und es Apps ermöglicht, die benötigten Ressourcen im Haupt-VungleSDK playAd ViewController zu überschreiben

 

Instanzmethoden & Hilfskonstanten

(BOOL)isAdPlayable; Gibt YES zurück, falls im Zwischenspeicher eine Werbung bereit steht und für den aktuellen Benutzer keine Einschränkungen bezüglich der täglichen Zahl der Werbevideos oder Bewertungen vorhanden sind. Es wird nicht überprüft, ob ein Streaming-Werbevideo verfügbar ist, selbst wenn sich der Herausgeber für Streaming registriert hat.
(NSDictionary*)debugInfo; Gibt ein NSDictionary-Element mit verschiedenen Debug-Information über das VungleSDK-Singleton zurück
(void)setLoggingEnabled:(BOOL)enable; Aktiviert oder deaktiviert die standardmäßige Protokollierungsfunktion im VungleSDK-Singleton.  Protokollierte Ereignisse und Informationen werden auf der Konsole ausgegeben.  Zur Verarbeitung einzelner Protokollereignisse beachten Sie die attachLogger-Methode weiter unten.
(void)log:(NSString*)message, ... NS_FORMAT_FUNCTION(1,2); Protokolliert die angegebene Meldung auf der Konsole und in allen angefügten VungleSDKLogger-Instanzen.
(void)attachLogger:(id<VungleSDKLogger>)logger Ermöglicht es der App, eine Klasse nach dem VungleSDKLogger-Protokoll an die VungleSDK-Singleton-Instanz anzufügen. Das angefügte Protokollierungsprogramm empfängt jedes vom SDK verarbeitete Protokollereignis.  Um Speicherlecks zu vermeiden, ist es wichtig, das Protokollierungsprogramm ordnungsgemäß zu trennen, sobald es nicht mehr benötigt wird.  DieVungleSDK-Singleton-Instanz behält das angefügte Protokollierungsprogramm solange, bis dieses ordnungsgemäß entfernt wurde.
(void)detachLogger:(id<VungleSDKLogger>)logger; Entfernt ein Protokollierungsprogrammobjekt.
NSString* VungleSDKVersion Eine Zeichenfolgenkonstante, die die aktuelle Version des Vungle iOS SDK angibt.  Inklusive Haupt- und Nebenversionen.

Angepasstes Werbeerlebnis

Die playAd-Methode des VungleSDK-Singletons kann einen NSDictionary-Parameter annehmen, mit dem eine App das Werbeerlebnis individuell anpassen kann.  Alle gültigen Schlüssel/Wert-Paare im NSDictionary-Parameter überschreiben den Standardwert der angegebenen Einstellung. Alle Schlüssel können optional zum Wörterbuch hinzugefügt werden. Die im NSDictionary-Parameter enthaltenen Einstellungen betreffen nur einen einzelnen playAd-Aufruf. Ein Beispiel eines Optionswörterbuchs finden Sie in Zeile 111 oder 131 der Beispiel-App.

Schlüssel Standardwert / Typ Beschreibung
VunglePlayAdOptionKeyIncentivized NO
NSNumber steht für einen booleschen Wert.
Durch Markieren einer Werbungswiedergabe als incentivized erfolgt ein leicht unterschiedliches Verhalten als bei einem standardmäßigen playAd-Aufruf, sowohl aus dem lokalen SDK als auch von den Vungle Werbungsservern. Mit dieser Funktion können das Verhalten und die Funktion zwischen Werbung mit Anreiz und normaler Werbung abgegrenzt werden.  Eine genaue Erörterung der Unterschiede zwischen Werbung mit und ohne Anreiz finden Sie hier in der Dokumentation.
VunglePlayAdOptionKeyOrientations UIInterfaceOrientationMaskAll
Eine NSNumber steht für eine Bitmaske mit Ausrichtungen (Standard: autorotate).
Legt die Ausrichtung der Werbung fest. Wir empfehlen, automatisches Drehen (autorotate) für Werbevideos zuzulassen, selbst wenn Ihre App nur im Hochformat verwendet wird. So hat der Benutzer die Möglichkeit, Videos in voller Größe anzusehen und ein besseres Benutzererlebnis zu genießen. Sie erreichen dies, indem Sie die Ausrichtung auf Ebene des Ansichtscontrollers festlegen (und nicht auf Projektebene).
VunglePlayAdOptionKeyUser nil
NSString mit Benutzerkennung, die bei einer Werbung mit Anreiz (incentivized) übergeben wird.
Der Wert wird als "user" bei einem Server-zu-Server-Aufruf mit Anreiz übergeben.
VunglePlayAdOptionKeyIncentivizedAlertTitleText nil
NSString
Zeichenfolge, die als Titel des Warndialogfelds verwendet wird, das angezeigt wird, wenn ein Benutzer eine Werbung mit Anreiz vorzeitig schließt.
VunglePlayAdOptionKeyIncentivizedAlertBodyText Möchten Sie diese Werbung wirklich überspringen? In diesem Fall erhalten Sie unter Umständen nicht Ihre Belohnung
NSString
Zeichenfolge, die als Text des Warndialogfelds verwendet wird, das angezeigt wird, wenn ein Benutzer eine Werbung mit Anreiz vorzeitig schließt.
VunglePlayAdOptionKeyIncentivizedAlertCloseButtonText Schließen
NSString
Zeichenfolge, die als Beschriftung der Schaltfläche „Schließen" in dem Warndialogfeld verwendet wird, das angezeigt wird, wenn ein Benutzer eine Werbung mit Anreiz vorzeitig schließt.
VunglePlayAdOptionKeyIncentivizedAlertContinueButtonText Fortfahren
NSString
Zeichenfolge, die als Beschriftung der Schaltfläche „Schließen" in dem Warndialogfeld verwendet wird, das angezeigt wird, wenn ein Benutzer eine Werbung mit Anreiz vorzeitig schließt.
VunglePlayAdOptionKeyExtraInfoDictionary nil
NSDictionary mit den zusätzlichen Schlüsseln (Definition weiter unten).
Einfaches Metadaten-Wörterbuch, mit dem Messgrößen wie Altersgruppe, Geschlecht usw. verfolgt werden können.
VunglePlayAdOptionKeyExtra1..8 nil
NSString, der jede verfolgte Benutzermessgröße darstellt.
IN KÜRZE VERFÜGBAR: Diese Funktion ist noch nicht vollständig entwickelt. Sobald sie fertig ist, können Sie damit die hier aufgeführten acht Schlüssel zum Verfolgen zusätzlicher Informationen über Werbungsplatzierung, Benutzerdaten usw. sowie für die Berichterstellung nutzen.

Protokolle

VungleSDKDelegate-Protokoll


@protocol VungleSDKDelegate 
- (void)vungleSDKAdPlayableChanged:(BOOL)isAdPlayable;
- (void)vungleSDKwillShowAd;
- (void)vungleSDKwillCloseAdWithViewInfo:(NSDictionary*)viewInfo willPresentProductSheet:(BOOL)willPresentProductSheet;
- (void)vungleSDKwillCloseProductSheet:(id)productSheet;
@end    

VungleSDKDelegate-Methoden

Sie können den VungleSDK-Delegaten implementieren, der Sie bei einigen hilfreichen Ereignissen im Zusammenhang mit dem Werbeerlebnis benachrichtigt.

Methode Beschreibung
(void)vungleSDKAdPlayableChanged:(BOOL)isAdPlayable Wird aufgerufen, wenn das VungleSDK den Werbungsverfügbarkeitsstatus geändert hat.  isAdPlayable Boolescher Wert gibt die neue Wiedergabefähigkeit des Vungle SDK an
(void)vungleSDKwillShowAd Wird aufgerufen, wenn das VungleSDK gleich ein Werbevideo wiedergeben wird.  Mit der Überschreibung dieser Methode lassen sich Spiele, Audioeffekte, Animationen usw. sehr gut anhalten.
(void)vungleSDKwillCloseAdWithViewInfo:
(NSDictionary *)viewInfo  willPresentProductSheet:(BOOL)willPresentProductSheet

Es gibt drei Wege, auf die ein Nutzer ein Werbeerlebnis verlassen kann:

  • durch vollständiges Betrachten der Videowerbung (wo die präsentierte Werbung automatisch geschlossen wird
  • durch Drücken des Schließen-Buttons einer laufenden oder abgeschlossenen Werbung
  • durch Klicken des Download-Buttons, in welchem Fall wir den in-App-Store öffnen, den iOS zur Verfügung stellt (unter Verwendung des StoreKit-Frameworks)

In all diesen Fällen wird dieser Rückruf ausgelöst, sobald der Haupt-ViewController von Vungle verworfen wird. Das viewInfo NSDictionary enthält die folgende Information:

  • completedView: NSNumber als BOOL, YES wenn mindestens 80% des Videos angeschaut wurden
  • playTime: NSNumber der Dauer, die ein Video betrachtet wurde
  • didDownload: NSNumber als BOOL, YES wenn der Nutzer auf den Download-Button getippt hat
  • videoLength: (veraltet in Vungle iOS SDK 4.0.9)

Dieses Event kann zum Fortführen der Wiedergabe von Animationen, Sound-Effekten etc., verwendet werden, wenn man zur App zurückkehrt.

Beachten Sie, dass der Parameter willPresentProductSheet parameter immer NO ist. Verlassen Sie nicht auf diesen Parameter, um festzustellen, ob der Benutzer auf den Download-Button getippt hat.

(void)vungleSDKwillCloseProductSheet:(id)productSheet (deprecated) (Veraltet in Vungle iOS SDK 4.0.9.) Dieser Callback wird NICHT aufgerufen, da das neuste Vungle SDK "Product Sheet" nicht mehr verwendet. Verwenden Sie stattdessen den Callback (void)vungleSDKwillCloseAdWithViewInfo:, um zu Ihrer Anwendung zurückzukehren.


Registrieren des VungleSDKDelegate

Damit Ereignisse vom VungleSDK-Singleton empfangen werden können, müssen Klassen, die dem VungleSDKDelegate-Protokoll folgen, wie folgt registriert werden:

[[VungleSDK sharedSDK] setDelegate:yourDelegateInstance];

Um Speicherlecks zu vermeiden, muss der registrierte Delegat gelöscht werden, sobald er nicht mehr benötigt wird. Der VungleSDK-Singleton behält den registrierten Delegaten solange bei, bis dieser explizit entfernt wurde.

Verwenden Sie folgenden Code, um einen Delegaten zu löschen:

[[VungleSDK sharedSDK] setDelegate:nil];

 

VungleSDKLogger-Protokoll


@protocol VungleSDKLogger 
- (void)vungleSDKLog:(NSString*)message;
@end

Der VungleSDK-Singleton sendet Protokollereignisse an alle angefügten Klassen nach dem VungleSDKLogger-Protokoll.  Das Protokollereignis enthält den NSString-Wert, der außerdem auf der Konsole ausgegeben wird (sofern die Protokollierung aktiviert ist).  Verwenden Sie folgenden Code, um ein Protokollierungsprogramm anzufügen:

 [sdk attachLogger:yourLoggerInstance];

Wie bereits erwähnt, ist es wichtig, angefügte Protokollierungsprogramme aus dem VungleSDK zu löschen. Gehen Sie folgendermaßen vor, um Protokollierungsprogramme zu trennen:

[sdk detachLogger:yourLoggerInstance];

 

assetLoader-Protokoll


@protocol VungleAssetLoader
/**
 * Sollte ein gültiges NSData-Element mit den (Roh-)Daten eines Abbilds für den angegebenen Pfad oder "nil" zurückgeben. */
- (NSData*)vungleLoadAsset:(NSString*)path;

/**
 * Sollte ein gültiges UIImage-Element für den angegebenen Pfad oder "nil" zurückgeben.
 */
- (UIImage*)vungleLoadImage:(NSString*)path;
@end
Haben Sie Fragen? Anfrage einreichen

Kommentare