Mit Vungle loslegen (SDK v.1.0 - v.4.1) - Adobe Air

Dieser Leitfaden zeigt Ihnen, wie Sie unser Vungle Adobe Air Plugin in eine grundlegende Beispielanwendung integrieren. Der Quellcode, auf den wir uns hier beziehen, ist in unserer öffentlichen GitHub Repository verfügbar.

Inhalt

Bevor Sie anfangen
1. Beziehen Sie die Erweiterungsbibliothek mit ein
2. Aktualisieren sie Ihren Anwendungsbeschreiber
3. Integrieren Sie die
Problembehandlung und FAQder Vungle API

Bevor Sie beginnen

  • Die Vungle Erweiterung erfordert das Adobe AIR SDK 4.0 oder neuer. Anweisungen zum Aktualisieren des AIR SDK unter Flash Builder oder Flash Professional erhalten Sie unter "Wie aktualisiert man das AIR SDK?" am Ende dieses Leitfadens.

  • Wenn Sie mit Android arbeiten, erfordert die Vungle AIR Erweiterung, dass JDK 6 oder JDK 7 (je nachdem, welche Flash-Version Sie verwenden) auf dem Entwicklungssystem installiert ist. Android 3.0 (Honeycomb - API Version 11) oder neuer wird zum Ausführen der Anwendung benötigt.

  • Sie können sich die ActionScript 3 Class Dokumentation ansehen.

  • Sehen Sie sich example/VungleExample.as für eine Beispiel-Anwendungsklasse an. (Wenn Sie Flash Professional verwenden und sich nicht sicher sind, wie man eine Dokumentenklasse verwendet, sehen Sie unter "Wie verwendet man die VungleExample Dokumentenklasse unter Flash CS6?" am Ende dieses guide.)

1. Beziehen Sie die Erweiterungsbibliothek mit ein

Beginnen Sie mit der Erstellung eines neuen AIR for mobile-Projekts und fügen Sie eine native Erweiterung hinzu.

Wenn Ihr Ziel Android ist, müssen Sie vielleicht die Google Play Services Bibliothek zu Ihrem Projekt hinzufügen. Da viele andere Erweiterungen diese Bibliothek bereits verwenden, müssen Sie sie vielleicht nicht hinzufügen. Um diese Erweiterung hinzuzufügen, wiederholen Sie die untenstehenden Schritte, verwenden Sie aber com.vungle.extensions.android.GooglePlayServices.ane anstelle von com.vungle.extensions.Vungle.ane.

Unter Flash Professional CS6 oder neuer:

  1. Erstellen Sie ein neues AIR für Android oder AIR für iOS Projekt.
  2. Wählen Sie Datei > Veröffentlichen Settings...
  3. Wählen Sie das Schraubenschlüssel-Symbol neben Skript für "ActionScript Einstellungen".
  4. Klicken Sie in der Registerkarte Bibliothek-Pfad auf Nach nativer Erweiterungsdatei (ANE) durchsuchen und wählen Sie die com.vungle.extensions.Vungle.ane Datei. Klicken Sie auf OK.
  5. Wählen Sie das Schraubenschlüssel-Symbol neben Ziel für "Player-Einstellungen".
  6. Wenn Ihr Ziel Android ist: Aktivieren Sie in der Berechtigungen-Registerkarte "INTERNET", "WRITE_EXTERNAL_STORAGE", und "ACCESS_NETWORK_STATE".
  7. Wählen Sie die Option Berechtigungen manuell verwalten und Ergänzungen für diese App anzeigen und klicken Sie auf OK.

Unter Flash Builder 4.6 oder neuer:

  1. Wählen Sie in den Projekteigenschaften unter Actionscript Bau-Pfad Native Erweiterungen.
  2. Wählen Sie Hinzufügen ANE... und navigieren Sie zurcom.vungle.extensions.Vungle.ane Datei.
  3. Wählen Sie Actionscript Baupaket > Google Android.
  4. Wählen Sie in der Registerkarte Native Erweiterungen die Paket-Option neben der Erweiterung.
  5. Wenn Ihr Ziel iOS ist, wiederholen Sie die Schritt 3 und 4 für das "Apple iOS" Ziel.

