Integration Quality API

現在、このAPIはベータ版です。使用するには、Meta担当者にご連絡ください。

コンバージョンAPIを利用してサーバーイベントを共有している広告主は、イベントマネージャでイベントマッチングクオリティを確認できます。ただしこれは個人使用がベースであり、技術プロバイダーパートナー、代理店パートナー、広告主などが自社のビジネスのために莫大な数のMetaピクセルを管理している場合、拡張は困難です。Integration Quality APIを使用すれば、プログラムを使って統合クオリティ指標を大規模に統合することでこの問題を解決できます。

イベントマッチングクオリティについて

イベントマッチングクオリティ

イベントマッチングクオリティ(EMQ)は、あなたのサーバーから送信された顧客情報が、イベントインスタンスとFacebookアカウントのマッチングにおいて、どれほど有効であるかを示すスコアです(10点満点)。クオリティの高いイベントマッチングにより、広告のアトリビューション分析とパフォーマンスが向上する場合があります。この指標は開発中であることに注意してください。

計算方法

イベントマッチングクオリティは、コンバージョンAPI統合を通してあなたのサーバーから受け取った顧客情報パラメーター、受け取った情報のクオリティ、およびMetaアカウントとマッチしたイベントインスタンスの割合を考慮して計算されます。

活用方法

イベントマッチングクオリティは、コンバージョンAPIを通してあなたが適切な顧客情報を送信しイベントをMetaアカウントとマッチングさせているかどうか、およびあなたが顧客情報パラメーターを正しく設定しているかどうかを評価するために使用されます。顧客情報パラメーターは、イベントとMetaアカウントのマッチングに役立ち、広告のコンバージョンをアトリビューション分析し、コンバージョンにつながる可能性が最も高い人に広告を配信できます。

イベントマッチングクオリティはリアルタイムで計算されます。EMQに関するベストプラクティスについては、こちらをご覧ください。

現在、EMQはウェブイベントのみを対象としています。オフラインや実店舗のイベント、アプリイベント、コンバージョンリード、アルファ/ベータ段階の統合など、その他のイベントタイプでマッチングクオリティを向上する方法については、Meta担当者にお問い合わせください。

一般的な使用事例

パートナーとエージェンシーがIntegration Quality APIを使うことで、クオリティダッシュボードとインサイトを提供するとともに、広告主による統合の強化および最適化を支援することができます。パートナーは、この統合を使用して、コンバージョンAPI統合の安定性をモニタリングすることもできます。広告主はこのエンドポイントを使用して統合品質データを集約し、モニタリングに組み入れることができます。

認証

ビジネスマネージャによる広告主認証

  1. ビジネスマネージャで、[ユーザー]セクションに移動し、[システムユーザー]タブを選択します。コンバージョンAPIに使用している特定のシステムユーザーをクリックします。
  2. [アセットの割り当て]ダイアログに移動し、[ピクセル]を選択します。その後、イベントを代理送信するピクセルを選択します。
  3. ピクセルごとに、[ピクセルの管理]アクセス許可を選択し、[変更を保存]をクリックします。
  4. システムユーザーの詳細ページに戻ります。選択したピクセルがそこに表示されていることを確認してください。
  5. アクセストークンを生成するには、こちらの手順に従ってください。

パートナープラットフォーム認証

まず、クライアントの代理でイベントを送信するための認証をリクエストする必要があります。次のような認証オプションがあります。

ビジネス向けFacebookログイン(推奨)

ビジネス向けFacebookログインは、ビジネスクライアントのアセットにアクセスする必要がある技術プロバイダーやビジネスアプリ開発者に推奨されている認証ソリューションです。アプリが必要とするアクセストークンの種類、アセットの種類、アクセス許可を指定し、セット(設定)として保存できます。その後、そのセットをビジネスクライアントに提示して、ログインフローを完了し、アプリにビジネスアセットへのアクセスを付与することができます。

Metaビジネス拡張機能(推奨)

このオプションを使用すると、Metaビジネス拡張機能(MBE)は、クライアントの代理でイベントを送信するために必要なすべての情報を返します。また、クライアントのビジネスマネージャで作成されたシステムユーザーアクセストークンを取得するためのエンドポイントが提供されます。このプロセスには、サーバーイベントを送信するためのアクセス許可が含まれており、安全な方法で自動的に実行されます。現在MBEはベータ版です。使用するにはMeta担当者にお問い合わせください。

