モバイルアプリ向けSDK – DLPOヘルプセンター

モバイルアプリ向けSDKとは

AndroidまたはiOS向けネイティブアプリ上で、DLPOを実装するためのSDKになります。SDKの利用により、アプリ上でのABテスト、パーソナライズ機能を実現でき、開発工数を軽減できます。

本SDKは、ウェブサーバーからABテスト内容が反映されているコンテンツを配信する仕組みとなります。

図１：仕組み

制限事項

クリエイティブの作成は、JSONデータのみとなります。
DLPOキャンペーンでは、クリエイティブの設定、コンバージョンの設定のみに対応しております。オプション設定（サイト内行動ターゲティング・ウェブ解析ツール連携）はご利用いただけません。
セグメント設定では、「地域」「ドメイン・IPアドレス」「曜日・時間」「訪問回数」のみに対応しております。サイト内行動履歴、カスタム設定などはご利用いただけません。

事前準備

利用ドメインの登録
アプリにて利用するドメインをDLPOへ登録する必要があります。DLPOサポートへご連絡ください。
既に登録済みの場合は、改めて登録する必要はありません。また、ウェブサイト配信用に取得したドメインである必要はありません。架空ドメインを設定し利用することも可能です。
SDKの配布
ご利用のSDKファイルを配布いたします。DLPOサポートへご連絡ください。
SDKファイル形式は以下の通りです。任意の方法でインポートしてご利用ください。
・Android：aarファイル
・iOS：XCFramework

設定手順（Android）

1．ワンコード条件の登録、ワンコードルールの設定

本SDKでは、エリア、及びコンバージョンのワンコード設定が必要です。それぞれのワンコード条件を登録し、ワンコードルールへ設定してください。登録方法及びルール設定の詳細は、「ワンコード実装」をご覧ください。

ワンコード条件を登録する際のポイントとして、エリア名/コンバージョン名は、「個別指定」を選択し、半角英数字と記号の”_”(アンダーバー)を使用して任意の値を設定してください。エリア名/コンバージョン名は、アプリ側の実装時に使用します。
エリア設置URL/コンバージョン設置URLには、DLPOへ登録済みの利用ドメインを設定してください。

図２－１：ワンコード条件登録（エリア）

図２－２：ワンコード条件登録（コンバージョン）

2．クリエイティブの登録

クリエイティブは、アプリへ連携するデータをJSON形式にて登録してください。
クリエイティブ個別登録のHTMLエディターを利用して、JSONデータを記述してください。登録方法の詳細は「クリエイティブ個別登録」をご覧ください。

図３：クリエイティブ個別登録（HTMLエディター）

3．セグメントの登録

必要に応じて、セグメントを登録してください。
セグメント設定では、「地域」「ドメイン・IPアドレス」「曜日・時間」「訪問回数」のみに対応しております。登録方法の詳細は「セグメント個別登録」をご覧ください。

4．アプリ側の実装

アプリにSDKファイルをインポートし、クリエイティブの表示処理、及びコンバージョンポイントの送信処理を実装してください。設定、各処理にて必要な記述は以下をご覧ください。

1）マニフェスト設定
AndroidManifest.xmlに、以下のようにアカウントIDとDLPO利用ドメインを設定します。ドメインは事前にDLPO管理画面用に利用申請を行なったものをご利用ください。

図４－１：マニフェスト設定

2）クリエイティブ取得
クリエイティブを取得するには、作成したDlpoインスタンスからrequestCreativeメソッドを実行してください。エリアを指定してリクエストを実行することで、クリエイティブ情報がJSONObjectとして取得できます。リクエストは非同期で実行されます。

図４－２：クリエイティブ取得

※エリア "area_1" には、ワンコード条件を登録した際に設定したエリア名を指定してください。

3）コンバージョン送信
コンバージョンを送信するには、作成したDlpoインスタンスからrequestConversionメソッドを実行してください。リクエストは非同期で実行されます。

図４－３：コンバージョン送信

※コンバージョン "conversion_1" には、ワンコード条件を登録した際に設定したコンバージョン名を指定してください。

4）通信タイムアウト設定
通信のタイムアウト時間をミリ秒単位にて指定できます。
※タイムアウト時間はコネクション確率までの時間と通信受信時間それぞれに半分ずつ制限時間が割り振られるため、最短で指定時間の半分で接続を遮断します。
例えば、20秒指定の場合、実際のタイムアウトは10秒～20秒になります。

図４－４：通信タイムアウト設定

5）WebView-ネイティブ間での計測
WebViewで開くURLにappendUidメソッドでパラメータを付与することで、WebViewとネイティブ側のユーザーを統合して計測することができます。
※WebViewで開くページにDLPOのワンコードタグが設置されている必要があります。
※URLの後ろに「_dlxud」というパラメータが付与されます。

図４－５：WebView-ネイティブ間での計測

5．アプリ起動

ワンコード条件にて設定したエリア、コンバージョンを認識させるため、アプリを起動し、実装したすべてのリクエストを実行してください。

6．キャンペーンの登録、稼働

Standardキャンペーン作成にて、キャンペーンを作成し、対象エリアにクリエイティブ、セグメントを設定、またコンバージョンを設定してください。作成したキャンペーンを稼働させると、対象アプリにてABテスト及びパーソナライズ配信が実行されます。
キャンペーン作成の詳細は「Standardキャンペーン作成による設定」をご覧ください。

図５－１：Standardキャンペーン作成（2.詳細設定）

図５－２：Standardキャンペーン作成（3.コンバージョン設定）

設定手順（iOS）

1．ワンコード条件の登録、ワンコードルールの設定

図６－１：ワンコード条件登録（エリア）

図６－２：ワンコード条件登録（コンバージョン）

2．クリエイティブの登録

図７：クリエイティブ個別登録（HTMLエディター）

3．セグメントの登録

4．アプリ側の実装

1）設定定義
info.plistに、以下のようにアカウントIDとDLPO利用ドメインを設定します。ドメインは事前にDLPO管理画面用に利用申請を行なったものをご利用ください。
※アカウントIDのキー名は"Dlpo Sdk AccountId"、DLPO利用ドメインのキー名は"Dlpo Sdk Hostname"になります。

図８－１：設定定義