2. Aktualisieren sie Ihren Anwendungsbeschreiber

Damit Vungle funktioniert, sind Änderungen an der XML-Datei Ihrer App erforderlich. Passen Sie die von Ihrer IDE erstelle XML-Datei mittels der folgenden Änderungen an (Stellen Sie bei der Verwendung von Flash Professional sicher, dass Sie die obenstehenden Schritte "Die Bibliothek unter Flash Professional CS6 oder neuer integrieren". Anderenfalls könnte Flash Ihre Änderungen wieder zurücksetzen, während Sie diese vornehmen):

  1. Stellen Sie in der Beschreiber-Datei der App Ihr AIR SDK auf 4.0 (oder neuer):
    <application xmlns="http://ns.adobe.com/air/application/4.0">
  2. Fügen Sie im Beschreiber einen Link auf die Erweiterung hinzu:
    <extensions>
    <extensionID>com.vungle.extensions.Vungle</extensionID>
    </extensions>
  3. Wenn Ihr Ziel Android ist, müssen Sie vielleicht die Google Play Services Bibliothek zu Ihrem Projekt hinzufügen. Fügen Sie dort auch die entsprechende Erweiterungs-ID hinzu.
    <extensions>
    <extensionID>com.vungle.extensions.Vungle</extensionID>
    <extensionID>com.vungle.extensions.android.GooglePlayServices</extensionID>
    </extensions>

Für AIR-Anwendungen, die Android zum Ziel haben

Wenn Android Ihr Ziel ist, passen Sie Ihre Android-Manifest-Erweiterungen im Android XML-Element wie folgt an:

  • Die Berechtigungen für INTERNET, WRITE_EXTERNAL_STORAGE und ACCESS_NETWORK_STATE sind miteinzuschließen
  • fügen Sie VideoFullScreenAdActivity und die MraidFullScreenAdActivity Aktivitätsdefinitionen hinzu
  • fügen Sie das google-play-services Versions-Metadaten-Tag hinzu:
<android> 
<manifestAdditions><![CDATA[
<manifest android:installLocation="auto">

 <uses-permission android:name="android.permission.INTERNET"/>
 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

 <application>
   <meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/>

   <activity android:name="com.vungle.publisher.VideoFullScreenAdActivity"
     android:configChanges="keyboardHidden|orientation|screenSize"
     android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
   <activity android:name="com.vungle.publisher.MraidFullScreenAdActivity"
     android:configChanges="keyboardHidden|orientation|screenSize"
     android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"/>
 </application>
</manifest>
]]></manifestAdditions>
</android>

Für AIR-Anwendungen, die iOS zum Ziel haben

Wenn iOS Ihr Ziel ist, empfehlen wir die Deaktivierung der App Transport Security (ATS), indem Sie die folgenden Zeilen zur Beschreiber-XML der App hinzufügen, wenn Sie mit Adobe AIR 21+ bauen:

<iPhone>
    <InfoAdditions>
        <![CDATA[
            <key>NSAppTransportSecurity</key>
            <dict>
                <key>NSAllowsArbitraryLoads</key>
                <true />
            </dict>
        ]]>
    </InfoAdditions>
</iPhone>

Sehen Sie unter Ihre Apps für iOS 9 vorbereiten nach, um weitere Informationen über App Transport Security zu erhalten.

3. Die Vungle API integrieren

Die Vungle API können Sie mit Hilfe nur weniger Zeilen von ActionScript zu Ihrer Anwendung hinzufügen.

Initialisieren Sie die Vungle-Erweiterung

