Démarrage avec la version 5 du SDK Vungle - Unity

Contenu

Avant de commencer

  • Le plugin Vungle Unity pour iOS prend en charge :
    • iOS 8
    • Unity 4 et Unity 5.4.1 ou versions ultérieures
    • Le SDK Vungle nécessite que vous associiez le cadre WebKit.framework à votre projet. Si vous développez pour iOS 7, vous devez définir ce cadre comme étant "Facultatif". Pour ce faire, cliquez sur votre projet dans le Navigateur de projets et accédez à GénéralCadres et bibliothèques liés. Sélectionnez WebKit.framework et réglez le Statut sur "Facultatif".

  • Le plugin Vungle Unity pour Android :
    • exige Java 1.7 pour Android
    • prend en charge Unity 4, Unity 5.3.2 et les versions ultérieures

  • Le plugin Vungle Unity pour Windows :
  • Téléchargez notre exemple d'application : https://github.com/Vungle/Unity-Plugin/tree/sdk5.

Étape 1. Configurer votre projet Unity avec le plugin Vungle Unity

Ajouter le plugin Vungle Unity à votre projet Unity

Ouvrez votre projet dans Unity, cliquez deux fois sur le fichier téléchargé VunglePlugin.unitypackage pour ajouter le plugin Vungle Unity à votre application. Lorsque la fenêtre Importer le package Unity s'ouvre, cliquez sur Tout pour tout sélectionner avant l'importation.

Cibler la plateforme correcte dans vos paramètres build

Pour éviter des erreurs de compilation durant l'étape suivante, veillez à ce que les paramètres de construction (cmd + Maj+ B) de votre projet ciblent la plateformes iOS ou Android.

Amazon Appstore

Le SDK Vungle Android prend en charge Amazon OS 5.4 et versions supérieures. Vous pouvez soumettre l'APK Android à l'Appstore Amazon, avec l'installation supplémentaire de la configuration Unity Amazon Appstore. Reportez-vous aux instructions d'Unity ici.

Services Google Play

L'intégration des services Google Play dans votre projet permet à Vungle d'offrir une expérience personnalisée à l'utilisateur final, mais elle n'est pas obligatoire. Nous recommandons l'utilisation de la version 11.0.1 ou d'une version ultérieure.

Pour inclure les services Google Play, nous recommandons le guide d'installation Google. Dans votre application, assurez-vous que l'appareil dispose d'une version suffisamment mise à jour des services Google Play. Le SDK Vungle utilise de manière facultative l'emplacement et l'API des publicités provenant des services Google Play.

  • android.gms:play-services-location:11.0.1
  • android.gms:play-services-ads:11.0.1
  • Pour les services play jusqu'à 7.8.0 : conservez la bibliothèque de support
  • Pour les services play à partir de 8.4.0 : la bibliothèque de support n'est pas obligatoire

Nous avons compilé avec succès notre SDK autonome avec les versions suivantes des services Google Play : 7.8.0, 8.4.0, 9.8.0, 10.2.4 et 11.0.1.

Une fois que vous avez ajouté les services Google Play, ajoutez les autorisations suivantes à AndroidManifest.xml. Vungle utilise ces informations pour proposer sur mesure la meilleure expérience de publicité à chaque utilisateur :

  • <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  • <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

Étape 2 : Ajouter le code

Dans ce guide, nous initialisons tout notre code lié à Vungle dans un script attaché au principal objet du jeu. Vous pouvez appeler le plugin Vungle Unity à partir de n'importe quel script que vous jugez approprié.

Initialiser le SDK

Remarque : un placement par défaut est créé automatiquement pour chaque application. Vous devez fournir l'ID de référence de son placement lors de l'étape d'initialisation que vous envisagiez ou non de profiter de ses fonctions. Si vous créez plusieurs placements, fournissez tous les ID de référence.

Initialisez le SDK dès que l'application démarre afin de lui donner suffisamment de temps pour mettre en cache une publicité pour le placement mis en cache automatiquement. Pour initialiser le SDK, vous avez besoin des éléments suivants :

  • tous les ID d'application pour toutes les plateformes que vous devez prendre en charge
  • tous les ID de référence du placement que vous souhaitez utiliser dans votre application pour toutes les plateformes (active et inactive)

Vous pouvez trouver ces ID dans le tableau de bord Vungle (reportez-vous à la section Définition et rapport des placements).

Exemple de code :

