Pop(2.0): はじめに

Getting started

SDKをアプリに実装するにあたり、下記の2点が必要となります。

Buzzvil担当者を通じて取得した app_idとunit_id
Buzzvil サーバーからポイント付与リクエストを受信する貴社(メディア側)APIサーバー - ポイントポストバックAPI 連携文書
- Postback 受信用URLを設定後、Buzzvil担当者までお知らせください。

前提条件

Android Studio 3.2 またはそれ以上
minSdkVersion 16 またはそれ以上
compileSdkVersion 29 またはそれ以上

index

1 Getting started
2 Step 1: インストール
3 Step 2: BuzzAdPop SDKの初期化
4 Step 3: ログイン
5 Step 4: 権限設定
6 Step 5. 実行
7 POPのカスタマイズ
8 追加リソース

Step 1: インストール

githubにてサンプルコードを公開しているので、実装の際の参考資料としてご活用ください。

BuzzAdPop Sdkはmavenを通じてダウンロードすることができます。
下記のコードを build.gradle に追加してください。

repositories {
    maven { url "https://dl.buzzvil.com/public/maven" }
}

dependencies {
    implementation "com.buzzvil:buzzad-benefit-pop:2.15.+"
}

Note: BuzzAdPopは BuzzAdBenefit SDK に統合された状態で配布されています。

Step 2: BuzzAdPop SDKの初期化

BuzzAdPopは BuzzAdBenefit SDKに統合された状態で管理されているため、POPを初期化するにはBuzzAdBenefit を初期化する必要があります。Popを実行する前に BuzzAdBenefit.init()を呼び出し、BuzzAdPop SDKを初期化してください。この時Buzzvilからお渡しした unit id を代入してください。また、必要に応じてPopの表示カスタマイズ内容を追加します。この部分の詳細については初期化ページを参照してください。初期化コードはアプリの実行時に1回だけ行います。

下記コードは init()パラメータをApplicationにて呼び出す際のコード例です。

package ...
import ...
import com.buzzvil.buzzad.benefit.BuzzAdBenefit;
import com.buzzvil.buzzad.benefit.BuzzAdBenefitConfig;
import com.buzzvil.buzzad.benefit.presentation.pop.PopConfig;

public class App extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        final PopConfig popConfig = new PopConfig.Builder(getApplicationContext(), "POP_UNIT_ID_HERE")
                .build();
        final BuzzAdBenefitConfig buzzAdBenefitConfig = new BuzzAdBenefitConfig.Builder(getApplicationContext())
                .add(popConfig)
                .build();

        BuzzAdBenefit.init(this, buzzAdBenefitConfig);
    }
}

Step 3: ログイン

広告の割当を受けるにはユーザーIDおよびターゲティング情報を設定する必要があります。ユーザーがアプリにログインした時点で下記のようにUserProfileを設定します。設定値を修正する際は既存のuser profileを呼び出して修正することが可能です。

userId : 貴社サービスにおいてユーザーを特定できるID
- 特定の条件においてuserIdが変更になる可能性がある場合は、事前にBuzzvil担当者にご相談ください。(例：ユーザーがアンインストール後にアプリを再インストールするとuserIdが変わる場合など)
gender
- UserProfile.Gender.MALE: 男性
- UserProfile.Gender.FEMALE: 女性
birthYear: 生まれ年

final UserProfile.Builder builder = new UserProfile.Builder(BuzzAdBenefit.getUserProfile());
final UserProfile userProfile = builder
        .userId("Your_Service_User_ID")
        .gender(UserProfile.Gender.MALE)
        .birthYear(1985)
        .build();
  
BuzzAdBenefit.setUserProfile(userProfile);

ユーザーがアプリからログアウトした時点で UserProfile をnullにする設定もあわせて行ってください。

Step 4: 権限設定

BuzzAdPopの実装先アプリが 他のアプリの上に表示 権限をすでに取得済みの場合はこの部分は飛ばしてもかまいません。

Popを実行するには他のアプリの上に表示権限が必要になります。これはユーザー自身がアプリ設定画面にて権限を許可する作業を行わなければなりません。ユーザーがこの機能をONにしない場合、Popを実行することができません。BuzzAdPop SDKでは BuzzAdPop classを通じて現在のアプリが該当の権限を許可しているか確認し、ユーザーを設定画面に誘導する機能を提供しています。なお、すでに実装済みの場合はこの部分は飛ばしてもかまいません。

Popの権限設定を行うActivityにBuzzAdPop classを変数として追加します。
Activityの onCreateにてPopのunit idを代入し、BuzzAdPopのインスタンスを生成します。
アプリの実行に必要な権限が許可済みかどうかを確認し、許可されていない場合は許可するよう誘導します。
ユーザーが設定にて 他のアプリの上に表示 権限を許可すると本来のActivityに戻ります。この時result値がIntentとして戻されます。この値を読み込むことで設定にて権限が許可されたことを確認できます。

Step 5. 実行

Popをアクティブ化するためにBuzzAdPop.preloadAndShowPop() 関数を呼び出します。一度アクティブになると foreground serviceがONになり、画面がONになるたびにPopが表示されるようになります。

POPのカスタマイズ

PopのCTA Color変更、吹き出し(MessagePreview)機能等をカスタマイズすることができます。
カスタマイズの詳細についてはこちらのページを参照してください。

追加リソース

Githubのサンプル

Pop サンプルアプリ: Github(Java)
Popデザインガイド(デザインカスタマイズについて詳しく案内しています)