コンバージョンAPIのエンドツーエンド実装

コンバージョンAPIは、適切なデータ透明性とデータ管理機能を消費者に提供しながら、パーソナライズされたエクスペリエンスを引き続き提供しようとする広告主の取り組みをサポートします。このAPIを使えば、ブラウザーを経由せずにサーバーから直接データを共有できるようになります。

統合のメリット

• ファネルをより詳細に可視化: コンバージョンAPIを使うと、Metaピクセルと比べてより幅広いデータを共有できます。このAPIを使うことで、CRMデータ、ファネル下部のイベント(質の高いリードを含む)、ウェブサイトと実店舗にまたがるマルチサイトコンバージョンパスなど、より多くの情報を考慮した意思決定が可能になります。

• データ管理: コンバージョンAPIをサーバーのみの実装(Metaピクセルを使わないなど)で使うと、共有データをさらに細かく管理できるようになります。イベントへのインサイトの追加を選んだ場合、製品マージンや履歴情報(顧客価値スコアなど)といったデータを提供できます。

• シグナルの信頼性と回復力: コンバージョンAPIを使ってデータを共有すると、Metaピクセルなどブラウザーベースの手法のみを使う場合より信頼性が高まることがあります。このAPIは、ブラウザーのクラッシュや接続トラブルといった問題の影響を受けにくい設計になっています。また、データ転送に関する業界の新たな制限によって、Cookieやピクセルを使った追跡の効果に制約が生じる可能性があります。その場合、コンバージョンAPIを使用すれば、ピクセルでは捕捉できなくなったシグナルの共有を管理できます。

概要

コンバージョンAPIの統合は、主に次の2つの段階に分けて考えることができます。

• 準備 — 適切な統合のタイプを選択し、送信するイベントを定義し、利用可能な最適化オプションを確認します。

• 実行 — APIを実装する方法を学びます。この段階では、パートナー統合を使うこともできます。

以下は、統合プロセス全体をまとめたものです。

既存のピクセルユーザー

Metaピクセルをすでに統合している場合、コンバージョンAPIの統合は、全く異なる接続としてではなく、そのピクセル統合の拡張として設定する必要があります。

全般的な同意

ピクセルデータの共有に関して同意を管理するロジックがある場合は、コンバージョンAPI経由でのデータの共有に関しても同じロジックを使用してください。

代替手段

• アプリイベント用に広告を最適化する場合は、アプリイベントAPIをご利用ください。

準備

統合のタイプを選択する

まず、実装する統合オプションを選択します。

送信するイベントを定義する

統合アプローチを選択したら、送信するイベントを定義できます。シグナルが最も役に立つのは、MetaユーザーIDとマッチングされた場合です。そのため、イベントと一緒に送信するパラメーターとその送信頻度について検討することが重要になります。

イベントオプション

ビジネスと最も関連性の高いイベントを送信します。Metaでサポートされている標準イベントとカスタムイベントの一覧をご覧ください。

イベントパラメーター

各イベント内で複数のパラメーターを送信できます。これらのフィールドについて、詳しくはコンバージョンAPIで使用されるパラメーターをご覧ください。

イベントには、event_id、external_id、order_idなど複数のタイプのIDを追加できます。これらのパラメーターの違いを把握することが重要です。

データの鮮度

イベントの送信は、コンバージョンAPI経由で特定のタイムラインに基づいてリアルタイムまたはバッチ処理で行うことおすすめします。イベントをリアルタイムもしくは1時間以内に送信すると、イベントをアトリビューションに使って、広告配信に最適化できるようになります。

イベントを発生後2時間以上経ってから送信すると、それらのイベント用に最適化された広告のパフォーマンスが大幅に低下する可能性があります。24時間以上経ってから送信したイベントでは、アトリビューションや最適化された広告の配信で重大な問題が発生することがあります。

コンバージョン期間が長いイベントを送信する場合は、コンバージョンがすべて完了した時点からできるだけリアルタイムに近いタイミングでイベントを送信してください。

以下の手順を完了したら、次のステップに進みます。

• 送信するイベントのリストの作成。
• 各イベントで送信するフィールドの指定。
• イベントを送信する頻度の設定。

利用可能な最適化タイプ

コンバージョンAPIでは、次の最適化タイプが提供されます。

実行

次の2とおりの方法で統合を実装できます。

