vivoマーケティングプラットフォーム統合プラン
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| 広告効果データ | API | 集約指標 | ✅ | ✅ | ✅ | ✅ |
現在、AEはvivoマーケティングプラットフォームMarketing APIの広告効果データの統合に対応しており、広告クリエイティブ階層のコスト、クリック、表示などの集約指標データを取得できます
統合の流れ
- AE管理画面にログインし、サードパーティ統合モジュールでvivo統合プランを追加して関連する設定を完了し、認証用のポストバックURLをコピーします
- vivo開発者管理画面にログインし、開発者アカウントを取得してアプリを作成し、必要な認証情報を収集します
- AE管理画面に戻り、先ほどのvivo統合プランを編集してアプリのClient IDとsecretを使用し、認証リンクを開いて認証を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. プランの設定
vivoプラットフォームのデータを統合する前に、まずAE管理画面で対応する統合プランを作成し、認証用のポストバックURLを取得する必要があります。本ドキュメントに従って統合プランを作成してください
1.1 仮の認証情報の入力
まず、認証情報欄の「認証情報設定」ボタンをクリックし、表示された認証情報のポップアップで、一時的な認証情報として3つの項目に任意の値を入力します。vivoプラットフォームでアプリを作成した後に、改めて調整する必要があります。
1.2 定期取得
「定期取得」モジュールで、AEシステムがvivo Marketing APIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻に一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
1.3 格納設定
データをイベントとして書き込むかどうかを制御できます。オフにすると、データはイベントテーブルに書き込まれなくなるため、この設定はオフにしないでください。
1.4 統合構成
最後に、統合構成モジュールでデータ取得の詳細設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | time_granularity | データの時間集計の粒度。取得したデータを日単位と時間単位のどちらで集計するかを指定します 選択可能な値: DAY、HOUR |
| report_types | データ階層。選択できるデータ階層は1つのみです 選択可能な値：ACCOUNT（アカウント階層）、CAMPAIGN（キャンペーン階層）、GROUP（広告グループ階層）、ADVERTISEMENT（広告階層）、CREATIVE（クリエイティブ階層、デフォルトの階層） |
1.5 認証用のポストバックURLの取得
上記の設定が完了したら、右上の「保存して許可する」をクリックし、認証情報を取得してください。最初のステップにある認証用のポストバックURLをコピーし、大切に保管してください。その後、「認証保留中」をクリックしてポップアップを閉じます：
「保存して許可する」をクリックした時点でプランは保存されるため、別途保存する必要はありません。これでAE管理画面での設定作業はいったん完了です。次に、vivoの管理画面で関連する設定を行ってください。
2. 開発者アカウントの取得とアプリの作成
AE管理画面での統合プランの作成が完了したら、vivo開発者プラットフォームのアプリも用意する必要があります。vivo開発者アプリを作成済みの場合は、このセクションをスキップできます
2.1 開発者アカウントの取得
vivo Marketing APIを統合する前に、まず開発者アカウントを取得する必要があります。開発者公式サイトにアクセスし、右上のログインボタンをクリックしてログインページに移動し、二次代理店アカウントまたは広告主アカウントのマーケティングプラットフォームアカウントでログインします。
2.2 アプリの申請と作成
マーケティングプラットフォームアカウントでログインして開発者になったら、アプリ管理画面に移動します：
右上の「アプリを新規作成」ボタンをクリックして、アプリケーションの作成画面に移動します：
以下の説明に従って設定を編集し、完了したら「提出」をクリックしてアプリを作成します
-
アプリアイコン：カスタマイズ可能。250 x 250 pxのアプリアイコンで、50kb未満。
-
アプリ名：カスタマイズ可能。15文字以内
-
コールバックURL：AE管理画面のvivo統合プランで取得したポストバックURLを入力します
-
アプリの紹介：Marketing APIに基づいてアプリケーションで実現したい機能と、その機能が審査を通過する必要がある理由を説明します。広告インサイトデータを自社の分析プラットフォームにコールバックする必要がある、と記述できます
-
Tokenの有効期間：
- Access Tokenの有効期間：このアプリにおけるaccess tokenの有効時間
- Refresh Tokenの有効期間：このアプリにおけるrefresh tokenの有効時間。access tokenの有効時間より長くする必要があります
その後、vivoの審査担当者が2-3営業日以内に審査を行います。審査が完了したら、次の作業に進みます。
2.3 Client IDとClient Secretの取得
vivo開発者プラットフォームに戻り、「マイアプリ」ページで作成したアプリのclientIdとSecret、つまりClient IDとClient Secretを取得します
2.4 広告アカウントIDの取得
最後に、データを取得する広告アカウントのIDも取得する必要があります。vivoマーケティング管理画面にログインし、右上のメニューにある「アカウント管理」をクリックすると、アカウントセンターセクションのアカウント情報タブでアカウントIDを確認できます。
3. AE管理画面に戻り、認証作業を完了
vivo管理画面での設定が完了したら、AE管理画面に戻り、先ほど作成したvivo統合プランを開いて、認証情報欄の「認証情報設定」ボタンをクリックします：
次に、vivo管理画面で取得したClient IDとClient Secretを該当する箇所に入力し、Advertiser IDには前のステップで取得した広告アカウントIDを入力します。編集が完了したら「保存」ボタンをクリックします：
続いて右上の「保存して許可する」をクリックすると、再度認証情報のポップアップが表示されます。ここで「認証設定へ」をクリックすると、vivoプラットフォームの認証ページが開きます
vivoの広告主アカウントをお持ちの場合は、広告主アカウントで直接ログインすることをお勧めします。
認証が完了したら、「認証情報」で左下の「以上の2つのステップを完了しました」をクリックし、右下の「認証完了」をクリックして設定を終了します。これで、vivoプラットフォームのデータ統合は完了です。
4. データの格納
4.1 格納ルール
- クリエイティブレポートは集計データであるため、ユーザー識別子として固定値を使用します。すべてのデータが1人の仮想ユーザーに紐づいていると考えてください
- データ内のreportdateまたはreporttimeフィールド、つまりデータの集約時間を、イベントの#event_timeとして使用します
- デフォルトのイベント名：vivo_ads_data
- その他のフィールドはすべて格納されます
4.2 対象フィールド
広告クリエイティブデータでは、以下のフィールドを取得できます：
| フィールド名 | 名称と備考 |
|---|---|
| campaignid | キャンペーンID |
| campaignname | キャンペーン名 |
| mediatype | プロモーションキャンペーンタイプ |
| groupid | 広告グループID |
| groupname | 広告グループ名 |
| advertisementid | 広告ID |
| advertisementname | 広告名 |
| creativeid | クリエイティブID |
| placetype | 広告枠タイプ。詳細は【付録-広告枠の列挙値（広告レポート）】を参照 |
| apppackage | パッケージ名 |
| cvtype | コンバージョンタイプ。詳細は【付録-広告グループのコンバージョン目標タイプ】を参照 |
| reportdate | レポート時間。日単位で照会した場合に返されます。形式：20200824 |
| reporttime | レポート時間。時間単位で照会した場合に返されます。形式：2020-06-28 11:00:00 |
| advertiserid | 広告主ID |
| showcount | 露出数 |
| clickcount | クリック数 |
| downloadcount | ダウンロード数 |
| spent | 費用 |
| activatecount | 新規アクティベーション数 |
| registercount | ゲーム登録数 |
| formsubmitcount | フォーム送信数 |
| normalactivatecount | 通常アクティベーション数 |
| backactivatecount | カスタムアクティベーション数 |
| backregistercount | カスタム登録数 |
| adddesktopcount | ホーム画面追加数 |
| customretaincount | カスタム翌日リテンション数 |
| gamepaycount | ゲーム課金数 |
| custompaycount | カスタム課金数 |
| reactivation | カスタムリエンゲージメント |
| webpay | Web購入 |
| gameappointment | ゲーム予約数 |
| buttonclick | ボタンクリック数 |
| fastapppay | クイックアプリ課金数 |
| personalizedevents | パーソナライズイベント数 |
| activatec | 新規アクティベーション数（広告課金時間基準） |
| backactivatec | カスタムアクティベーション数（広告課金時間基準） |
| registerc | ゲーム登録数（広告課金時間基準） |
| backregisterc | カスタム登録数（広告課金時間基準） |
| adddesktopc | ホーム画面追加数（広告課金時間基準） |
| cdownloadcount | ダウンロード数（広告課金時間基準） |
| customretainc | カスタム翌日リテンション数（広告課金時間基準） |
| gamepayc | ゲーム課金数（広告課金時間基準） |
| custompayc | カスタム課金数（広告課金時間基準） |
| reactivationc | カスタムリエンゲージメント（広告課金時間基準） |
| gameappointmentc | ゲーム予約数（広告課金時間基準） |
| firstdayrecoveryadmonetizationc | 初日回収額-広告収益化（広告課金時間基準） |
| totalrecoveryadmonetizationc | 累計回収額-広告収益化（広告課金時間基準） |
| firstdayrecoverypaidrechargec | 初日回収額-チャージ課金（広告課金時間基準） |
| totalrecoverypaidrechargec | 累計回収額-チャージ課金（広告課金時間基準） |
| cfastapppay | クイックアプリ課金数（広告課金時間基準） |
| cpersonalizedevents | パーソナライズイベント数（広告課金時間基準） |
| cnormalactivatecount | 通常アクティベーション数（広告課金時間基準） |
| ccreditcount | カスタム与信数（広告課金時間基準） |
| cinstalldonecount | インストール完了数（広告課金時間基準） |
| wechatgameregisterc | WeChatミニゲーム登録数（広告課金時間基準） |
| wechatgamepayc | WeChatミニゲーム課金数（広告課金時間基準） |
| creactivationretentioncount | リエンゲージメントのカスタム翌日リテンション数（広告課金時間基準） |
| creditcount | カスタム与信数（コンバージョン時間基準） |
| installdonecount | インストール完了数（コンバージョン時間基準） |
| wechatgameregistercount | WeChatミニゲーム登録数（コンバージョン時間基準） |
| wechatgamepaycount | WeChatミニゲーム課金数（コンバージョン時間基準） |
| reactivationretentioncount | リエンゲージメントのカスタム翌日リテンション数（コンバージョン時間基準） |
| reservecount | カレンダー予約数（コンバージョン時間基準） |
| identifycodecount | WeChat-QRコード認識数 |
| addwechatmpacount | WeChat-WeChat追加数 |
| dialoguempacount | WeChat-ユーザーの初回メッセージ数 |
| onedialoguecount | 有効な問い合わせ数 |
| firstdayrecoverypaidcount | ゲーム初日の初回課金 |
| tacount | ターゲットユーザー数（コンバージョン時間基準） |
| ctacount | ターゲットユーザー数（広告課金時間基準） |
| payonetimecount | アプリ課金回数（コンバージョン時間基準） |
| cpayonetimecount | アプリ課金回数（広告課金時間基準） |
| payonetimeamount | アプリ課金額（コンバージョン時間基準）。単位はミリフェン（1フェンの1000分の1）で、1元=100000ミリフェン |
| cpayonetimeamount | アプリ課金額（広告課金時間基準）。単位はミリフェン（1フェンの1000分の1）で、1元=100000ミリフェン |
4.3 標準化フィールド
AEシステムは以下のフィールドを標準化処理します：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| advertiserid | te_ads_object.ad_account_id | 広告アカウントID |
| campaignid | te_ads_object.campaign_id | 広告キャンペーンID |
| campaignname | te_ads_object.campaign_name | 広告キャンペーン名 |
| groupid | te_ads_object.ad_group_id | 広告グループID |
| groupname | te_ads_object.ad_group_name | 広告グループ名 |
| advertisementid | te_ads_object.ad_id | 広告クリエイティブID |
| advertisementname | te_ads_object.ad_name | 広告クリエイティブ名 |
| showcount | te_ads_object.impressions | 露出数 |
| clickcount | te_ads_object.clicks | クリック数 |
| activatecount | te_ads_object.installs | コンバージョン数 |
| spent | te_ads_object.cost | ユーザー獲得コスト |