アプリイベント用のコンバージョンAPI

コンバージョンAPIを使用すると、広告主は複数のソースではなく単一のエンドポイントでウェブ、アプリ、実店舗、ビジネスメッセージイベントをMetaに送信できるようになります。この統合により、データセットを使用することで広告主のテクノロジースタックが簡素化され、Metaイベントマネージャ内でのより包括的なビューを実現できます。

このドキュメントは、アプリイベントをコンバージョンAPIに統合するためのガイダンスを提供しています。

前提条件

1.データセット

コンバージョンAPIを通して送信されるアプリイベントは、データセットに関連付けられている必要があります。

https://graph.facebook.com/v16.0/{ads-pixel-id}/is_consolidated_containerに対してGET呼び出しをして、広告主のデータセットが統合されていて、コンバージョンAPIでアプリイベントを渡せるかどうかを検出することができます。

2.アクセス許可

• 広告主として直接統合を実施するには、前提条件とアクセス許可について説明しているこちらの指示に従ってください。

• パートナープラットフォーム統合を実施するには、前提条件とアクセス許可について説明しているこちらの手順に従ってください。

設定

コンバージョンAPIへのアプリイベントの送信

a.データセットIDとアプリIDのリンク

イベントマネージャでは、次の2つの方法でアプリとデータセットをリンクすることができます。

• [データソース]タブを選択し、アプリの[設定]タブを見つけてリンクを実行する。
• アプリの[概要]タブで[データソース]タブを選択し、[すべてのアクティビティ]セクションの[データセットへのリンク]ボタンを使用します。

リンクが完了すると、データセットにリンク済みのアプリが含められます。

b.必須フィールド

こちらから、コンバージョンAPI経由で送信可能な現在のパラメーターセットを参照することができます。アプリイベントを送信する場合、以下のserver_event fieldsをペイロードで共有することができます。

• パラメーターaction_sourceは、アプリイベントの値appを含んでいる必要があります。
• 重複除外のセットアップケースにはevent_idが必要です。
• app_dataフィールド
• user_dataフィールド
• custom_dataフィールド

アプリデータフィールド

顧客情報パラメーター

カスタムデータ

要約すると、コンバージョンAPIを使用して共有されたアプリイベントには、以下のデータパラメーターが必要になります。

• action_source: ‘アプリ’に設定する必要があります。(コンバージョンAPIを使うことで、action_sourceパラメーターが自分の知る限り正確であることに同意するものとします)
• event_id: 重複除外の設定に必須です。詳細は「複数チャネルの重複除外を設定する」セクションをご覧ください。
• advertiser_tracking_enabled
• application_tracking_enabled
• extinfo

以下はextinfoの例です。以下のサブパラメーターがすべて入力され、順番通りになっていることを確認してください。何か欠けている場合は、空の文字列をプレースホルダーとして使用してください。

c.複数のチャネルの重複除外を設定する

コンバージョンAPIの統合とSDK、MMP、アプリイベントAPIを含むアプリイベントとのほかのすべての統合間の重複イベントトラフィックを削除するには、重複除外メカニズムが必要になります。

アプリイベントでは、ウェブイベントに対するものと同じ重複除外機能が適用されます。このロジックでは、フィールドevent_idとevent_nameベースの重複除外(コンバージョンAPIとSDK / App Events APIイベントは同じevent_id)を利用します。event_idパラメーターは、類似するイベントを一意に区別できる識別子です。イベントIDが不正確だと、コンバージョンが誤って重複除外され、コンバージョンレポートとキャンペーンパフォーマンスにさらに影響が及ぶ可能性があります。

重複除外の設定を実装するには、以下の開発者ドキュメントを参照してください。

• アプリイベントの設定方法
• 重複除外の設定例

以下は、カスタムイベントの記録方法の例です。記録するには、イベントの名前をiOS SDKのAppEvents.Nameとして渡します。

AppEvents.shared.logEvent(.achievedLevel, parameters: [AppEvents.ParameterName(rawValue: "event_id"): "123"])

アプリのインストールイベントでは、過去90日間のウィンドウに1つのインストールしかアトリビューション分析されていないことを確認する重複除外メカニズムがすでに存在しています。Metaでは最初のイベントを維持し、後のイベントはそのアクションソースに関係なくドロップします。インストールイベントに関連するアプリイベントの重複除外を実装する必要はありません。

d.イベントの送信

新しいイベントを送信するには、このパス(https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN})からコンバージョンAPIにPOSTをリクエストしてください。このエッジにPOSTリクエストを送信すると、Metaは新しいアプリサーバーイベントを作成します。詳細については、以下の開発者ドキュメントを参照してください。

以下は、パラメーターがペイロードの全体的なスキーマにどのように適合するかについての概要です。

{
    "data": [
        {
            "event_name": "Purchase",
            "event_time": 1684389752,
            "action_source": "app",
            "user_data": {
                "em": [
                    "30a79640dfd8293d4f4965ec11821f640ca77979ca0a6b365f06372f81a3f602"
                ],
                "ph": [
                    "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b",
                    "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b"
                ],
                "madid": "bbbbbbbbbbbb",
      "anon_id": "cccccccc"
            },
            "custom_data": {
                "currency": "USD",
                "value": "142.52"
            },
            "app_data": {
                "advertiser_tracking_enabled": "True",
                "application_tracking_enabled": "True",
                "campaign_ids": "aaaaaaaaa",
                "extinfo": [
                    "a2",
                    "com.some.app",
                    "771",
                    "Version 7.7.1",
                    "10.1.1",
                    "OnePlus6",
                    "en_US",
                    "GMT-1",
                    "TMobile",
                    "1920",
                    "1080",
                    "2.00",
                    "2",
                    "128",
                    "8",
                    "USA/New York"
                ]
            }
        }
    ]
}

トラブルシューティング

ペイロードヘルパーツールを使用して、ペイロードのデータを生成できます。

• 該当する場合にはappアクションソースを選択します
• Metaに送信されるイベントの情報を入力します
• これによりイベントペイロードが生成されます。このペイロードは、コンバージョンAPI統合のテンプレートとして使用できます

テストにはイベントマネージャのテストイベントツールを使用します。

参考情報

• コンバージョンAPIの概要
• コンバージョンAPIの使用
• コンバージョンAPIのパラメーター
• ベストプラクティス