ビジネスメッセージ用のコンバージョンAPI

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

このドキュメントは、ビジネスメッセージイベントをコンバージョンAPIに統合するためのガイダンスを提供しています。ビジネスメッセージにコンバージョンAPIを使用する利点は、以下の通りです(ただし、これらに限定されません)。

広告マネージャのレポートで結果を直接確認: 広告主は、開始された会話ではなく、購入数や購入単価など、Metaサーフェス上での直接関係する結果に基づいて、メッセージ誘導広告キャンペーンの結果を簡単に理解できます。
データ統合の簡素化: 1つのAPIで、複数のメッセージプラットフォーム(Messenger、WhatsApp)およびチャネル(ウェブサイト、アプリ、ストア、メッセージ機能)間でデータを取り込み、共有します。
パートナー測定の改善: 広告インサイトAPIを通じてパートナーダッシュボードでメッセージ誘導キャンペーンアトリビューションを直接有効にします。

前提条件

データセット

コンバージョンAPIを通じて送信されたビジネスメッセージイベントは、データセットに関連付けられている必要があります。

データセットを使用すると、広告主はウェブ、アプリ、ストア、ビジネスメッセージイベントソースからのイベントデータをコンバージョンAPIに接続して管理できます。データセットには、設定した以下の連携からのイベントデータが表示されます。

Metaピクセル(ウェブサイトイベント)
アプリイベントAPI(iOSまたはAndroid用Facebook SDK、モバイル測定パートナー(MMP)など)
オフラインコンバージョンAPI(オフラインイベント用のMetaのレガシーAPI)

データセットを使用すると、単一のインターフェイスからすべての顧客アクティビティを閲覧できます。また、複数のAPI統合を構築および維持する労力��軽減することもできます。

イベントマネージャでは、広告主は出発点に応じてデータセットを作成するためのさまざまなオプションを利用できます。または、オフラインイベントセットの作成中、既存のモバイルアプリ経由、またはイベントセット作成情報のメッセージング中にリンクすることにより、イベントマネージャで新しいデータセットを作成することもできます。モバイルアプリイベントをコンバージョンAPIに送信する前に、アプリにデータセットをリンクする必要があります。その際、データセットにリンクできるアプリは1つのみです。さらなる詳細と説明については、こちらをご覧ください。

アクセス許可

広告主として直接統合を実施するには、前提条件とアクセス許可について説明しているこちらの指示に従ってください。
パートナープラットフォーム統合を実施するには、以下が必要です。
- ads_read、ads_management、pages_messaging、whatsapp_business_messaging、pages_show_list、instagram_manage_messagesアクセス許可へのアドバンスアクセス。
- 広告管理標準アクセス機能。
- イベントの種類に応じて、MessengerまたはWhatsAppイベントのpage_eventsアクセス許可、またはInstagram Directのinstagram_manage_eventsへのアドバンスアクセスが必要です。

パートナーのオンボーディング

プラットフォームとしてパートナー連携を統合している場合は、ビジネス用Facebookログイン(推奨)またはMeta Business拡張機能のオンボーディング方法のいずれかを使用できます。

詳しい手順がある連携方法のガイドが含まれている、ビジネスメッセージ用コンバージョンAPIのガイドを参照してください。

メッセージ機能とWhatsApp用のデータセットAPI

データセットAPIは、指定したページにアタッチされているdataset_idを取得するために使用されます。このdataset_idは後でコンバージョンAPIで使用されます。データセットAPIを使用できるようにするには、ビジネス用FacebookログインまたはMeta Business拡張機能を通じてクライアントによってアプリに付与された、MessengerまたはWhatsAppイベントに対するpage_eventsアクセス許可が必要です。

dataset_idを取得するには、page_idとaccess_tokenを使用してデータセットAPIへのGET呼び出しを行う必要があります。下記の呼び出しの例をご覧ください。

https://graph.facebook.com/v16.0/{PAGE_ID}/dataset?access_token={TOKEN}

応答はdataset_idを表すIDになります。これと以前に受け取ったアクセストークンを使用して、コンバージョンAPIを呼び出してMetaにメッセージイベントを送信できるようになりました。

Instagram用データセットAPI

データセットAPIは、指定したページに添付されているdataset_idを取得するために使用されます。このdataset_idは後ほどコンバージョンAPIで使用されます。データセットAPIを使用できるようにするには、ビジネス用FacebookログインまたはMeta Business拡張機能を通じてクライアントによってアプリに付与されたinstagram_manage_eventsアクセス許可が必要です。

dataset_idを取得するには、ig_user_idとaccess_tokenを使用してデータセットAPIへのGET呼び出しを行う必要があります。呼び出しの例はこちら。

https://graph.facebook.com/v16.0/{IG_USER_ID}/dataset?access_token={TOKEN}

応答はdataset_idを表すIDになります。これと以前に受け取ったアクセストークンを使用して、コンバージョンAPIを呼び出してMetaにメッセージイベントを送信できるようになりました。

設定

ビジネスメッセージイベントパラメーターを設定する

こちらから、コンバージョンAPI経由で送信可能な現在のパラメーターセットを参照することができます。ビジネスメッセージイベントを送信する場合、さまざまなメッセージプラットフォームのユーザーデータペイロードで次のフィールドを共有できます。

