Paramètres avancés - SDK Vungle iOS v.1.0 - v.4.1

Table des matières

  1. L'instance SDK Vungle
  2. Expériences de publicité personnalisées
  3. Protocoles VungleSDK supplémentaires

Avant de démarrer…

Cet article évoque les paramètres avancés du SDK Vungle iOS. Si vous ne connaissez pas encore notre SDK iOS, vous pouvez consulter notre Guide de démarrage pour iOS.

L'instance VungleSDK

Propriétés de l'instance

L'instance singleton VungleSDK dispose de quelques propriétés disponibles pour personnaliser votre expérience de publicité d'utilisateur final ou pour recevoir des données d'événement importantes.  Elles sont énumérées ci-dessous :

mode muet (BOOL) : Contrôle si les annonces présentées démarrent ou pas en mode muet
delegate (id<VungleSDKDelegate>): Propriété affectable suivant le protocole VungleSDKDelegate qui permet aux applications de recevoir des rappels asynchrones pour certains événements SDK
ChargeurActifs (id<VungleAssetLoader>) : Propriété affectable suivant le protocole VungleAssetLoader permettant aux applications de remplacer les actifs requis utilisés dans le ViewController playAd VungleSDK principal

 

Méthodes d'instance & Constantes d'Assistance

(BOOL)isAdPlayable; Renvoie YES si une annonce mise en cache est prête à être lue et que l'utilisateur actuel n'est pas limité par un nombre de vues ou des taux quotidiens. Cela ne permet pas de vérifier si une annonce en streaming peut être disponible, même si l'éditeur a choisi la diffusion en streaming.
(NSDictionary*)debugInfo; Retourne un NSDictionary avec plusieurs informations de débogage à propos du singleton VungleSDK
(void)setLoggingEnabled:(BOOL)enable; Active ou désactive la fonctionnalité de journalisation par défaut à partir du singleton VungleSDK.  Les événements et les informations enregistrés seront imprimés sur la console.  Pour gérer des événements de journalisation individuels, consultez la méthode attachLoggerci-dessous.
(void)log:(NSString*)message, ... NS_FORMAT_FUNCTION(1,2); Enregistre le message spécifié sur la console et toutes les instances VungleSDKLogger associées.
(void)attachLogger:(id<VungleSDKLogger>)logger Permet à l'application d'associer une classe à la suite du protocole VungleSDKLogger à l'instance singleton VungleSDK. L'enregistreur connecté recevra chaque événement du journal géré par le SDK.  Pour éviter les fuites de mémoire, il est important de détacher correctement l'enregistreur une fois qu'il n'est plus nécessaire.  L'instance singleton VungleSDK conservera l'enregistreur connecté jusqu'à ce qu'il ait été correctement retiré.
(void)detachLogger:(id<VungleSDKLogger>)logger; Détache un objet enregistreur d'événements.
NSString* VungleSDKVersion Une constante de chaîne notant la version actuelle du SDK Vungle iOS.  Comprend les versions majeures et mineures.

Expérience de publicité personnalisée

La méthode playAd sur le singleton VungleSDK peut accepter un paramètre NSDictionary permettant à une application de personnaliser une expérience de publicité individuelle.  Toutes les paires clé/valeur valides incluses dans le paramètre NSDictionary remplaceront la valeur par défaut pour le paramètre noté. Toutes les clés peuvent être ajoutées au dictionnaire. Les paramètres inclus dans le paramètre NSDictionary affecteront uniquement un seul appel playAd. Vous trouverez un exemple de dictionnaire d'options à la ligne 111 ou 131 de l'application de démonstration.

Clé Valeur/type par défaut Description
VunglePlayAdOptionKeyIncentivized NO
NSNumber représentant une valeur booléenne.
Indiquer la lecture d'une publicité comme répondant au mécanisme d'incitation entraîne un comportement légèrement différent de celui d'un appel playAdd par défaut, tant des serveurs publicitaires Vungle que du SDK local. Cette fonctionnalité peut être utilisée pour aider à séparer le comportement et la fonctionnalité entre les publicités d'emplacement basées sur les récompenses et les annonces diffusées normalement.  Pour obtenir une explication détaillée des différences entre les publicités répondant au mécanisme d'incitation et celles n'y répondant pas, consultez notre documentation ici.
VunglePlayAdOptionKeyOrientations UIInterfaceOrientationMaskAll
NSNumber représentant un masque de bits avec des orientations (de pivotement automatique par défaut).
Définit l'orientation de l'annonce. Nous vous conseillons d'autoriser les annonces à pivoter automatiquement, même si votre application est en mode portrait. De cette façon, l'utilisateur a la possibilité de visionner des vidéos en plein écran, ce qui permet une meilleure expérience utilisateur. Vous pouvez y parvenir en définissant l'orientation sur un niveau de contrôleur de vue (plutôt qu'un niveau du projet).
VunglePlayAdOptionKeyUser nil
NSString avec un identifiant d'utilisateur qui sera transmis si l'annonce est envoyée par le mécanisme d'incitation.
Valeur transmise en tant qu'utilisateur dans un appel serveur-à-serveur répondant au mécanisme d'incitation.
VunglePlayAdOptionKeyIncentivizedAlertTitleText nil
NSString
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 annonce envoyée par le mécanisme d'incitation.
VunglePlayAdOptionKeyIncentivizedAlertBodyText Voulez-vous vraiment ignorer cette annonce ? Si vous le faites, vous pourriez ne pas obtenir votre récompense
NSString
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 annonce envoyée par le mécanisme d'incitation.
VunglePlayAdOptionKeyIncentivizedAlertCloseButtonText Fermer
NSString
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 d'annonce envoyée par le mécanisme d'incitation.
VunglePlayAdOptionKeyIncentivizedAlertContinueButtonText Continuer
NSString
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 d'annonce envoyée par le mécanisme d'incitation.
VunglePlayAdOptionKeyExtraInfoDictionary nil
NSDictionary contenant les clés supplémentaires (définies ci-dessous).
Dictionnaire de métadonnées de base qui peut être utilisé pour garder une trace des métriques telles que la tranche d'âge, le sexe, etc.
VunglePlayAdOptionKeyExtra1..8 nil
NSString représentant chaque métrique d'utilisateur dont vous effectuez le suivi.
BIENTÔT DISPONIBLE - Cette fonction n'est pas encore finalisée, mais lorsqu'elle le sera, vous pourrez utiliser les 8 clés ici pour garder une trace et signaler des informations supplémentaires sur les placements publicitaires, les données utilisateur, etc.

