轉換 API

整合品質 API

此 API 為測試版。若要取得使用權限，請連絡您的 Meta 業務代表。

使用轉換 API 分享伺服器事件的廣告商，可以在事件管理工具中查看事件配對品質。不過，這僅適用於個案，如果技術供應商合作夥伴、代理商合作夥伴或廣告商為其商家管理千百個 Meta 像素，很難擴充規模。整合品質 API 可使用程式碼大規模合併整合品質衡量指標，以協助解決此問題。

關於事件配對品質

事件配對品質

事件配對品質（EMQ）為滿分 10 分的分數，用以指示從您的伺服器所傳送的顧客資訊，在用於配對事件實例與 Facebook 帳號時的有效程度。優異的品質事件配對可改善廣告歸因和成效。請注意，此衡量指標仍在調整中。

計算方式

事件配對品質是根據轉換 API 整合工具從您的伺服器收到的顧客資料參數、收到的資料品質，以及與 Meta 帳號配對的事件實例百分比所計算而得。

使用方式

事件配對品質用於評估您是否透過轉換 API 傳送正確的顧客資訊，以配對您的事件與 Meta 帳號，以及您是否已正確設定顧客資訊參數。顧客資訊參數可協助配對您的事件與 Meta 帳號，以便您將轉換歸因於廣告，並將其投遞給最有可能轉換的用戶。

事件配對品質為即時計算。請前往此處深入瞭解 EMQ 最佳作法的相關資訊。

EMQ 目前僅適用於網站事件。若是其他事件類型，例如離線和實體店面事件、應用程式事件、轉換潛在顧客，或是處於初期或測試版階段的任何整合，請聯絡您的 Meta 代表，以取得提升配對品質的相關指導。

常見使用案例

合作夥伴和代理商可以使用整合品質 API 來提供高品質的主控板和洞察報告，同時協助廣告商強化和最佳化整合。合作夥伴也可以使用此整合來監控其轉換 API 整合工具的穩定性。廣告商可以使用此端點來彙總整合品質資料，以納入其監控中。

驗證

透過企業管理平台進行廣告商驗證

  1. 在企業管理平台中，前往用戶區塊，然後選擇系統用戶頁籤。點擊您用於轉換 API 的特定系統用戶。
  2. 前往指派資產對話方塊，並選擇像素。然後，選擇您要代表其傳送事件的像素。
  3. 針對每個像素，選擇管理像素權限，然後點擊儲存變更。
  4. 返回系統用戶的詳細資料頁面。確認所選擇的像素顯示在該頁面上。
  5. 若要產生存取權杖，請按照此處的說明進行操作。

合作夥伴平台驗證

您必須先要求授權，才能代表客戶傳送事件。您有以下幾種驗證選項：

商家專用 Facebook 登入（建議）

對需要存取商家客戶資產的技術供應商和商業應用程式開發人員而言，商家專用 Facebook 登入是其偏好的驗證和授權解決方案。Facebook 商家登入可讓您指定存取權杖類型、資產類型和應用程式需要的權限，並將之儲存為一組（配置）。接著，您可將此組配置提供給商家客戶，好讓他們完成流程，並授權您的應用程式存取其商家資產。

Meta Business 擴充功能（建議）

使用此選項時，Meta Business 擴充功能（MBE）會傳回代表客戶傳送事件所需的所有必要資訊。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 業務代表一起約定平台的識別資料。

如果您是廣告商，通常不必擔心 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. Meta 企業商家使用說明的轉換 API 設定品質指引：

  • 在 Meta 事件管理工具中查看伺服器事件詳細資料。商家設定轉換 API 之後，可透過本文瞭解如何監控事件和參數，確保其設定能有效運作並確認改善的機會。商家也可透過本文瞭解如何在事件管理工具中使用伺服器事件詳細資料（事件配對 [事件配對品質／EMQ]）、資料更新間隔、事件總覽和重複事件刪除）來改善其轉換 API 設定。