プラットフォーム	パラメーター	説明書
Messenger	`page_id`	Messengerでは必須ビジネスに関連付けられているFacebookページID。
Messenger	`page_scoped_user_id`	Messengerでは必須ページとのやり取りを行うユーザーは、Page-Scoped User ID (PSID)で識別されます。PSIDはこのWebhookから取得できます。
WhatsApp	`page_id`	WhatsAppでは必須 Whatsappビジネスに関連付けられているFacebookページID。
WhatsApp	`ctwa_clid`	WhatsAppでは必須 `ctwa_clid`は、ビジネスAPIバージョン2.45.1以降(オンプレミス)またはクラウドAPIのメッセージWebhookの参照オブジェクトからのみ利用可能です。
Instagram	`ig_account_id`	Instagramでは必須ビジネスに関連付けられているInstagramアカウントID。
Instagram	`ig_sid`	Instagramでは必須 Instagramとのやり取りを行うユーザーは、Instagram-Scoped User IDs (IGSID)で識別されます。IGSIDはこのwebhookから入手できます。

イベントの送信

新しいイベントを送信するには、このパスからコンバージョンAPIに対してPOSTリクエストを行ってください:

https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}

このエッジにPOSTリクエストを送信すると、Metaは新しいビジネスメッセージイベントを作成します。詳細については、以下の開発者ドキュメントを参照してください。

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

Messengerイベントの場合

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "messenger",
      "user_data": {
        "page_id": <PAGE_ID>,
        "page_scoped_user_id": <PSID>
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "<PARTNER_NAME>"
}

WhatsAppイベントの場合

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "whatsapp",
      "user_data": {
        "page_id": <PAGE_ID>,
        "ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO2E4Nx0-eM-GABDLOPaOdRMv-_zfUQ2a", // <CLICK_TO_WHATSAPP_CLICK_ID>
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "<PARTNER_NAME>"
}

Instagramイベントの場合

CTD CAPIリクエストの例

POST /{dataset_id}/events

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "instagram",
      "user_data": {
        "ig_account_id": <IG_ACCOUNT_ID>,
        "ig_sid": <IGSID>
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "<PARTNER_NAME>"
}

トラブルシューティング

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

イベントマネージャを開いて、ページとリンクしたデータセットを選択します
テストイベントタブをクリックします
マーケティングチャネルとメッセージチャネルを選択します
[グラフAPIエクスプローラ]ボタンをクリックします
グラフAPIエクスプローラは、事前入力済みのペイロードで設定されます
[送信]ボタンをクリックします

動画ウォークスルー

統合を実装する方法の詳しい説明については、この動画をご覧ください。

何らかのエラーが発生しました

エラーが発生し、この動画を再生できませんでした。

詳しくはこちら

よくある質問

ビジネスメッセージ用のコンバージョンAPIはどのようなタイプのメッセージイベントをサポートしていますか？

A: ビジネスメッセージ用のコンバージョンAPIは、現在、ビジネスメッセージの送信されたリードと購入イベントのみをサポートしています。メッセージイベントはメッセージスレッドで発生する顧客とのやり取りのみを表すものであり、ウェブサイトなどの他のチャネルで発生するコンバージョンではありません。統合プロセス中に対応するアクションソースを選択することで、イベントを簡単に区別することができます。

異なるコンバージョンAPIの統合で同じアプリを維持するか、別のアプリを使用するかについてMetaからのガイダンスはありますか？

A: パートナーから送信されたイベントをMetaが特定できるように、パートナーが1つのアプリを使用することがベストプラクティスです。すでに複数のアプリを持っているパートナーの場合は、partner_agentが自分に割り当てられたパートナーエージェント名に設定され��いることを確認してください。不明な点がある場合は、Meta担当者にご相談ください。

メッセージスレッドの外(例えば、自分のウェブサイトやアプリ)でコンバージョンが発生した場合、イベントをMetaに渡すにはどうすればよいでしょうか？

A:メッセージングスレッド外でコンバージョンが発生した場合、関連するコンバージョンAPI製品を使用してそのイベントをMetaに送り返してください。例えば、自分のウェブサイトでコンバージョンが発生した場合、ウェブ用のコンバージョンAPIを使用します。自分のアプリでコンバージョンが発生した場合、アプリイベントのコンバージョンAPIを使用してください。イベントは引き続きウェブのコンバージョンAPIのクリックIDにアトリビューションされます。パラメーターの全リストはここにあります。

コンバージョンAPIでメッセージ誘導広告の最適化をすることはできますか？

A: コンバージョンAPIで購入最適化ができるのはMessenger誘導広告のみです。現時点ではWhatsApp広告の最適化はできません。WhatsApp誘導広告では、広告キャンペーンを最適化してコンバージョンを増やすことができます。

ビジネスメッセージ用のコンバージョンAPIの既存のデータセットを再利用できますか？

A: はい、既存のデータセットとのリンクをサポートしています。利用可能なオプションを参照して、ビジネスに適切なオプションをご決定ください。

現在ウェブサイト用のコンバージョンAPIを使用している場合、同じ統合にビジネスメッセージを追加すると、既存の統合が妨げられますか？

A: 既存のCAPI統合にビジネスメッセージを追加することにリスクはありません。アトリビューションはページ/データセットIDに基づいており、アプリIDとは関係ありません。

��ージにリンクできるデータセットの数は？

A: ページにリンクできるデータセットは1つのみです。

ビジネスメッセージ用のコンバージョンAPIでイベントを送信する前に、イベントを重複除外する必要がありますか？

A: Metaは、ビジネスメッセージ用のコンバージョンAPIのイベントの重複除外をサポートしていないため、広告主はビジネスメッセージ用のコンバージョンAPIでイベントを送信する前に重複除外を行うことを強くおすすめします。

参考情報

コンバージョンAPIの概要
コンバージョンAPIの使用
コンバージョンAPIのパラメーター
ベストプラクティス
WhatsApp Businessプラットフォーム(オンプレミスまたはクラウドAPI)ビジネスAPIバージョン2.45.1以降
InstagramメッセージAPI