Démarrez avec Vungle (SDK v.1.0 - v.4.1) - Adobe Air

Ce guide vous explique comment intégrer notre plugin Vungle Adobe Air dans une application modèle standard. Le code source référencé ici est disponible sur notre dépôt public GitHub.

Contenu

Avant de commencer
1. Inclure la bibliothèque d'extension
2. Mettre à jour votre descripteur d'application
3. Intégrer l'API Vungle
Dépannage et FAQ

Avant de commencer

  • L'extension Vungle exige un SDK Adobe AIR 4.0 ou supérieur. Pour obtenir des instructions sur la mise à jour du SDK AIR sous Flash Builder ou Flash Professional, reportez-vous à la section " Comment mettre à jour le SDK AIR ? " à la fin de ce guide.

  • Si vous travaillez avec Android, l'extension Vungle AIR exige que JDK 6 ou JDK 7 (selon la version Flash que vous utilisez) soit installé sur le système de développement. Android 3.0 (Honeycomb - API version 11) ou supérieur est requis pour faire fonctionner l'application.

  • Vous pouvez consulter la documentation classe ActionScript 3.

  • Examinez example/VungleExample.as pour obtenir un exemple de classe d'application. (Si vous être un utilisateur Flash Professional et ne savez pas comment utiliser une classe de document, consultez la section " Comment utiliser la classe de document VungleExample sous Flash CS6 ? " à la fin de ce guide.)

1. Inclure la bibliothèque d'extension

Commencez par créer un nouveau projet AIR pour mobile et ajoutez l'extension native.

Si vous ciblez Android : vous pouvez également ajouter la bibliothèque de services Google Play à votre projet. En raison des nombreuses autres extensions déjà incluses dans cette bibliothèque, il se peut que vous n'ayez pas à l'ajouter. Pour ajouter l'extension, répétez les étapes ci-dessous, mais utilisez com.vungle.extensions.android.GooglePlayServices.ane au lieu de com.vungle.extensions.Vungle.ane.

Sous Flash Professional CS6 ou supérieur :

  1. Créez un nouveau projet AIR pour Android ou projet AIR pour iOS.
  2. Choisissez Fichier > Publier Settings...
  3. Sélectionnez l'icône de la clé à molette à côté de Script pour accéder aux paramètres ActionScript.
  4. Dans l'onglet Chemin d'accès à la bibliothèque, cliquez sur Rechercher le fichier (ANE) d'extension native et sélectionnez le com.vungle.extensions.Vungle.ane fichier. Cliquez sur OK.
  5. Sélectionnez l'icône de la clé à molette à côté de Cible pour accéder aux paramètres du lecteur.
  6. Si vous ciblez Android : dans l'onglet Permissions, activez INTERNET, WRITE_EXTERNAL_STORAGE, et ACCESS_NETWORK_STATE.
  7. Sélectionnez l'option Gérer manuellement les permissions et les ajouts Manifest pour cette application et cliquez sur OK.

Sous Flash Builder 4.6 ou supérieur :

  1. Dans propriétés du projet, sous Chemin de génération Actionscript, sélectionnez Extensions natives. 
  2. Choisissez Ajouter ANE... et naviguez jusqu'au com.vungle.extensions.Vungle.ane fichier.
  3. Sélectionnez Mise en package de la génération Actionscript > Google Android.
  4. Dans l'onglet Extensions natives, sélectionnez l'option Package à côté de l'extension.
  5. Si vous ciblez iOS, répétez les étapes 3 et 4 pour Apple iOS.

2. Mettre à jour votre descripteur d'application

Pour que Vungle fonctionne, des modifications doivent être apportées au fichier XML de votre application. Modifiez le fichier XML créé par votre IDE à l'aide des changements suivants (si vous utilisez Flash Professional, veillez à suivre les étapes ci-dessus de la section Inclure la bibliothèque d'extension pour Flash Professional CS6 ou supérieur ; sinon, Flash pourrait annuler vos modifications juste après leur application) :

  1. Définissez votre SDK AIR sur 4.0 (ou supérieur) dans le fichier descripteur de l'application :
    <application xmlns="http://ns.adobe.com/air/application/4.0">
  2. Incluez un lien à l'extension dans le descripteur :
    <extensions>
    <extensionID>com.vungle.extensions.Vungle</extensionID>
    </extensions>
  3. Si vous ciblez Android : vous devez inclure l'extension des services Google Play. Ajoutez également son ID d'extension.
    <extensions>
    <extensionID>com.vungle.extensions.Vungle</extensionID>
    <extensionID>com.vungle.extensions.android.GooglePlayServices</extensionID>
    </extensions>

Pour les applications AIR qui ciblent Android

Si vous ciblez Android, mettez à jour vos ajouts Android Manifest dans l'élément XML pour :

  • inclure les permissions INTERNET, WRITE_EXTERNAL_STORAGE, et ACCESS_NETWORK_STATE
  • ajouter les définitions d'activité VideoFullScreenAdActivity et MraidFullScreenAdActivity 
  • ajouter la balise de métadonnées de la version google-play-services :