Initialisieren Sie beim Start Ihrer Anwendung die API.

  • Wenn Sie ActionScript allein verwenden, führen Sie dies im Konstruktor Ihrer Dokumentenklasse durch.
  • Wenn Sie Flex verwenden, führen Sie dies im initialize() Event der Haupt-Klasse durch.
  • Wenn Sie unter Flash den Timeline-Code verwenden, führen Sie dies auf Frame 1 durch.
  1. Importieren Sie die API-Klassen:
    import com.vungle.extensions.*; 
    import com.vungle.extensions.events.*;
  2. Initialisieren Sie die API, indem Sie Vungle.create() rufen und ein Array weitergeben, das Ihre Anwendungs-ID aus dem Vungle Dashboard beinhaltet. Wenn Sie sowohl iOS als auch Android vom gleichen Projekt aus zum Ziel haben, fügen Sie in diesem Array beide IDs hinzu, wobei Sie zuerst die iOS-ID und dann die Android-ID nennen.

    Sie sollten Ihren Call in einem Try/Catch mit Vungle.create() wrappen, da Vungle während des Erstellungsvorgangs einen Fehler ausgeben könnte (z.B. gibt die Erweiterung einen Fehler aus, wenn sie auf einem Desktop ausgeführt wird):
    versuchen Sie
    {
     // mit Ihrer App-ID initialisieren
     Vungle.create(["your_vungle_id"]);

     // -ODER- initialisieren Sie bei Apps für mehrere Plattformen sowohl mit der iOS- als auch mit der Android-ID
    // Vungle.create(["your_ios_vungle_id","your_android_vungle_id"]);
    } catch (Fehler:Fehler) {
     // konnte Erweiterung nicht erstellen. Läuft die Anwendung auf etwas außer iOS/Android?
    }

Eine dazwischengeschaltete Werbung einblenden

Um eine dazwischengeschaltete Werbung einzublenden, machen Sie einen Call auf playAd(). Sie sollten vorher überprüfen, ob die Werbung über die Methode isAdAvailable() verfügbar ist:

if (Vungle.vungle.isAdAvailable())
{
    Vungle.vungle.playAd();
}

Eine Werbung mit Anreiz einblenden

Rufen Sie zur Einblendung von Werbungen mit Anreizen playAd() mit einem Konfigurationsobjekt auf und stellen Sie die Option mit Anreiz auf wahr. Sie sollten vorher mit Hilfe der isAdAvailable() Methode überprüfen, ob die Werbung verfügbar ist.

if (Vungle.vungle.isAdAvailable())
{
   var config:VungleAdConfig = new VungleAdConfig();
   config.incentivized = true;
   Vungle.vungle.playAd(config);
}

Um den Spieler für die vollständige Ansicht einer angeregten Werbung zu belohnen, müssen Sie den AD_FINISHED Event-Listener wie unten beschrieben implementieren.

Event-Listener hinzufügen

Die Vungle-Erweiterung startet vier Events: VungleEvent.AD_PLAYABLE, VungleEvent.AD_STARTED, VungleEvent.AD_FINISHED, und VungleEvent.AD_LOG.

  1. AD_PLAYABLE wird abgeschickt, wenn eine Werbung bereit zum Abspielen ist
    Vungle.vungle.addEventListener(VungleEvent.AD_PLAYABLE, onAdPlayable);

    function onAdPlayable(e:VungleEvent):void
    {
       trace("ad playable");
    }
  2. Die Events AD_STARTED und AD_FINISHED werden abgeschickt, wenn eine Werbung angezeigt bzw. beendet wird:
    Vungle.vungle.addEventListener(VungleEvent.AD_STARTED, onAdStarted); 
    Vungle.vungle.addEventListener(VungleEvent.AD_FINISHED, onAdFinished);

    function onAdStarted(e:VungleEvent):void
    {
     trace("ad displayed");
    }

    function onAdFinished(e:VungleEvent):void
    {
     trace("ad dismissed, CTA = " + e.wasCallToActionClicked);
     if (e.wasSuccessfulView)
     {
       trace("counts a completed view - present reward.");
     }
    }
  3. Der AD_LOG wird abgeschickt, wenn vom Vungle SDK eine Log-Nachricht versendet wird. Dies kann zum Debuggen verwendet werden. Das Loggen ist nur im Vungle SDK für iOS integriert; dieses Event ist also plattformspezifisch.
    
    Vungle.vungle.setLoggingEnabled(true);
    Vungle.vungle.addEventListener(VungleEvent.AD_LOG, onAdLog);

    private function onAdLog(e:VungleEvent):void
    {
       log("ad log: " + e.message);
    }