• 直接統合 — 広告主がコンバージョンAPIを直接実装します。
• プラットフォームとしての統合 — マーケティングパートナーがコンバージョンAPIをサービスとしてクライアントに提供します。

直接統合

ステップ1: 要件を設定する

コンバージョンAPIを使用する前に、次のアセットを設定します。

アセットの準備ができたら、APIの実装に進みます。API呼び出しで使用するので、必ずアセットのIDを保存しておいてください。

ステップ2: APIを実装する

要件の設定が完了したら、実装プロセスを開始します。コンバージョンAPI上で実装する際は、必ず開発者向けドキュメントを確認してください。

テスト呼び出し(任意)

APIを初めて使用する場合は、テスト呼び出しから始めてください。そのためには、ペイロードとAPI呼び出しメソッドが必要になります。テスト呼び出しが完了したら、呼び出しが予期したとおりに実行されたことをイベントマネージャで確認します。

{
  "data": [
   {
    "event_name": "Purchase",
    "event_time": 1601673450,
    "user_data": {
      "em": "7b17fb0bd173f625b58636fb796407c22b3d16fc78302d79f0fd30c2fc2fc068",
      "ph": null
     },
    "custom_data": {
      "currency": "USD",
      "value": "142.52"
    }
   }
  ]
}

{
  "events_received": 1,
  "messages": [],
  "fbtrace_id": <FB-TRACE-ID>
}

最初の呼び出しが完了したら、イベントマネージャで[自分のピクセル] > [概要]に移動してイベントを確認します。

イベントマネージャでテストイベントを確認したら、イベントの送信と確認に進みます。

イベントの送信と確認

イベントの送信を開始するには、APIの/eventsエッジにPOSTリクエストを送信します。ペイロードを呼び出しに添付します。ペイロードの生成にあたってサポートが必要な場合は、ペイロードヘルパーにアクセスしてください。詳細とコードサンプルについては、以下のリソースをご覧ください。

• [APIの使用] > [リクエストの送信]
• ドロップされたイベント
• アップロード時間とイベントトランザクション時間
• バッチリクエスト
• ハッシュ化

イベントの送信を開始したら、イベントマネージャに移動し、送信したイベントが受信されていることを確認します。イベントを確認する方法については、こちらをご覧ください。

実装がブラウザーピクセルを補完するものである場合は、重複排除設定に進みます。それ以外の場合は、これですべての設定が完了です。まだご不明な点がある場合は、サポートをご覧ください。

ステップ3: 重複排除用パラメーターを追加する

ピクセルとコンバージョンAPIから同じイベントを送信している場合は、両方のチャネルから送信されるイベントの重複排除を設定する必要があります。まず、開発者向けドキュメントを読み、重複排除ロジックを理解してください。

イベントベースの重複排除

同じサーバーキーの組み合わせ(event_id、event_name)とブラウザーキーの組み合わせ(eventID、event)が48時間以内に同じピクセルIDに送信された場合に、後で送信された重複イベントを破棄します。

以下の方法で、イベントが重複排除されていることを確認できます。

• 該当するイベントについて、次のパラメーターが同じ値に設定されていることを確認します。

  • サーバーイベントのevent_idとブラウザーイベントのeventID
  • サーバーイベントとブラウザーイベントのevent_name
• 重複するイベントを送信した後、イベントマネージャで、正しいイベントがドロップされているか確認します。
• ピクセルとコンバージョンAPIの両方を経由して送信されたそれぞれのユニークなイベントに独自のevent_idが含まれていることを確認します。このIDは、他のイベントと共有できません。

イベントベースの重複排除に代わる方法

イベントの重複を排除する最適な方法はイベントIDを使うことですが、実装はかなり複雑になります。代わりにexternal_idやfbpパラメーターを使う方法もあります。external_idまたはfbpパラメーターがブラウザーとサーバーの両方を経由して渡されるように設定している場合、48時間以内に同じexternal_idまたはfbpパラメーターで同じイベントが発生すると、イベントが自動的に重複排除されます。

ステップ4 (任意): Business SDKの機能を調べる

Meta Business SDKは、コンバージョンAPIのユーザー向けに特別に設計された高度な機能を備えています。

