轉換 API 可讓廣告主透過單一端點(而不需要透過多個來源),將網路、應用程式、實體商店和商家訊息事件傳送到 Meta。這種整合可以簡化廣告主的技術堆疊,並使用資料集在 Meta 事件管理工具中建立更全面的視圖。
本文件提供將應用程式事件整合至轉換 API 的指南。
透過轉換 API 傳送的應用程式事件必須與資料集相關聯。
Datasets allow advertisers to connect and manage event data from web, app, store and business messaging event sources to the Conversions API. Datasets may show event data from any of these integrations that you choose to set up:
Datasets enable you to view all customer activities from a single interface. They also allow you to reduce the effort to build and maintain multiple API integrations.
In Events Manager, advertisers have different options to create a dataset depending on their starting point. Or you can create a brand new dataset in Events Manager by linking during offline event set creation or through an existing mobile app or during messaging event set creation information. Note that linking a dataset to an application is required before sending mobile app events to the Conversions API and only one application can be linked to a dataset. See more details and instructions here.
您可以發出 GET
呼叫至 https://graph.facebook.com/v16.0/{ads-pixel-id}/is_consolidated_container,偵測廣告主的資料集是否已整合,因而有資格透過轉換 API 來傳遞應用程式事件。
a.連結資料集編號和應用程式編號
在事件管理工具中,有兩種方法可以將您的應用程式與資料集連結:
完成連結後,資料集就會包含所連接的應用程式。
b.必要欄位
您可以參閱此文件,瞭解可透過轉換 API 傳送的最新參數組合。若要傳送應用程式事件,可以在裝載中分享下列 server_event 欄位:
action_source
必須包含代表應用程式事件的值 app
。event_id
是進行刪除重複項目設定時的必要項目。Parameter | Description |
---|---|
advertiser_tracking_enabled boolean | Required for app events Use this field to specify ATT permission on an iOS 14.5+ device. Set to |
application_tracking_enabled boolean | Required for app events A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use |
extinfo object Please use the down arrow to the right to see the list of | Required for app events Extended device information, such as screen width and height. This parameter is an array and values are separated by commas. When using Note:
|
campaign_ids string | Optional An encrypted string and non-user metadata appended to the outbound URL (for example, ad_destination_url) or deep link (for App Aggregated Event Manager) when a user clicked on a link from Facebook. Graph API definition: Parameter passed via the deep link for Mobile App Engagement campaigns. |
install_referrer string | Optional |
installer_package string | Optional Used internally by the Android SDKs |
url_schemes array | Optional Used internally by the iOS and Android SDKs. |
vendor_id string | Optional Vendor ID. |
windows_attribution_id string | Optional Attribution token used for Windows 10. |
參數 | 說明 |
---|---|
anon_id 字串 | 不進行雜湊處理。 |
madid 字串 | 不進行雜湊處理。 |
參數 | 說明 |
---|---|
description 字串 | 選用項目。 |
level 字串 | 選用項目。 |
max_rating_value | 選用項目。 |
success 布林值 | 選用項目。 |
總體而言,使用轉換 API 來分享的應用程式事件會需要下列資料參數:
action_source
:必須設定為「app」。(使用轉換 API 即表示您同意 action_source
參數就您所知是正確的)event_id
:進行刪除重複項目設定時的必要項目,如需詳細資訊,請參閱「針對多管道進行刪除重複項目設定」一節。以下是 extinfo
的範例。請確認以下所有子參數均已依序填寫。如果缺少任何項目,請使用空白字串做為預留位置。
子參數名稱 | 必要項目 | 資料類型 | 範例 |
---|---|---|---|
extinfo 版本 | 是 | 字串 |
|
應用程式套件名稱 | 否 | 字串 |
|
短版 | 否 | 字串 |
|
長版 | 否 | 字串 |
|
作業系統版本 | 是 | 字串 |
|
裝置機型名稱 | 否 | 字串 |
|
地區設定 | 否 | 字串 |
|
時區縮寫 | 否 | 字串 |
|
電信業者 | 否 | 字串 |
|
螢幕寬度 | 否 | 字串 |
|
螢幕高度 | 否 | 字串 |
|
畫面密度 | 否 | 字串 |
|
CPU 核心 | 否 | 字串 |
|
外接儲存裝置大小 | 否 | 字串 |
|
外接儲存裝置的可用空間大小 | 否 | 字串 |
|
裝置時區 | 否 | 字串 |
|
c.針對多管道進行刪除重複項目設定
若要將轉換 API 整合與包含應用程式事件(包括 SDK、MMP 和應用程式事件 API)的所有其他現有整合之間的重複事件流量移除,就會需要刪除重複項目機制。
針對應用程式事件,我們會套用本來就已用於網路事件的相同刪除重複項目功能。此邏輯利用以欄位 event_id
和 event_name
為基礎的刪除重複項目功能(承載相同 event_id
的轉換 API 和 SDK/應用程式事件 API 等事件)。event_id 參數是可以區別類似事件獨一性的識別碼。不正確的事件編號可能導致轉換遭到錯誤的重複項目刪除,進而影響轉換分析報告和行銷活動成效。
您可以參考下列開發人員說明文件來實作刪除重複項目設定:
以下是記錄自訂事件的作法範例。若要行此作業,請在 iOS SDK 中以 AppEvents.Name 的形式來傳遞事件名稱:
AppEvents.shared.logEvent(.achievedLevel, parameters: [AppEvents.ParameterName(rawValue: "event_id"): "123"])
針對應用程式安裝事件,已經有一種刪除重複項目機制,可確保在過去 90 天期間,僅歸因一次安裝。我們保留第一個事件,並刪除後續的事件,無論其集客力動作來源為何。不需要為與安裝事件相關的應用程式事件實作刪除重複項目。
d.傳送事件
若要傳送新的事件,請從下列路徑發出 POST
要求至轉換 API:https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}
。當您發佈到此關係連線時,Meta 會建立新的應用程式伺服器事件。如需詳細資訊,請參閱此開發人員文件。
以下概述這些參數在裝載整體架構中的適當位置:
{ "data": [ { "event_name": "Purchase", "event_time": 1684389752, "action_source": "app", "user_data": { "em": [ "30a79640dfd8293d4f4965ec11821f640ca77979ca0a6b365f06372f81a3f602" ], "ph": [ "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b", "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b" ], "madid": "bbbbbbbbbbbb", "anon_id": "cccccccc" }, "custom_data": { "currency": "USD", "value": "142.52" }, "app_data": { "advertiser_tracking_enabled": "True", "application_tracking_enabled": "True", "campaign_ids": "aaaaaaaaa", "extinfo": [ "a2", "com.some.app", "771", "Version 7.7.1", "10.1.1", "OnePlus6", "en_US", "GMT-1", "TMobile", "1920", "1080", "2.00", "2", "128", "8", "USA/New York" ] } } ] }