Weitere Optionen

Wie bereits vorher festgestellt wurde, kann ein Objekt mit Konfigurationsoptionen hinzugefügt werden, wenn die playAd()-Methode abgerufen wird. Dies sind die verfügbaren Eigenschaften in VungleAdConfig:

Ausrichtung

Mit dieser Eigenschaft kann die Ausrichtung der Werbung spezifiziert werden. Es gibt verschiedene Markierungsgruppen für Android und für iOS. Weitere Informationen finden Sie in der VungleOrientation-Klasse. Die Markierungen können mit einem bitweisen OR-Operator versehen werden:

config.orientation = VungleOrientation.ANDROID_AUTOROTATE | VungleOrientation.IOS_PORTRAIT;

soundEnabled

Diese Eigenschaften können verwendet werden, um festzustellen, ob Werbungen mit oder ohne Ton wiedergegeben werden.

backButtonImmediatelyEnabled

Diese Option ist Android-spezifisch. Bei true kann der Nutzer eine Werbung unmittelbar mit der Schaltfläche „Zurück” verlassen. Bei false kann der Nutzer die Werbung erst dann mit der Schaltfläche "Zurück" verlassen, wenn die Schaltfläche "Schließen" auf dem Bildschirm angezeigt wird.

immersiveMode

Diese Option ist Android-spezifisch. Aktiviert oder deaktiviert den immersiven Modus auf KitKat oder neueren Geräten.

incentivized

Stellt den Anreiz-Modus ein. Bei true wird ein Bestätigungsdialogfeld angezeigt, wenn der Nutzer versucht, die Werbung zu überspringen.

incentivizedUserId

Die einmalige Nutzer-ID zur Übergabe an Ihre Anwendung, um zu überprüfen, ob dieser Nutzer für das Sehen der Werbung mit Anreiz belohnt werden soll.

incentivizedCancelDialogTitle, incentivizedCancelDialogBodyText, incentivizedCancelDialogCloseButtonText, incentivizedCancelDialogKeepWatchingButtonText

Diese Optionen ermöglichen eine individuelle Anpassung des Bestätigungsdialogs, der beim Überspringen der Werbung mit Anreiz angezeigt wird.

extra1 … extra8

BALD VERFÜGBAR - Dies kann verwendet werden, um Metriken wie Altersgruppe, Geschlecht und andere nachzuverfolgen.

placement

ERSCHEINT BALD - Ein optionaler Name für die Werbeplatzierung zur verbesserten Kategorisierung von Daten, wenn Daten über die Vungle Reporting API angefordert werden.

largeButtons

Diese Option ist iOS-spezifisch. Bei true werden die über dem Video angezeigten Schaltflächen größer.

Globale Vorgaben

Sie können globale Konfigurationsobjekte verwenden, um die Standard-Werte für diese Optionen einzustellen:


// beliebige Konfigurationsoptionen einstellen
VungleAdConfig.globalConfig.orientation = VungleOrientation.ANDROID_MATCH_VIDEO;
VungleAdConfig.globalConfig.soundEnabled = false;

Dann wird jedes neue VungleAdConfig-Objekt mit diesen standardmäßig eingestellten Werten erstellt. playAd() ohne Optionen verwendet ebenso die globalen Einstellungen.

