集成质量 API

此 API 目前处于 Beta 测试阶段，请联系您的 Meta 代表获取访问权限。

使用转化 API 分享服务器事件的广告主可以在事件管理工具中看到事件匹配质量。但是，这只适用于个人，当技术代理合作伙伴、代理商合作伙伴或广告主为企业管理成百上千个 Meta 像素代码时，很难大规模应用。集成质量 API 能以编程方式大规模整合集成质量指标，帮助解决这个问题。

事件匹配质量简介

事件匹配质量

事件匹配质量 (EMQ) 以分数表示，满分为 10 分，用于表明通过您的服务器发送的客户信息在将事件实例与 Facebook 账户匹配方面可能具有的效力。较高的事件匹配质量可能改善广告归因和表现。请注意，这项指标还在不断完善中。

计算方法

了解通过转化 API 集成从您的服务器收到的客户信息参数、这些信息的质量以及与 Meta 账户匹配的事件实例百分比，就能计算事件匹配质量。

使用方法

事件匹配质量用于评估您是否通过转化 API 发送了正确的客户信息，以用于将您的事件与 Meta 账户匹配，以及是否正确设置了客户信息参数。客户信息参数有助于将事件与 Meta 账户匹配，以便将转化归因于您的广告，并投放给最有可能转化的用户。

事件匹配质量可实时计算得出。如需进一步了解有关 EMQ 最佳实践的详情，请点击此处。

EMQ 目前仅适用于网站事件。对于其他事件类型（例如线下事件和实体店事件、应用事件、高潜客户、内测或 Beta 测试阶段的任何集成），请联系您的 Meta 代表，获取有关提高匹配质量的指导。

常见用例

合作伙伴和代理商可以使用集成质量 API 提供质量面板和成效分析，同时帮助广告主加强和优化集成。合作伙伴也可以利用此集成来监控转化 API 集成的稳定性。广告主可以使用此端点来汇总要纳入监控范围的集成质量数据。

身份验证

广告主通过商务管理平台验证身份

在商务管理平台中，前往“用户”部分，选择系统用户选项卡。点击要用于转化 API 的特定系统用户。
前往“分配资产”对话框，并选择 Pixel 像素代码。然后，选择您要代表其发送事件的 Pixel 像素代码。
对于每个 Pixel 像素代码，选择“管理 Pixel 像素代码”权限，然后点击保存更改。
返回您的系统用户详情页面。确认所选择的 Pixel 像素代码显示在相应位置上。
要生成访问口令，请按照此处说明操作。

合作伙伴平台身份验证

您首先必须请求获得代表客户发送事件的授权。您可选用以下身份验证方法：

企业版 Facebook 登录（推荐）

对于需要访问业务客户资产的技术代理和业务应用开发者而言，企业版 Facebook 登录是其首选的身份验证和授权解决方案。该方案支持指定应用所需的访问口令类型、资产类型和权限，并将方案自身作为一种设置（配置）予以保存。然后，您可以将该设置向您的业务客户展示，以便客户完成流程并向您的应用授予访问其业务资产的权限。

Meta 业务插件（推荐）

拥有 Meta 业务插件 (MBE) 之后，该插件便可返回代表客户发送事件所需的所有必要信息。MBE 会提供一个端点，用于检索在客户的商务管理平台中创建的系统用户访问口令。此流程会用到发送服务器事件的权限，并且会以安全可靠的方式自动完成。MBE 目前处于 Beta 测试阶段，请联系您的 Meta 代表获取访问权限。

此端点需要用户访问口令作为输入参数。如果您是 MBE 新用户，在完成 BE 设置后，请调用此端点，以便获取系统用户访问口令。现有用户需要请求重新验证身份，然后才能调用新的 API 端点。

客户将 Meta Pixel 像素代码分享到合作伙伴的商务管理平台

借助此方案，客户可以通过商务管理平台设置或通过 API 向合作伙伴分享他们的 Meta Pixel 像素代码。然后，合作伙伴可以将合作伙伴系统用户分配给客户的 Pixel 像素代码，并生成一个访问口令，用于发送服务器事件。

检索 Pixel 像素代码集成质量信息

您可以使用以下 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 代表合作协定平台标识符。如果您是广告主，大多数情况下您不必担心 `agent_name` 归因问题。如果您不提供 `agent_name`，计算 EMQ 时，系统会将所有事件纳入其中，无论事件是否由代理商发送。

agent_name

字符串

非必要。
partner_agent 字段的标准化值用于仅筛选 /{pixel_id}/events POST 请求中包含 partner_agent 参数的事件（请参见此处和此处的归因事件最佳实践）。

例如，如果 partner_agent 的值为 [partner_name]_[majorversion]_[minorVersion]，则标准化代理商字符串的值为小写字母的 partner_name。

有了 agent_name，在代表客户发送事件时，您便可以设置自己的平台标识符。如果您是有专人服务的合作伙伴/代理商，请与您的 Meta 代表合作协定平台标识符。

如果您是广告主，大多数情况下您不必担心 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"
    }
  ]
}

常见问题

What is the access token used for?

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.

固定链接

How should the partner_agent field be formatted?

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

固定链接

详细了解

转化 API 最佳实践。
利用优化的转化 API 设置提升表现。
转化 API 合作伙伴入门最佳实践
Meta Business 帮助中心中提供的转化 API 设置质量指导：

使用转化 API 助力提升广告表现的最佳实践。使用这些转化 API 最佳实践可帮助企业降低单次操作费用，从而提升广告表现。我们建议您在初始设置时遵循这些最佳实践，不过您也可以在更新现有设置时采取这些做法。

在 Meta 事件管理工具中查看服务器事件详细信息。企业设置转化 API 后，可以阅读这篇文章了解如何监控事件和参数，确保其设置有效运行，并确定可以改进的方面。还可以通过这篇文章了解如何在事件管理工具中使用服务器事件详细信息（事件匹配 [事件匹配质量/EMQ]、数据新鲜度、事件概览和事件去重），以改善转化 API 设置。