<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>

Pour les applications AIR qui ciblent iOS

Si vous ciblez iOS, nous vous recommandons de désactiver App Transport Security (ATS) en ajoutant les lignes suivantes au fichier XML du descripteur de l'application lors de la génération avec Adobe AIR 21+ :

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

Reportez-vous à la section Préparation de vos applications pour iOS 9 pour en savoir plus sur App Transport Security.

3. Intégrer l'API Vungle

L'API Vungle peut être ajoutée à votre application en quelques lignes d'ActionScript.

Initialiser l'extension Vungle

Initialisez l'API lorsque votre application se lance.

  • Si vous utilisez du pur ActionScript, exécutez cette action dans le constructeur de votre classe de document.
  • Si vous utilisez Flex, faites l'appel dans l'événement initialize() de la classe principale.
  • Si vous utilisez un code de la ligne de temps sous Flash, faites-le sur la 1ere image.
  1. Importez les classes d'API :
    import com.vungle.extensions.*; 
    import com.vungle.extensions.events.*;
  2. Initialisez l'API en appelant Vungle.create(), et en passant en paramètre d'entrée un tableau contenant votre ID d'application provenant du tableau de bord Vungle. Si vous ciblez iOS et Android à partir du même projet, incluez les deux ID dans le tableau - avec l'ID iOS en premier et l'ID Android en deuxième.

    Vous devriez inclure l'appel vers Vungle.create() dans un try/catch puisque Vungle peut retourner une erreur lors du processus de création (par exemple, l'extension retourne une erreur en cas d'exécution sur le bureau) :
    try
    {
     // initialiser avec votre id d'application
     Vungle.create(["your_vungle_id"]);

     // -OU- initialiser en incluant les id ios et android pour des applications multiplateformes
     // Vungle.create(["your_ios_vungle_id","your_android_vungle_id"]);
    } catch (error:Error) {
     // impossible de créer une extension. Exécutez-vous autre chose qu'iOS/Android ?
    }

Ajouter une publicité interstitielle

Pour ajouter une publicité interstitielle, appelez playAd(). Tout d'abord, vérifiez que la publicité est disponible à l'aide de la méthode isAdAvailable() :

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

Ajouter une publicité répondant au mécanisme d'incitation

Pour afficher une publicité répondant au mécanisme d'incitation, appelez playAd() avec un objet de configuration et définissez l'option "répondant au mécanisme d'incitation" sur vrai. Tout d'abord, vérifiez que la publicité est disponible à l'aide de la méthode isAdAvailable().

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

Afin de récompenser l'utilisateur pour avoir regardé une publicité répondant au mécanisme d'incitation, implémentez l'écouteur d'événements AD_FINISHED comme décrit ci-dessous.

Ajouter des écouteurs d'événements

L'extension Vungle envoie quatre événements : VungleEvent.AD_PLAYABLE, VungleEvent.AD_STARTED, VungleEvent.AD_FINISHED, et VungleEvent.AD_LOG.

  1. L'événement AD_PLAYABLE est envoyé lorsqu'une publicité est prête à être jouée
    Vungle.vungle.addEventListener(VungleEvent.AD_PLAYABLE, onAdPlayable);

    function onAdPlayable(e:VungleEvent):void
    {
       trace("ad playable");
    }
  2. Les événements AD_STARTED et AD_FINISHED sont envoyés lorsqu'une publicité est affichée et rejetée, respectivement :
    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. L'événement AD_LOG est envoyé lorsqu'un message de journal est envoyé par le SDK Vungle. Vous pouvez l'utiliser pour le débogage. La journalisation est implémentée uniquement dans le SDK Vungle pour iOS, afin que cet événement soit propre à la plateforme.
    
    Vungle.vungle.setLoggingEnabled(true);
    Vungle.vungle.addEventListener(VungleEvent.AD_LOG, onAdLog);

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

Plus d'options

Comme vous avez pu le constater auparavant, vous pouvez donner en paramètre un objet avec des options de configuration lorsque vous appelez la méthode playAd(). Voici les propriétés disponibles dans VungleAdConfig:

orientation

Cette propriété vous permet de spécifier l'orientation de la publicité. Il existe différents ensembles d'indicateurs pour Android et iOS, consultez la classe VungleOrientation pour en savoir plus. Les indicateurs peuvent être combinés avec un opérateur OR bitwise :

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

soundEnabled

Vous pouvez utiliser cette propriété pour activer ou désactiver le son des publicités.

backButtonImmediatelyEnabled

Cette option est propre à Android. Si la valeur est true, cette option permet à l'utilisateur de quitter immédiatement une publicité grâce au bouton de retour. Si la valeur est false, l'utilisateur ne peut pas utiliser le bouton de retour pour quitter la publicité, jusqu'à ce que le bouton de fermeture à l'écran s'affiche.