public class VungleScript : MonoBehaviour { string appID = "";
string iosAppID = "ios_app_id";
string androidAppID = "android_app_id";
string windowsAppID = "windows_app_id"; #if UNITY_IPHONE appID = iosAppID; Dictionary<string, bool> placements = new Dictionary<string, bool> { { "ios_placement_id_1", false }, { "ios_placement_id_2", false }, { "ios_placement_id_3", false } }; #elif UNITY_ANDROID appID = androidAppID; Dictionary<string, bool> placements = new Dictionary<string, bool> { { "android_placement_id_1", false }, { "android_placement_id_2", false }, { "android_placement_id_3", false } }; #elif UNITY_WSA_10_0 || UNITY_WINRT_8_1 || UNITY_METRO appID = windowsAppID; Dictionary<string, bool> placements = new Dictionary<string, bool> { { "windows_placement_id_1", false }, { "windows_placement_id_2", false }, { "windows_placement_id_3", false } }; #endif string[] array = new string[placements.Keys.Count]; placements.Keys.CopyTo(array, 0); Vungle.init(appID, array);
}

Lorsque le SDK est initialisé avec succès, il appelle l'événement suivant :

public static event Action onInitializeEvent;

Reportez-vous à la section "Gestion de l'événement" de cet article.

Lorsque le SDK Vungle est initialisé, il demande automatiquement une publicité pour le placement que vous avez sélectionné comme mis en cache automatiquement dans le tableau de bord Vungle. Nous vous recommandons de sélectionner les placements les plus consultés pour la mise en cache automatique.

Lorsque la publicité est mise en cache avec succès, l'événement adPlayableEvent est appelé avec l'ID de référence du placement correspondant à votre placement mis en cache automatiquement. (Reportez-vous à la section "Vérifier la disponibilité de la publicité pour un placement" de cet article.)

Charger une publicité pour un placement

Pour les placements différents de ceux mis en cache automatiquement, appelez la méthode loadAd pour charger une publicité.

public static void loadAd(string placementID)

Veillez à utiliser le placementID lié à la plateforme correcte.

Exemple de code :

string placementID; #if UNITY_IPHONE placementID = "ios_placement_id"; #elif UNITY_ANDROID placementID = "android_placement_id"; #elif UNITY_WSA_10_0 || UNITY_WINRT_8_1 || UNITY_METRO placementID = "windows_placement_id"; #endif Vungle.loadAd(placementID);

Vérifier la disponibilité de la publicité pour un placement

Lorsque le SDK a terminé de mettre en cache une publicité pour un placement, l'événement suivant est appelé :

public static event Action<string, bool> adPlayableEvent;

Exemple de code :

Vungle.adPlayableEvent += (placementID, adPlayable) => { if(placementID == ) { layButtonPlacement1.enabled = adPlayable; } };

Remarque : pour le placementmis en cache automatiquement, cet événement est uniquement appelé lorsqu'une publicité est disponible. Le SDK continuera à demander une publicité pour le placement mis en cache automatiquement. Pour tous les autres placements, cet événement est également appelé en cas "d'échec du chargement" (adPlayable renvoie « NON » dans ce cas).

Vous pouvez également vérifier la disponibilité de la publicité pour un placement avec la méthode suivante :

public static bool isAdvertAvailable(string placementID);

Jouer une publicité

Important : ne diffusez pas de publicité avant que la fonction adPlayableEvent décrite ci-dessus ne renvoie "true". Si vous essayez de diffuser une publicité avant que la fonction adPlayableEvent ne renvoie "true", cela peut nuire à l'expérience utilisateur tandis que la publicité essaie de charger.

Lorsqu'une publicité est disponible pour un placement, vous pouvez la jouer avec la méthode suivante :

public static void playAd(string placementID);

Exemple de code :

Vungle.playAd ();

Gestion de l'événement

