Android 用または Amazon 用 Vungle SDK を統合する

David Kim

2024年09月17日 17:35

はじめに

Vungle SDK は、API バージョン 30、Android 11 までビルドおよびテストされています。

要件

統合を行うには、Vungle アカウントが必要です。お持ちでない場合は、このページでアカウントを作成し、アカウントに新しい Android または Amazon アプリを作成します。Vungle ダッシュボードで広告配置を設定する方法については、パブリッシャーダッシュボードの使用に関する記事の「アプリと広告配置を追加する」セクションを参照してください。
Android 4.0 (Ice Cream Sandwich - API バージョン 14 以降)
Amazon OS 5.4 以降
プラットフォームは、Android SDK 6.5.1 以降の AndroidX である必要があります

SDK をダウンロードする

Android 用または Amazon 用 Vungle SDK を、https://publisher.vungle.com/sdk/sdks/android からダウンロードします

参照: サンプルアプリと Java Doc

サンプルアプリ: 統合の際には、以下で提供されているサンプルアプリを参照してください: https://github.com/Vungle/Android-SDK

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

手順 1. Vungle SDK をプロジェクトに含める

Vungle SDK は、Gradle 依存関係として統合することも、JAR または AAR 統合を使用して手動で統合することもできます。

// API version compatibility
minSdkVersion 14
compileSdkVersion 30
targetSdkVersion 30

Gradle

プロジェクトレベル build.gradle を開き、JCenter の詳細が次のようになっていることを確認します。

allprojects {
  repositories {
    jcenter()
  }
}

使用しているアプリケーションのアプリケーションレベルの build.gradle ファイルを開き、コンパイルの依存関係を 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

使用しているアプリケーションのアプリケーションレベルの build.gradle ファイルを開き、その他の依存関係を 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'
}

以下のコード行を追加し、アプリケーション項目名をアプリケーションクラス名に割り当てて AndroidManifest.xml を更新します。

<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>

Vungle 除外ルールを含めて 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

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'
}

手順 2. Vungle SDK をインポートする

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

手順 3. コードを追加する

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)

初期化メソッドでは、以下のパラメーターが使用されます。

Vungle アプリケーション ID
アプリケーションコンテキスト
InitCallback
- onSuccess: SDK が正常に初期化された場合に通知する
- onError: 初期化が失敗した場合に通知する
  - InitCallback が null の場合に IllegalArgumentException をスローします。
- onAutoCacheAdAvailable: 自動的にキャッシュされた配置広告に再生可能な広告が含まれている場合に通知する
VungleSettings (オプション)
- 最小ディスク領域 - SDK の初期化および操作用に、デバイスで使用可能な最小領域を構成する
- Android ID の制限 - Android デバイス ID の使用制限を構成する

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
  }
};

オーバーライド可能なメソッド	説明
`onSuccess()`	SDK が正常に初期化され、広告を読み込む準備ができているか、広告を再生する準備ができているとき (存在する場合) に呼び出されます。
`onError(VungleException exception)`	SDK の初期化中にエラーが発生したときに呼び出されます。`VungleException` の `getLocalizedMessage` からのエラーメッセージを確認し、`getExceptionCode` をデバッグに使用できます。
`onAutoCacheAdAvailable(String placementId)`	キャッシュに最適化された広告配置で広告を再生できるようになったときに呼び出されます。「広告配置用の広告を読み込む」で説明されているように、パブリッシャーはキャッシュに最適化された広告配置用の `loadAd` を明示的に発行することが引き続き期待されます。

isInitialized メソッドを呼び出すことにより、Vungle SDK が初期化されているかどうかをいつでも確認できます。

public static boolean isInitialized()

広告フォーマットを統合する

アプリに表示する予定の各広告フォーマットの SDK 統合を完了します。各広告フォーマットについては、以下の説明を参照してください。

広告を詳細にカスタマイズする

「詳細設定」の記事に記載されている手順に従い、GDPR、CCPA の実装、その他の多くの設定など、追加の構成オプションとのアプリの統合を詳細に設定します。