immersiveMode

Cette option est propre à Android. Active ou désactive le mode immersif sur les appareils KitKat+.

répondant au mécanisme d'incitation

Définit le mode "répondant au mécanisme d'incitation". Si la valeur est true, une boîte de dialogue de confirmation s'affiche pour l'utilisateur lorsqu'il tente d'ignorer la publicité.

incentivizedUserId

L'ID utilisateur unique doit être transmis à votre application pour vérifier que cet utilisateur doit être récompensé pour avoir regardé une publicité qui répond au mécanisme d'incitation.

incentivizedCancelDialogTitle, incentivizedCancelDialogBodyText, incentivizedCancelDialogCloseButtonText, incentivizedCancelDialogKeepWatchingButtonText

Ces options vous permettent de personnaliser la boîte de dialogue de confirmation qui apparaît lorsqu'une publicité qui répond au mécanisme d'incitation est ignorée.

extra1 … extra8

BIENTÔT DISPONIBLE - Vous pouvez l'utiliser pour garder une trace des métriques telles que la tranche d'âge, le sexe, etc.

emplacement

BIENTÔT DISPONIBLE - Un nom d'emplacement de publicité facultatif pour une meilleure catégorisation des données lors d'une demande de données via l'API de rapport Vungle.

largeButtons

Cette option est propre à iOS. Si la valeur est true, les boutons à l'écran affichés sur la vidéo seront plus gros.

Valeurs globales par défaut

Vous pouvez utiliser l'objet de configuration globale pour définir des valeurs par défaut pour les options :


// définir les options de configuration de votre choix
VungleAdConfig.globalConfig.orientation = VungleOrientation.ANDROID_MATCH_VIDEO;
VungleAdConfig.globalConfig.soundEnabled = false;

Ensuite, chaque nouvel objet VungleAdConfig est créé avec ces valeurs définies par défaut. playAd() sans option utilise également la configuration globale.

Méthodes abandonnées

Depuis v2.4.0, les méthodes suivantes sont abandonnées :


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;

Ces méthodes ont été conservées pour des questions de rétrocompatibilité. Il n'est pas recommandé de les utiliser dans les nouvelles applications ou de les mélanger avec l'appel de la méthode playAd().

REMARQUE : quand votre application est en mode Test, vous ne serez pas en mesure de télécharger les applications présentées. En outre, le Tableau de bord n'affichera pas le nombre d'impressions. Ceci est dû au fait que les publicités de test sont uniquement destinées à vérifier si vous avez intégré le SDK correctement. Cette fonctionnalité devient disponible seulement après que votre application est activée.

Dépannage et FAQ

" Comment puis-je utiliser la classe de document VungleExample.as sous Flash Professional CS6 ? "

  1. Tout d'abord, créez l'application et ajoutez l'extension en suivant ce guide, sections 1-3.
  2. Copiez-collez VungleExample.as dans le même dossier que votre .fla. Ne copiez et ne collez pas son contenu dans la ligne de temps. Cela ne fonctionnera pas.
  3. Modifiez les id d'application sur la ligne 51 pour qu'ils deviennent vos propres id d'application Vungle.
  4. Dans les propriétés Flash, sous Classe de document, saisissez VungleExample (sans guillemets) et appuyez sur OK.
  5. Créez et installez l'application.

" Comment puis-je installer une nouvelle version du SDK AIR (4.0 ou supérieur) sous Flash Professional CS6 ? "

Suivez ce lien pour trouver le dernier SDK AIR. Si vous avez déjà installé AIR 4.0 ou supérieur, vous pouvez ignorer cette étape. Sinon, suivez les instructions ci-dessous :

  1. Dézippez le package SDK AIR 4.0 ou supérieur dans un emplacement sur votre disque dur.
  2. Lancez Flash Professional CS6.
  3. Sélectionnez Aide > Gérer AIR SDK...
  4. Appuyez sur le bouton plus (+) et naviguez jusqu'à l'emplacement du SDK AIR dézippé
  5. Appuyez sur OK
  6. Sélectionnez Fichier > Paramètres de publication
  7. Sélectionnez le dernier SDK AIR pour iOS dans le menu déroulant Cible

" Comment puis-je installer une nouvelle version du SDK AIR (4.0 ou supérieur) sous Flash Builder ? "

Suivez ce lien pour trouver le dernier SDK AIR. Si vous avez déjà installé AIR 4.0 ou supérieur, vous pouvez ignorer cette étape. Vous pouvez également utiliser les dernière instructions Adobe pour mettre à jour les SDK AIR Flash Builder.

" J'obtiens une erreur d'entrée invalide Adobe Animate. Que dois-je faire ? "

Si vous obtenez une erreur comme illustré dans l'image ci-dessous, reportez-vous à cet article.error_message_at_publish.png

Vous avez d’autres questions ? Envoyer une demande

Commentaires