• 非同期リクエスト — リクエストが完了するまでプログラムの実行をブロックしたくない場合は、この機能を使います。このアプローチでは、リクエストが完了するとサーバーからシグナルが返されます。応答を待っている間、プログラムを続行できます。
• 同時バッチ処理 — 非同期リクエストを活用し、リソースをより効率的に利用することでスループットを向上させます。バッチリクエストを作成して、イベントリクエストワーカーやcronジョブなどのユースケースをサポートします。
• HTTPサービスインターフェイス — Business SDKのデフォルトのHTTPサービスを無効にし、好みのメソッドまたはライブラリを使用して独自のカスタムサービスを実装します。

プラットフォームとしての統合

以下の手順は、広告主にサービスとしてコンバージョンAPIを提供しているパートナー向けです。

ステップ1: 要件を設定する

アプリは次の機能と権限を獲得する必要があります。

• アクセスレベル: アドバンスアクセス
• 機能: 広告管理への標準アクセス
• 権限: ads_management、pages_read_engagement、ads_read。

ステップ2: クライアントの代わりにイベントを送信する

まず、直接統合の手順に従って統合をテストします。そうすると、クライアントの代わりにイベントを送信するための承認をリクエストできるようになります。次のような認証オプションがあります。

Meta Business拡張機能を使ったアプローチ(推奨)

Meta Business拡張機能は、以降のプロセスでクライアントの代わりにイベントを送信するために必要なすべての情報を返します。また、クライアントのビジネスマネージャで作成されたシステムユーザーアクセストークンを取得するためのエンドポイントを提供します。このプロセスには、サーバーイベントを送信するための権限が含まれており、安全な方法で自動的に実行されます。

このエンドポイントでは、入力パラメーターとしてユーザーアクセストークンが必須です。Meta Business拡張機能の新しいユーザーは、Meta Business拡張機能の設定が完了したら、このエンドポイントを呼び出してシステムユーザーアクセストークンを取得します。既存のユーザーは、新しいAPIエンドポイントを呼び出す前に再認証を要求する必要があります。

クライアントシステムのユーザーアクセストークン

クライアントにコンバージョンAPI経由で手動でシステムのユーザーアクセストークンをピクセル設定内に作成してもらいます。次に、そのトークンを使用してイベントを広告主のピクセルに送信します。

システムユーザーまたは管理者システムユーザーは、アクセストークンの生成に使用されるアプリをインストールする必要があります。この設定により、アプリがこのシステムユーザーまたは管理者システムユーザーに代わってAPIを呼び出せるようになります。

クライアントがパートナーのビジネスマネージャとピクセルを共有する

このオプションを使用すると、クライアントはビジネスマネージャ設定またはAPIを利用してピクセルをパートナーと共有し、パートナーのシステムユーザーをクライアントのピクセルに割り当てて、サーバーイベントを送信するためのアクセストークンを生成できます。

ステップ3: イベントを自社のプラットフォームにアトリビューションさせる

コンバージョンAPIイベントを自社のプラットフォームにアトリビューションさせるには、partner_agentフィールドを使用します。これにより、クライアントの代わりにイベントを送信する際に、独自のプラットフォームIDを設定できるようになります。マネージドパートナーの場合は、Metaの担当者と相談し、プラットフォームのIDについて合意しておく必要があります。この値は、23文字未満で、アルファベットを少なくとも2文字含むフォーマットにしてください。その後、この識別情報をサーバーイベントごとに送信します。

サポート

すべてのパートナー向け

デバッグおよびビジネスヘルプセンターの記事に関する情報をご覧ください。

マネージドパートナー向け

ビジネスマネージャID、アプリID、ピクセルIDの情報を提供して、Metaの担当者が統合のテストやトラブルシューティングの際に利用できるようにしてください。

APIに関するドキュメント

• スタートガイド - 自社のビジネスマネージャでAPIをテストします
• APIの使用
• ベストプラクティス - コンバージョンAPI
• プラットフォームとしてのコンバージョンAPIの設定
• Metaの標準イベント
• Metaのカスタムイベント
• パラメーター
• ペイロードヘルパー
• コンバージョンAPIおよびオフラインコンバージョンAPIのデータ処理オプション
• アプリイベントに最適化したい場合は、アプリイベントAPIを使用する
• イベントが店舗での売上の場合は、オフラインコンバージョンAPIを使用する - 店舗での売上以外のオフラインイベントは、コンバージョンAPIの対象となります