Vous pouvez configurer des gestionnaires d'événements pour les 5 événements du SDK Vungle qui entourent la présentation de la publicité.

  • L'événement suivant est déclenché lorsque le SDK commence à lire une publicité vidéo. Il s'agit d'un excellent placement pour mettre en pause le gameplay, les effets sonores, les animations, etc.
    public static event Action onAdStartedEvent;
  • L'événement suivant est déclenché lorsque le SDK ferme une publicité. Il s'agit d'un excellent placement pour récompenser vos utilisateurs et reprendre le gameplay, les effets sonores, les animations, etc.
    public static event Action<string, AdFinishedEventArgs> onAdFinishedEvent;

    La classe AdFinishedEventArgs se compose des propriétés suivantes pour que vous puissiez vérifier le résultat de la lecture d'une publicité :
    public class AdFinishedEventArgs : EventArgs { //Représente un BOOL si l'utilisateur a cliqué ou non sur le bouton de téléchargement. public bool WasCallToActionClicked{ get; set;} //Représente un bool indiquant si la vidéo a été visualisée ou non dans sa totalité. public bool IsCompletedView{ get; set;} }
  • L'événement suivant est déclenché lorsque le SDK a modifié le statut de la disponibilité d'une publicité. Le booléen isAdPlayable indique la nouvelle jouabilité d'un placementID spécifique.
    public static event Action<string, bool> adPlayableEvent;
    Consultez la section "Vérifier la disponibilité de la publicité pour un placement" de cet article pour plus de détails.

  • L'événement suivant est déclenché lorsque le SDK est initialisé avec succès.
    public static event Action onInitializeEvent;
  • L'événement suivant est déclenché lorsque le SDK génère des journaux.
    public static event Action onLogEvent;

Exemple de code :

void initializeEventHandlers() { Vungle.onAdStartedEvent += (placementID) => { DebugLog ("Ad " + placementID + " is starting! Pause your game animation or sound here."); }; Vungle.onAdFinishedEvent += (placementID, args) => { DebugLog ("Ad finished - placementID " + placementID + ", was call to action clicked:" + args.WasCallToActionClicked + ", is completed view:" + args.IsCompletedView); }; Vungle.adPlayableEvent += (placementID, adPlayable) => { DebugLog ("Ad's playable state has been changed! placementID " + placementID + ". Now: " + adPlayable); }; Vungle.onLogEvent += (log) => { DebugLog ("Log: " + log); }; Vungle.onInitializeEvent += () => { adInited = true; DebugLog ("SDK initialized"); }; }

Fonctionnalité OnPause et OnResume

Ajoutez du code pour la fonctionnalité onPause et onResume qui permet aux publicités interrompues, lorsqu'une application est en arrière-plan, de reprendre la lecture.

void OnApplicationPause(bool pauseStatus) { if (pauseStatus) { Vungle.onPause(); } else { Vungle.onResume(); } }

Options de personnalisation

La méthode playAd peut également accepter un dictionnaire des options pour personnaliser l'expérience de lecture de la publicité.

public static void playAd(Dictionary<string,object> options, string placementID);

Remarque : Les publicités rémunérées sont parfois nommées publicités répondant au mécanisme d'incitation ; les deux termes font toujours référence au même type de publicité. Dans le code SDK et dans notre API de création, nous utilisons le terme « répondant au mécanisme d'incitation ».

Le dictionnaire des options accepte les clés suivantes :

Clé

Description

orientation

Définit l'orientation de la publicité.

  • Pour iOS, utilisez VungleAdOrientation :
    public enum VungleAdOrientation { Portrait = 1, LandscapeLeft = 2, LandscapeRight = 3, PortraitUpsideDown = 4, Landscape = 5, All = 6, AllButUpsideDown = 7 }
  • Pour Android, si la valeur est true pour matchVideo et false pour autoRotate.

userTag

La clé de l'utilisateur est transmise pour identifier les utilisateurs dans l'appel S2S (le cas échéant).

alertTitle

Chaîne utilisée comme titre du dialogue d'alerte présenté lorsque un utilisateur ferme prématurément une expérience de lecture d'une publicité envoyée par le mécanisme d'incitation.

alertText

Chaîne utilisée en tant que corps du texte du dialogue d'alerte lorsqu'un utilisateur ferme prématurément une expérience de lecture d'une publicité envoyée par le mécanisme d'incitation.

closeText

Titre de la chaîne lorsque le texte du bouton fermer du dialogue d'alerte est présenté lorsqu'un utilisateur ferme prématurément une expérience de publicité envoyée par le mécanisme d'incitation.

continueText

Titre de la chaîne lorsque le texte du bouton fermer du dialogue d'alerte est présenté lorsqu'un utilisateur ferme prématurément une expérience de publicité envoyée par le mécanisme d'incitation.

immersive

Activez le mode immersif pour Android.

flexCloseSec

Pour iOS uniquement, il s'agit du délai en secondes au terme duquel la publicité Flex View peut être automatiquement masquée. Cette fonction est disponible uniquement pour les publicités Flex View (et non Flex Feed) et sous iOS.

 

Publicités Flex View

Pour iOS

Pour fermer une publicité Flex View par la programmation, utilisez la fonction closeAd :

Vungle.closeAd(placementIdList[1]);

Cette fonction ne fonctionne pas sous Android.

Pour Android

Flex View ne fonctionne pas de la même manière sous Unity Android que sous Unity iOS ou sous Android natif. Étant donné que la gestion des activités par Unity est limitée, Flex View ne permet pas à un utilisateur d'interagir avec le jeu de base lorsqu'une publicité Flex View est diffusée. Dans une publicité Flex View, l'activité sous-jacente est suspendue lorsqu'une activité se déroule en même temps. Si un utilisateur revient sur l'application à une date ultérieure, la publicité sera toujours diffusée, mais le jeu en arrière-plan aura un fond noir. Cela se produit car l'activité de base est suspendue jusqu'à ce que la publicité Flex View soit masquée.

Pour cette raison, évitez les publicités Flex View sur Unity Android.

Vous avez d’autres questions ? Envoyer une demande

Commentaires