Veraltete Methoden

Seit v2.4.0 wurden die folgenden Methoden verworfen:


Vungle.vungle.displayAd(showCloseButton:Boolean, orientationHint:int):void;
Vungle.vungle.displayIncentivizedAd(name:String, showCloseButton:Boolean, orientationHint:int):void;
Vungle.vungle.setSoundEnabled(enabled:Boolean):void;
Vungle.vungle.setBackButtonEnabled(backEnabled:Boolean):void;
Vungle.vungle.setIncentivizedBackButtonEnabled(backEnabled:Boolean):void;

Diese Methoden wurden zur Abwärtskompatibilität beibehalten. Es wird empfohlen, diese nicht für neue Anwendungen zu verwenden oder mit dem Aufruf der playAd()-Methode zu vermischen.

HINWEIS: Während Ihre App sich im Testmodus befindet, können Sie keine der beworbenen Apps herunterladen. Darüber hinaus wird das Dashboard die Anzahl der Impressionen nicht bekanntgeben. Das liegt daran, dass Testanzeigen nur zum Prüfen dienen, ob Sie das SDK korrekt integriert haben. Diese Funktionalität wird verfügbar, sobald Ihre App im aktiven Modus live ist.

Problembehandlung und FAQ

"Wie verwendet man die VungleExample.as Dokumentenklasse in Flash Professional CS6?"

  1. Erstellen Sie zunächst die Anwendung und fügen Sie die Erweiterung hinzu, indem Sie Abschnitt 1 bis 3 dieses Leitfadens folgen.
  2. Kopieren Sie und fügen Sie VungleExample.as in den gleichen Ordner wie .fla ein. Fügen Sie die kopierten Inhalte nicht in die Zeitlinie ein. Dies wird nicht funktionieren.
  3. Ändern Sie die App-IDs auf Zeile 51, damit Sie Ihren Vungle App-IDs entsprechen.
  4. Geben Sie in den Flash-Eigenschaften unter "Dokumentenklasse" "VungleExample" ein (ohne Anführungszeichen) und wählen Sie OK.
  5. Die Anwendung bauen und installieren.

"Wie installiere ich eine neuere Version von AIR SDK (4.0 oder neuer) in Flash Professional CS6?"

Folgen Sie diesem Link zum Erhalt des aktuellsten AIR SDK. Wenn Sie AIR 4.0 oder neuer bereits installiert haben, kann dieser Schritt übersprungen werden. Ansonsten befolgen Sie die unten beschriebenen Anweisungen:

  1. Entpacken Sie das Paket von AIR 4.0 oder neuer in ein Verzeichnis auf Ihrer Festplatte.
  2. Starten Sie Flash Professional CS6.
  3. Wählen Sie Hilfe > AIR verwalten SDK...
  4. Drücken Sie die Plus-Taste (+) und navigieren Sie zu dem Verzeichnis, in dem AIR SDK entpackt wurde
  5. Drücken Sie OK
  6. Wählen Sie Datei > Veröffentlichungseinstellungen
  7. Wählen Sie das aktuellste AIR SDK für iOS aus dem "Ziel"-Dropdownmenü

"Wie installiere ich eine neuere Version von AIR SDK (4.0 oder neuer) in Flash Builder?"

Folgen Sie diesem Link zum Erhalt des aktuellsten AIR SDK. Wenn Sie AIR 4.0 oder neuer bereits installiert haben, kann dieser Schritt übersprungen werden. Sie können auch auf die aktuellen Anweisungen von Adobe zur Aktualisierung des Flash Builder AIR SDK zurückgreifen.

"Ich erhalte den Fehler "Adobe Animate falsche Eingabe"." Was kann ich unternehmen?"

Wenn Sie einen Fehler wie im Bild unten erhalten, schauen Sie sich diesen Artikel an.error_message_at_publish.png

Haben Sie Fragen? Anfrage einreichen

Kommentare