Intégrer le SDK Vungle pour Android ou Amazon

David Kim

17 septembre 2024 17:35

Avant de commencer

Le SDK Vungle a été conçu et testé jusqu'à la version 30 de l'API, Android 11.

Configuration nécessaire

L'intégration nécessite un compte Vungle. Créez un compte Vungle si vous ne l'avez pas encore fait, puis créez une nouvelle application Android ou Amazon dans votre compte. Consultez la section Ajouter vos applications et vos placements de notre article Utilisation du tableau de bord de développeur pour savoir comment configurer les placements dans le tableau de bord Vungle.
Android 4.0 (Ice Cream Sandwich - API version 14 ou version ultérieure)
Amazon OS 5.4 ou version ultérieure
Votre plateforme doit être AndroidX sur Android SDK 6.5.1 ou version ultérieure

Télécharger le SDK

Téléchargez le SDK Vungle pour Android ou Amazon : https://publisher.vungle.com/sdk/sdks/android

Référence : exemple d'application et Javadoc

Exemple d'application : reportez-vous à l'exemple d'application fourni en tant qu'intégration : https://github.com/Vungle/Android-SDK

JavaDoc : https://vungle.github.io/vungle-android-sdk/javadoc

Étape 1. Inclure le SDK Vungle dans votre projet

Vous pouvez intégrer le SDK Vungle soit comme dépendance de Gradle, soit manuellement en utilisant une intégration JAR ou AAR.

// API version compatibility
minSdkVersion 14
compileSdkVersion 30
targetSdkVersion 30

Gradle

Ouvrez le niveau de projet build.gradle et assurez-vous que les détails JCenter sont bien ceux indiqués ici :

allprojects {
  repositories {
    jcenter()
  }
}

Ouvrez le fichier build.gradle au niveau de l'application et ajoutez les dépendances compilées dans la section dependencies.

buildscript {
  repositories {
    jcenter()
  }
}