Protocoles

VungleSDKDelegate Protocol


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

Méthodes VungleSDKDelegate

Vous pouvez mettre en œuvre VungleSDK Delegate qui peut vous avertir de certains événements utiles concernant l'expérience de l'annonce.

Méthode Description
(void)vungleSDKAdPlayableChanged:(BOOL)isAdPlayable Appelé lorsque le VungleSDK a modifié l'état de disponibilité de l'annonce.  isAdPlayable booléen indique la nouvelle jouabilité du SDK de Vungle
(void)vungleSDKwillShowAd Appelé lorsque le VungleSDK est sur le point de lire une annonce vidéo.  Le remplacement de cette méthode est un excellent lieu pour mettre en pause le gameplay, les effets sonores, les animations, etc.
(void)vungleSDKwillCloseAdWithViewInfo:
(NSDictionary *)viewInfo  willPresentProductSheet:(BOOL)willPresentProductSheet

Un utilisateur peut quitter une expérience de publicité de trois façons :

  • en terminant l'annonce vidéo (où l'annonce présentée se ferme automatiquement
  • en appuyant sur le bouton de fermeture d'une annonce en cours ou terminée
  • en cliquant sur le bouton de téléchargement, auquel cas nous ouvrons le magasin d'applications intégré à l'application que propose iOS (en utilisant le cadre StoreKit)

Dans tous ces cas, ce rappel est lancé, car le Vungle ViewController principal est rejeté. Le viewInfo NSDictionary contient les informations suivantes :

  • completedView: NSNumber comme BOOL, YES si 80% au moins de la vidéo a été visionnée
  • playTime: NSNumber de durée d'une vidéo visionnée
  • didDownload: NSNumber comme BOOL, YES si l'utilisateur a appuyé sur le bouton Télécharger
  • videoLength: (abandonné dans SDK Vungle iOS 4.0.9)

Cet événement peut être utilisé pour relancer des animations, des effets sonores, etc., lors du retour à l'application.

Notez que le paramètre willPresentProductSheet est toujours NO. Ne comptez pas sur ce paramètre pour déterminer si l'utilisateur a appuyé sur le bouton de téléchargement.

(void)vungleSDKwillCloseProductSheet:(id)productSheet (deprecated) (Abandonné dans SDK Vungle iOS 4.0.9.) Cette fonction de rappel NE sera PAS exécutée car le dernier SDK Vungle n'utilise plus Product Sheet. À la place, utilisez la fonction de rappel (void)vungleSDKwillCloseAdWithViewInfo: pour relancer votre application.


Enregistrement de VungleSDKDelegate

Pour recevoir les événements du singleton VungleSDK, les classes suivant le protocole VungleSDKDelegate doivent être enregistrées de la façon suivante :

[[VungleSDK sharedSDK] setDelegate:yourDelegateInstance];

Pour éviter les fuites de mémoire, n'oubliez pas de supprimer le délégué enregistré lorsqu'il n'est plus nécessaire. Le singleton VungleSDK conservera le délégué enregistré jusqu'à ce qu'il ait été explicitement supprimé.

Pour effacer un délégué, utilisez les commandes suivantes :

[[VungleSDK sharedSDK] setDelegate:nil];

 

VungleSDKLogger Protocol


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

Le singleton VungleSDK enverra des événements de journalisation à n'importe quelle classe associée suivant le protocole VungleSDKLogger.  L'événement du journal contiendra la valeur NSString qui sera également imprimée sur la console (si l'enregistrement a été activé).  Pour connecter votre enregistreur d'événements, utilisez ce qui suit :

 [sdk attachLogger:yourLoggerInstance];

Comme mentionné ci-dessus, il est important de supprimer les enregistreurs connectés de VungleSDK. Les enregistreurs peuvent être déconnectés en utilisant l'approche suivante :

[sdk detachLogger:yourLoggerInstance];

 

assetLoader Protocol


@protocol VungleAssetLoader
/**
 * doit retourner un NSData valide contenant les données (brutes) d'une image pour le chemin spécifié ou nil. */
- (NSData*)vungleLoadAsset:(NSString*)path;

/**
 * doit retourner une UIImage valide pour le chemin spécifié ou nil.
 */
- (UIImage*)vungleLoadImage:(NSString*)path;
@end
Vous avez d’autres questions ? Envoyer une demande

Commentaires