event_name字串 | 必填。 標準事件或自訂事件名稱。此欄位可用來刪除網頁(透過 Meta 像素)或應用程式(透過 SDK 或應用程式事件 API)和轉換 API 同時傳送的重複事件。event_id 參數也可用來刪除重複事件。 若為相同的顧客動作,來自瀏覽器或應用程式事件的 event 必須與來自伺服器事件的 event_name 相符。如果我們在 48 小時內傳送的事件間找到相符項目,就只會考慮第一個事件。如果在大約同一時間收到伺服器和瀏覽器/應用程式事件(即彼此相距 5 分鐘內)我們會以瀏覽器/應用程式事件為優先。深入瞭解刪除重複像素和伺服器事件。 |
event_time整數 | 必填。 Unix 時間戳記(以秒為單位),指示實際事件發生的時間。指定的時間可能會早於您向 Facebook 傳送事件的時間,這樣系統才能進行批次處理和伺服器效能最佳化。您必須以 GMT 時區格式傳送此日期。 event_time 最早可以是您向 Facebook 傳送事件的 7 天前。如果 data 中的任何 event_time 大於過去 7 天,我們會針對整個要求傳回錯誤,且不會處理任何事件。
|
user_data物件 | 必填。 包含顧客資訊資料的比對內容。如需瞭解相關選項,請參閱顧客資訊參數。另請參閱進階配對,瞭解透過 Meta 像素傳送之資料適用的可比較選項。 |
custom_data物件 | 選填。 包含與事件相關的其他企業資料比對內容。如需更多資訊,請參閱自訂資料參數。 |
event_source_url字串 | 選填。 事件發生處的瀏覽器網址。網址應與已驗證的網域相符。
備註:使用轉換 API 分享網站事件時,event_source_url 為必填欄位。 |
opt_out布林值 | 選填。 此標示指示 Meta 不應使用此事件進行廣告投遞最佳化。如果設為 true,我們只會使用事件做為歸因條件。 |
event_id字串 | 選填。 此編號可以是廣告主選擇的任何專屬字串。event_id 和 event_name 參數可用來刪除網頁(透過 Meta 像素)或應用程式(透過 SDK 或應用程式事件 API)和轉換 API 同時傳送的重複事件。請注意,雖然 event_id 標示為選填,但仍建議您在刪除重複事件時使用。 刪除重複事件時,瀏覽器或應用程式事件的 eventID 必須與對應伺服器事件的 event_id 相符。深入瞭解如何處理重複的像素和轉換 API 事件。 訂單號碼或交易編號皆是可用於 event_id 的潛在識別資料。舉例來說,如果顧客在您的網站進行兩次購買交易,訂單號碼分別為 123 和 456,則每個轉換 API 呼叫中的 event_id 均需包含相應的訂單號碼。這樣有助我們正確地將這兩次購買事件區分為不同的訂單。兩個對應的瀏覽器像素購買事件也必須在 eventID 參數中傳送相同的訂單號碼,讓我們知道只發生了兩個事件,而不是四個不重複的購買事件。 其他沒有固有編號的事件可使用隨機號碼,但瀏覽器和伺服器事件間亦需傳送相同的隨機號碼。 |
action_source字串 | 必填。 此欄位可讓您指定轉換發生的位置。瞭解事件發生的位置有助於確保向合適的用戶展示廣告。使用轉換 API,即表示您同意 action_source 參數就您所知是正確的。 您在 action_source 欄位中可傳送的值如下所示: email — 透過電子郵件完成的轉換。
website — 在您的網站上完成轉換。
app — 在您的行動應用程式上完成轉換。
phone_call — 透過電話完成轉換。
chat — 透過訊息應用程式、簡訊或網路訊息功能完成的轉換。
physical_store — 用戶親自在實體店面完成的轉換。
system_generated — 自動轉換,例如用戶設定每月自動付款來進行續訂。
business_messaging — 透過 Messenger 發訊廣告、Instagram 發訊廣告或 WhatsApp 發訊廣告完成的轉換。
other — 上述未提及的轉換方式。
備註:所有集客力動作來源值都會啟用廣告成效衡量和自訂廣告受眾建立功能。所有動作來源都會啟用廣告最佳化功能。 |
data_processing_options陣列 | 選填。 您想為特定事件啟用的處理選項。目前可接受的值為「限制資料使用」的 LDU。您可以傳送空白陣列,以明確指示不應使用「限制資料使用」模式來處理此事件。深入瞭解資料處理選項。另請參閱轉換 API 實作範例。 |
data_processing_options_country整數 | 如果您在 data_processing_options 下傳送 LDU,則為必填。 您要在哪個國家/地區使用此資料處理選項。目前可接受的值為 1,代表美國;或使用 0 要求我們為該事件指定地理位置。深入瞭解資料處理選項。另請參閱轉換 API 實作範例。 |
data_processing_options_state整數 | 在某些情況下為必填(詳情請參閱下方附註)。 您要在哪個州/省使用此資料處理選項。目前可接受的值為 1000,代表加州;或使用 0 要求我們為該事件指定地理位置。 注意: 深入瞭解資料處理選項。另請參閱轉換 API 實作範例。 |
app_data
物件 | 應用程式事件的必填欄位 此參數可用來與轉換 API 分享應用程式資料和裝置資訊。 |
extinfo
物件 | 應用程式事件的必填欄位 延伸裝置資訊,例如螢幕寬度和高度。此參數是一個陣列,以逗號分隔值。使用 extinfo 時,所有值皆為必填,且必須按照下面的索引順序排列。如果缺少值,請以空白字串做為預留位置。 注意: |
0
字串 | 必要項目 延伸資訊版本
範例:i2 |
1
字串 | 應用程式套件名稱
範例:com.facebook.sdk.samples.hellofacebook |
2
字串 | 短版(整數或字串)
範例:1.0 |
3
字串 | 長版
範例:1.0 long |
4
字串 | 必要項目 作業系統版本
範例:13.4.1 |
5
字串 | 裝置機型名稱
範例:iPhone5,1 |
6
字串 | 地區設定
範例:En_US |
7
字串 | 時區縮寫
範例:PDT |
8
字串 | 電信業者
範例:AT&T |
9
int64 | 螢幕寬度
範例:320 |
10
int64 | 螢幕高度
範例:568 |
11
字串 | 畫面密度
範例:2 |
12
int64 | CPU 核心
範例:2 |
13
int64 | 外接儲存裝置大小(GB)
範例:13 |
14
int64 | 外接儲存裝置上的可用空間(GB)
範例:8 |
15
字串 | 裝置時區
範例:USA/New York |
referrer_url字串 | 選填。 觸發轉換 API 或 Meta 像素事件的頁面所觀察到的 HTTP 轉介網址標頭,通常是瀏覽器中的上一頁。 |
original_event_data物件 | 選填。 廣告主可用於指定「延遲」事件應如何與先前的取得事件相關聯的所有中繼資料欄位。 我們強烈建議,當傳送事件和應與之相關聯的先前取得事件兩者間發生延遲時,請使用 original_event_data。如需更多資訊,請參閱原始事件資料參數。 |
customer_segmentation列舉 | 選填。 允許廣告主指定執行事件的用戶所屬的用戶族群,可用於提供更多關於用戶與商家關係的內容。 此欄位接受下列任一預先定義的列舉值: new_customer_to_business:用戶是商家的新顧客。
new_customer_to_business_line:用戶是特定行業(例如產品或服務)的新顧客。
new_customer_to_product_area:用戶是特定產品領域(例如電子商務、金融)的新顧客。
new_customer_to_medium:用戶是特定行銷媒介(例如社群媒體、電子郵件)的新顧客。
existing_customer_to_business:用戶是商家的現有顧客。
existing_customer_to_business_line:用戶是特定行業(例如產品或服務)的現有顧客。
existing_customer_to_product_area:用戶是特定產品領域(例如電子商務、金融)的現有顧客。
existing_customer_to_medium:用戶是特定行銷媒介(例如社群媒體、電子郵件)的現有顧客。
customer_in_loyalty_program:用戶是忠誠度計畫的一員。
JSON 裝載範例: {
"event_name": "Purchase",
"event_time": 1643723400,
"user_data": {
"em": "user@example.com"
},
"custom_data": {
"currency": "USD",
"value": 100.00,
"customer_segmentation": "new_customer_to_business"
}
} |