dependencies { 
  // Vungle SDK
  implementation 'com.vungle:publisher-sdk-android:6.9.1'
 
  implementation 'androidx.core:core:1.3.2'
  implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

  // When appcompat is being used, core and localbroadcastmanager are the dependencies
  // that is getting included
  // implementation 'androidx.appcompat:appcompat:1.2.0'

  // Recommended for SDK to be able to get Android Advertising ID
  implementation 'com.google.android.gms:play-services-basement:17.5.0'
  implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

JAR

Download the Vungle SDK and unzip it. From the libs folder, copy all the .jar files, and add them to your project libs folder:
- vungle-android-sdk-6.9.1.jar
- gson-2.8.6.jar
- okhttp-3.12.12.jar
- okio-1.15.0.jar

Ouvrez le fichier build.gradle au niveau de l'application et ajoutez d'autres dépendances dans la section dependencies.

dependencies {
  // Vungle SDK
  implementation files('libs/vungle-android-sdk-6.9.1.jar')

  // Required Third-party Dependencies
  implementation files('libs/gson-2.8.6.jar')
  implementation files('libs/okhttp-3.12.12.jar')
  implementation files('libs/okio-1.15.0.jar')

  implementation 'androidx.core:core:1.3.2'
  implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

  // When appcompat is being used, core and localbroadcastmanager are the dependencies
  // that is getting included
  // implementation 'androidx.appcompat:appcompat:1.2.0'

  // Recommended for SDK to be able to get Android Advertising ID
  implementation 'com.google.android.gms:play-services-basement:17.5.0'
  implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

Mettez votre fichier AndroidManifest.xml à niveau en ajoutant les lignes suivantes et en attribuant le nom de l'élément de l'application au nom de la classe de votre application :

<uses-sdk
    android:minSdkVersion="14"
    android:targetSdkVersion="30" />

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

<application
    android:fullBackupContent="@xml/vungle_backup_rule"
    android:hardwareAccelerated="true"
    android:supportsRtl="true" >
    <activity
        android:name="com.vungle.warren.ui.VungleActivity"
        android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize|uiMode"
        android:launchMode="singleTop"
        android:theme="@android:style/Theme.NoTitleBar.Fullscreen" />

    <receiver
        android:name="com.vungle.warren.NetworkProviderReceiver"
        android:enabled="false" >
        <intent-filter>
            <action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
            <category android:name="android.intent.category.DEFAULT" />
        </intent-filter>
    </receiver>

    <provider
        android:name="com.vungle.warren.utility.VungleProvider"
        android:authorities="${applicationId}.vungle-provider"
        android:exported="false" />
</application>

Incluez des règles d'exclusion Vungle pour permettre fullBackupContent.

AAR

Download the Vungle SDK and unzip it. From the libs folder, copy SDK .aar and all .jar dependencies, and add them to your project libs folder:
- vungle-android-sdk-6.9.1.aar
- gson-2.8.6.jar
- okhttp-3.12.2.jar
- okio-1.15.0.jar

Ouvrez le fichier build.gradle au niveau de l'application et ajoutez d'autres dépendances dans la section dependencies.

dependencies {
  // Vungle SDK
  implementation files('libs/vungle-android-sdk-6.9.1.aar')

  // Required Third-party Dependencies
  implementation files('libs/gson-2.8.6.jar')
  implementation files('libs/okhttp-3.12.12.jar')
  implementation files('libs/okio-1.15.0.jar')

  implementation 'androidx.core:core:1.3.2'
  implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

  // When appcompat is being used, core and localbroadcastmanager are the dependencies
  // that is getting included
  // implementation 'androidx.appcompat:appcompat:1.2.0'

  // Recommended for SDK to be able to get Android Advertising ID
  implementation 'com.google.android.gms:play-services-basement:17.5.0'
  implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

Étape 2. Importer le SDK Vungle

import com.vungle.warren.Vungle;
import com.vungle.warren.AdConfig;              // Custom ad configurations
import com.vungle.warren.InitCallback;          // Initialization callback
import com.vungle.warren.LoadAdCallback;        // Load ad callback
import com.vungle.warren.PlayAdCallback;        // Play ad callback
import com.vungle.warren.VungleNativeAd;        // MREC ad
import com.vungle.warren.Banners;               // Banner ad
import com.vungle.warren.VungleBanner;          // Banner ad
import com.vungle.warren.Vungle.Consent;        // GDPR consent
import com.vungle.warren.VungleSettings         // Minimum disk space
import com.vungle.warren.error.VungleException  // onError message

Étape 3. Ajouter le code

Initialiser le SDK

public static void init(@NonNull final String appId,
                        @NonNull final Context context,
                        @NonNull final InitCallback callback)

public static void init(@NonNull final String appId,
                        @NonNull final Context context,
                        @NonNull final InitCallback callback,
                        @NonNull final VungleSettings settings)

La méthode d'initialisation requiert les paramètres suivants :

L'ID d'application facultatif Vungle
Contexte de l'application
InitCallback
- onSuccess : notifie lorsque le SDK a été initialisé avec succès
- onError : notifie lorsque l'initialisation a échoué
  - Renvoie IllegalArgumentException si InitCallback a la valeur null.
- onAutoCacheAdAvailable : notifie si une publicité peut être diffusée au placement mis en cache automatiquement
VungleSettings (facultatif)
- Espace disque minimum - Configurez l'espace minimum disponible sur l'appareil pour l'initialisation et le fonctionnement du SDK
- Restriction de l'ID Android - Configurez la restriction de l'utilisation de l'ID de l'appareil Android

Vungle.init(appId, getApplicationContext(), new InitCallback() {
  @Override
  public void onSuccess() {
    // SDK has successfully initialized
  }

  @Override
  public void onError(VungleException exception) {
    // SDK has failed to initialize
  }

  @Override
  public void onAutoCacheAdAvailable(String placementId) {
    // Ad has become available to play for a cache optimized placement
  }
};

// 6.4.x & below
Vungle.init(appId, getApplicationContext(), new InitCallback() {
  @Override
  public void onSuccess() {
    // SDK has successfully initialized
  }

  @Override
  public void onError(Throwable throwable) {
    // SDK has failed to initialize
  }

  @Override
  public void onAutoCacheAdAvailable(String placementId) {
    // Ad has become available to play for a cache optimized placement
  }
};

Méthodes alternatives	Description
`onSuccess()`	Invoqué lorsque le SDK a été initialisé avec succès et qu'il est prêt à charger une publicité ou à en diffuser une si
`onError(VungleException exception)`	Invoqué lorsqu'une erreur se produit lors de la tentative d'initialisation du SDK. Vous pourrez vérifier le message d'erreur depuis `getLocalizedMessage` de `VungleException` et utiliser `getExceptionCode` pour le débogage.
`onAutoCacheAdAvailable(String placementId)`	Invoqué lorsqu'une publicité est devenue disponible pour une diffusion depuis un placement optimisé pour les caches. L'éditeur doit toujours publier explicitement `loadAd` pour les placements optimisés pour les caches, comme décrit dans la section Charger une publicité pour un placement.

Vous pouvez vérifier si le SDK Vungle est initialisé à tout moment en appelant la méthode isInitialized :

public static boolean isInitialized()

Intégrer les formats publicitaires

Complétez votre intégration SDK pour chaque format publicitaire que vous prévoyez d'afficher dans votre application. Consultez nos instructions pour chaque format publicitaire :

Personnalisez davantage vos publicités

Suivez les instructions de notre article sur les paramètres avancés pour affiner l'intégration de votre application avec des options de configuration supplémentaires, telles que le RGPD, la mise en œuvre du CCPA et de nombreux autres paramètres.