このエンドポイントは、入力パラメーターとしてユーザーアクセストークンを必要とします。新しいMBEユーザーは、MBEの設定が完了したら、このエンドポイントを呼び出してシステムユーザーアクセストークンをフェッチします。既存のユーザーは、新しいAPIエンドポイントを呼び出す前に再認証を依頼する必要があります。

パートナーのビジネスマネージャにクライアントがMetaピクセルをシェアする

このオプションでは、クライアントが、ビジネスマネージャの設定を通して、またはAPI経由で、それぞれのMetaピクセルをパートナーにシェアします。そうすると、パートナーがパートナーシステムユーザーをクライアントピクセルに割り当てて、サーバーイベントを送信するためのアクセストークンを生成することができます。

ピクセル統合の品質の情報を取得する

次のAPIエンドポイント、パラメーター、フィールドを使って、イベントごとのマッチングクオリティのスコアと、送信されるマッチングキーをモニタリングすることができます。

エンドポイント

https://graph.facebook.com/v21.0/<pixel_id>/integration_quality

パラメーター

パラメーター説明
agent_name
文字列

任意。
正規化されたpartner_agentフィールドの値を使って、/{pixel_id}/events POSTリクエストのpartner_agentパラメーターを使って送信されたイベントのみを絞り込むことができます(イベントのアトリビューション分析のベストプラクティスについては、こちらこちらをご覧ください)。

例えば、partner_agentの値が[partner_name]_[majorversion]_[minorVersion]の場合、正規化されたエージェント文字列の値は小文字のpartner_nameになります。

agent_nameを使用すると、クライアントに代わってイベントを送信するときに独自のプラットフォーム識別情報を設定できます。マネージドパートナー/エージェンシーの場合は、Meta担当者と相談してプラットフォームのIDについて合意しておいてください。

広告主がagent_name属性について心配する必要はほとんどありません。

agent_nameを指定しない場合は、エージェントによって送信されたかどうかに関係なく、すべてのイベントがEMQ計算に含められます。

フィールド

フィールド説明
event_name
文字列

標準イベントまたはカスタムイベントの名前。

event_match_quality
AdsPixelCAPIEMQ

イベントマッチングクオリティは、あなたのサーバーから送信された顧客情報が、イベントインスタンスとFacebookアカウントのマッチングにおいて、どれほど有効かを示します。

グラフAPIエクスプローラ

GET/v21.0/<PIXEL_ID>/integration_quality?fields=event_match_quality,event_name&agent_name=<AGENT_NAME>&access_token=<ACCESS_TOKEN>

cURL

curl -X GET -G \
  -d 'fields="event_match_quality,event_name"' \
  -d 'agent_name="&lt;AGENT_NAME&gt;"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<LATEST_VERSION>/<PIXEL_ID>/integration_quality

API応答

{
  "data": [
    {
      "event_match_quality": {
        "composite_score": 5.1,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          }
        ]      
      },
      "event_name": "pLTVPurchase"
    },
    {
      "event_match_quality": {
        "composite_score": 7.2,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "phone",
            "coverage": {
              "percentage": 69.1
            }
          },
          {
            "identifier": "fbp",
            "coverage": {
              "percentage": 96.7
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "fbc",
            "coverage": {
              "percentage": 3.2
            }
          }
        ]
      },
      "event_name": "CompleteRegistration"
    }
  ]
}

よくある質問

The access token is used when partners send signal events or access the Setup Quality API on behalf of advertisers. The client system user access token onboarding method is not compatible with the EMQ API at the moment.

The partner_agent value in your API GET request should be a normalized lowercase format. This field is now optional.

詳しくはこちら

  1. コンバージョンAPIのベストプラクティス

  2. 最適化されたコンバージョンAPI設定でパフォーマンスを向上させる

  3. コンバージョンAPIにオンボーディングするパートナーのためのベストプラクティス

  4. コンバージョンAPIの設定クオリティに関するMetaビジネスヘルプセンターのガイダンス:

  • Metaイベントマネージャでサーバーイベントの詳細を表示するビジネスは、コンバージョンAPIを設定した後、この記事を参照してイベントとパラメーターのモニタリング方法を学習し、設定が効果的に機能していることを確認し、改善の機会を特定することができます。この記事からは、イベントマネージャにあるサーバーイベントの詳細情報(イベントマッチング[イベントマッチングクオリティ/EMQ])、データの鮮度、イベントの概要、イベントの重複排除)を使用して、コンバージョンAPIの設定を改善する方法を知ることもできます。