API เหตุการณ์ในแอพ

เหตุการณ์ในแอพจะช่วยให้คุณสามารถติดตามการดำเนินการต่างๆ ที่เกิดขึ้นในแอพมือถือหรือเว็บเพจของคุณได้ เช่น การติดตั้งแอพและเหตุการณ์การซื้อ การติดตามเหตุการณ์เหล่านี้จะทำให้คุณสามารถวัดผลประสิทธิภาพของโฆษณาและสร้างกลุ่มเป้าหมายสำหรับการกำหนดเป้าหมายโฆษณาได้

โปรดดูข้อมูลเกี่ยวกับการติดตามเหตุการณ์ในแอพสำหรับการส่งข้อความทางธุรกิจที่ API เหตุการณ์ในแอพสำหรับการส่งข้อความทางธุรกิจในเอกสารประกอบเกี่ยวกับแพลตฟอร์ม Messenger ของเรา

วิธีการทำงาน

เหตุการณ์ในแอพมี 3 ประเภทดังนี้

• เหตุการณ์ที่ลงบันทึกโดยอัตโนมัติ - Facebook SDK จะลงบันทึกจำนวนการติดตั้งแอพ ช่วงเวลาที่ใช้งานแอพ และการซื้อในแอพโดยอัตโนมัติ
• เหตุการณ์มาตรฐาน - เหตุการณ์ยอดนิยมซึ่ง Facebook ได้สร้างไว้ให้คุณ
• เหตุการณ์ที่กำหนดเอง - เหตุการณ์ที่คุณสร้างขึ้นสำหรับแอพของคุณโดยเฉพาะ

เหตุการณ์ในแอพมี 3 ส่วนดังนี้:

1. name - สตริงที่จำเป็นต้องระบุซึ่งอธิบายถึงเหตุการณ์ โดยชื่อดังกล่าวจะปรากฏในบันทึกเหตุการณ์เมื่อระบบส่งเหตุการณ์ในแอพไปยัง Analytics
2. valueToSum - ค่าที่จะระบุหรือไม่ก็ได้ที่ Analytics เพิ่มไปยังค่า “ค่าที่จะรวม” อื่นๆ จากเหตุการณ์ในแอพที่มีชื่อเดียวกัน
3. parameters - ค่าที่จะระบุหรือไม่ก็ได้ซึ่งรวมอยู่กับเหตุการณ์ในแอพ

คุณสามารถใช้ชื่อเหตุการณ์ที่แตกต่างกันได้สูงสุดจำนวน 1,000 รายการ หมายเหตุ: ระบบจะไม่ลงบันทึกเหตุการณ์ประเภทใหม่ๆ อีกเมื่อถึงจำนวนสูงสุดนี้แล้ว และหากคุณมีชื่อเหตุการณ์เกินที่จำกัดไว้นี้ คุณอาจพบข้อผิดพลาด 100 Invalid parameter ในขณะที่ลงบันทึก แต่คุณสามารถปิดใช้งานเหตุการณ์ที่ไม่ใช้แล้วได้ โปรดอ่านเพิ่มเติมเกี่ยวกับขีดจำกัดของเหตุการณ์ในคำถามที่พบบ่อย

ก่อนเริ่มต้น

คุณจำเป็นต้องมี:

• ID ผู้ลงโฆษณาของคุณ, ID การโฆษณาจากอุปกรณ์ Android หรือตัวระบุการโฆษณา (IDFA) จากอุปกรณ์ Apple
• โทเค็นการเข้าถึงแอพเพื่อให้ Facebook ยืนยันตัวตน โปรดอย่าจัดเก็บโทเค็นการเข้าถึงแอพไว้ในไคลเอ็นต์

การติดตั้งแอพ

ส่งคำขอ POST จากเซิร์ฟเวอร์ของคุณไปยังตำแหน่งข้อมูล /{app-id}/activities ด้วยพารามิเตอร์ application_tracking_enabled และ advertiser_tracking_enabled ดังนี้

curl -i -X POST "https://graph.facebook.com/{app-id}/activities
   ?event=MOBILE_APP_INSTALL
   &application_tracking_enabled=0      
   &advertiser_tracking_enabled=0       
   &advertiser_id={advertiser-tracking-id}
   &{app-access-token}"

เมื่อดำเนินการสำเร็จ แอพของคุณจะได้รับการตอบกลับดังต่อไปนี้

{
  "success": true
}

ข้อควรระวัง

• คุณควรรายงานการติดตั้งเพียง 1 ครั้งสำหรับผู้ใช้แต่ละราย หากเป็นไปได้ โปรดลบ ID ซ้ำที่ระดับ ID และระดับผู้ใช้

โปรดดูรายการพารามิเตอร์ที่พร้อมใช้งานในคู่มืออ้างอิงกิจกรรมแอพพลิเคชั่นของเรา

เปิดใช้งานการติดตามโฆษณา

ช่อง advertiser_tracking_enabled จะระบุว่าผู้ใช้ได้เปิดใช้งานการติดตามโฆษณาบนอุปกรณ์ของตนเองหรือไม่ ตั้งค่าเป็น 0 หากปิดใช้งาน หรือตั้งค่าเป็น 1 หากเปิดใช้งาน คุณควรดึงข้อมูลนี้และส่งคืนให้ Facebook เพื่อพิจารณาว่าสามารถใช้การติดตามโฆษณาเพื่อการปรับให้เหมาะสมหรือคอนเวอร์ชั่นได้หรือไม่ Meta จะใช้ข้อมูลเหตุการณ์ (จากพาร์ทเนอร์เกี่ยวกับกิจกรรมของผู้ใช้นอก Meta) ตามนโยบายข้อมูล ซึ่งรวมถึงการใช้เพื่อการรายงานผลโฆษณา การตรวจจับการฉ้อโกง และเพื่อสร้างและปรับปรุงผลิตภัณฑ์ของเรา (รวมถึงผลิตภัณฑ์สำหรับการแสดงโฆษณาของเรา) แต่จะจำกัดไม่ให้นำข้อมูลเกี่ยวกับบุคคลนั้นไปใช้เพื่อปรับแต่งโฆษณาของผู้ใช้รายดังกล่าว สำหรับอุปกรณ์ที่ใช้เวอร์ชั่นเก่ากว่า iOS 6 พารามิเตอร์นี้ควรมีค่าเริ่มต้นเป็น 1

โปรดไปที่ Apple, ข้อมูลอ้างอิงเกี่ยวกับ AdSuppport เพื่อรับสถานะการติดตามของผู้ใช้

ส่วนย่อยของโค้ดต่อไปนี้จะแสดงให้เห็นถึงวิธีดึงค่าของแฟล็กที่เปิดใช้งานการติดตาม

คุณสามารถดึงข้อมูลการตั้งค่าในปัจจุบันของแฟล็กที่เปิดใช้งานการติดตามได้จากคุณสมบัติ Settings.shared.isAdvertiserTrackingEnabled

print("isAdvertiserTrackingEnabled: \(Settings.shared.isAdvertiserTrackingEnabled)")

ปิดใช้งานการติดตามโฆษณา

ทุกแอพพลิเคชั่นสามารถเลือกที่จะเพิ่มการตั้งค่าให้กับผู้ใช้เพื่อปิดการติดตามโฆษณาในแอพนั้นได้ Facebook ขอให้พาร์ทเนอร์เพิ่มตัวเลือกนี้ลงใน SDK ของตนเองและรายงานตัวเลือกของผู้ใช้กลับไปที่ Facebook พร้อมกับจำนวนการติดตั้งหรือเหตุการณ์คอนเวอร์ชั่น โดย Facebook จะใช้จำนวนการติดตั้งหรือเหตุการณ์คอนเวอร์ชั่นสำหรับการรายงานโฆษณา แต่จะจำกัดไม่ให้ใช้ในการปรับโฆษณาให้เหมาะสม การตั้งค่าของผู้ใช้จะต้องเหมือนเดิมตลอดการเปิดใช้แอพ

เหตุการณ์คอนเวอร์ชั่น

ส่งคำขอ POST ไปยังตำแหน่งข้อมูล /{app-id}/activities โดยตั้งค่า event เป็น CUSTOM_APP_EVENTS และตั้งค่า advertiser_tracking_enabled สำหรับแต่ละเหตุการณ์ คุณจำเป็นต้องระบุพารามิเตอร์ advertiser_id หรือ attribution

curl -i -X POST "https://graph.facebook.com/{app-id}/activities
   ?event=CUSTOM_APP_EVENTS" 
   &advertiser_id={advertiser-tracking-id}
   &advertiser_tracking_enabled=1 
   &application_tracking_enabled=1
   &custom_events=[
      {"_eventName":"fb_mobile_purchase",
       "event_id":"123456",
       "fb_content":"[
            {"id": "1234", "quantity": 2,}, 
            {"id": "5678", "quantity": 1,}
        ]",
       "fb_content_type":"product",
       "_valueToSum":21.97,
       "fb_currency":"GBP",
      }
    ]
   &{app-access-token}" 

เมื่อดำเนินการสำเร็จ แอพของคุณจะได้รับการตอบกลับดังต่อไปนี้

{
  "success": true
}

การระบุที่มา

ตำแหน่งข้อมูล attribution จะส่งคืนจำนวนการติดตั้งและคอนเวอร์ชั่นตามจำนวนการคลิกที่เกิดขึ้นกับโฆษณาภายใน 28 วัน โดยตัวจัดการโฆษณาจะใช้รูปแบบการระบุที่มาการดูผ่าน 1 วันและการคลิกผ่าน 28 วัน และข้อมูลเชิงลึกจะแสดงตามอิมเพรสชั่นหรือเวลาการคลิก ไม่ใช่เวลาของการติดตั้งหรือคอนเวอร์ชั่น ซึ่งจะมีความสำคัญในขณะที่เปรียบเทียบการรายงานของคุณกับรายงานของตัวจัดการโฆษณาของ Facebook นอกเหนือไปจากการขอรับสิทธิ์เหตุการณ์ในแอพที่เป็นการคลิกโฆษณามาตรฐาน คุณควรคำนึงถึงกรณีต่อไปนี้ด้วย

• การขอรับสิทธิ์การระบุที่มาการดูผ่าน - การตั้งค่า consider_views=TRUE จะส่งคืนข้อมูลการระบุที่มาสำหรับจำนวนการติดตั้งที่เกิดขึ้นภายใน 1 วันหลังมีอิมเพรสชั่นของโฆษณาหากบัญชีในศูนย์บัญชีดังกล่าวไม่ได้คลิกโฆษณาภายใน 28 วัน โดยการตอบกลับที่ส่งคืนมาจะเป็น is_view_through=TRUE และ view_time จะแทนที่ click_time การระบุที่มาอื่นๆ ทั้งหมดจะตรงกับข้อมูลการระบุที่มาการคลิกโฆษณา

• การขอรับสิทธิ์ข้ามแคมเปญ - ผู้ลงโฆษณาสามารถติดตามประสิทธิภาพของโฆษณาทั้งหมดที่ทำให้เกิดเหตุการณ์ในแอพได้ โดย Facebook จะส่งการขอรับสิทธิ์สำหรับเหตุการณ์จากแคมเปญโฆษณาหากวัตถุประสงค์แคมเปญไม่ได้ตั้งค่าเป็นจำนวนการติดตั้งแอพมือถือหรือการมีส่วนร่วมในแอพมือถือ ข้อมูลนี้จะแสดงก็ต่อเมื่อผู้ลงโฆษณาได้เพิ่มแอพลงในช่อง "การติดตามเหตุการณ์ในแอพมือถือ" ในโฆษณาของตนเท่านั้น

• กรณีผู้ใช้ — หากไคลเอ็นต์ของคุณต้องการติดตามจำนวนการติดตั้งที่เกิดขึ้นจากโฆษณาโพสต์บนเพจหรือการคลิกโฆษณาบนเว็บไซต์ที่ส่งผู้ใช้ไปที่เว็บไซต์บนมือถือ ไคลเอ็นต์จะสามารถดำเนินการนี้ได้ในตัวจัดการโฆษณา และ Facebook จะขอรับสิทธิ์ในจำนวนการติดตั้งแอพที่เกี่ยวข้อง

• การขอรับสิทธิ์ข้ามอุปกรณ์ - ผู้ลงโฆษณาที่มีแอพในหลายแพลตฟอร์มสามารถดูข้อมูลเกี่ยวกับจำนวนการติดตั้งแอพที่ได้มาจากโฆษณาบนหลายๆ แพลตฟอร์มเหล่านี้ได้

• กรณีการใช้งาน — ผู้ใช้คลิกโฆษณาแอพบน iPhone และติดตั้งแอพเดียวกันนี้ลงใน iPad ของตน จากนั้นเราจะสามารถระบุแหล่งที่มาของการติดตั้งแอพใน iPad ไปจนถึงโฆษณาบน iPhone ได้โดยไม่คำนึงถึงการกำหนดเป้าหมายโฆษณา

การจับคู่ขั้นสูง

การจับคู่ขั้นสูงช่วยให้คุณสามารถส่งข้อมูลลูกค้าไปยัง Facebook ได้ ซึ่งเราจะใช้ข้อมูลนี้เพื่อระบุบัญชีในศูนย์บัญชีที่ดำเนินการจากการเห็นโฆษณาของคุณให้แม่นยำมากยิ่งขึ้น ข้อมูลนี้จะช่วยให้ Facebook สามารถจับคู่เหตุการณ์คอนเวอร์ชั่นกับลูกค้าของคุณได้เพื่อปรับโฆษณาของคุณให้เหมาะสมและสร้างกลุ่มเป้าหมายที่ใหญ่ขึ้นสำหรับการทำการตลาดซ้ำ

ส่งคำขอ POST ไปยังตำแหน่งข้อมูล /{app-id}/activities โดยตั้งค่าพารามิเตอร์ ud เป็นพารามิเตอร์ที่จะช่วยติดตามลูกค้าของคุณ เช่น อีเมลหรือหมายเลขโทรศัพท์ของลูกค้า ข้อมูลลูกค้าทั้งหมดจะต้องมีการแฮช ไม่เช่นนั้น Facebook จะไม่สนใจข้อมูลดังกล่าว โปรดอย่าลืมตั้งค่า advertiser_tracking_enabled สำหรับแต่ละเหตุการณ์

curl -i -X POST "https://graph.facebook.com/{app-id}/activities
   ?event=CUSTOM_APP_EVENTS
   &advertiser_id={advertiser-tracking-id}
   &advertiser_tracking_enabled=1 
   &application_tracking_enabled=1
   &custom_events=[
      {"_eventName":"fb_mobile_purchase",
      "event_id":"123456",
       "fb_content":"[
            {"id": "1234", "quantity": 2,}, 
            {"id": "5678", "quantity": 1,}
        ]",
       "fb_content_type":"product",
       "_valueToSum":21.97,
       "fb_currency":"GBP",
      }
    ]
   &ud[em]={sha256-hashed-email}
   &{app-access-token}"

เมื่อดำเนินการสำเร็จ แอพของคุณจะได้รับการตอบกลับดังต่อไปนี้

{
  "success": true
}

ข้อมูลผู้ใช้ทั้งหมดต้องได้รับการแฮชด้วย SHA256 ก่อนที่จะส่งให้ Facebook ซึ่ง Facebook จะไม่สนใจข้อมูลที่ไม่ได้รับการแฮช

การลบเหตุการณ์ซ้ำซ้อน

สำหรับเหตุการณ์ในแอพ เราใช้ฟังก์ชั่นการลบเหตุการณ์ซ้ำซ้อนแบบเดียวกับที่มีอยู่สำหรับเหตุการณ์บนเว็บ ตรรกะนี้จะใช้ประโยชน์จากช่อง event_id และ event_name ตามการลบเหตุการณ์ซ้ำซ้อน พารามิเตอร์ event_id คือตัวระบุที่สามารถแยกแยะความแตกต่างระหว่างเหตุการณ์ที่คล้ายกันได้โดยไม่ซ้ำกัน ID เหตุการณ์ที่ไม่ถูกต้องอาจทำให้คอนเวอร์ชั่นมีการลบเหตุการณ์ซ้ำซ้อนอย่างไม่ถูกต้อง ซึ่งส่งผลต่อการรายงานคอนเวอร์ชั่นและประสิทธิภาพของแคมเปญ

ข้อมูลอุปกรณ์ส่วนเพิ่มเติม

ส่งข้อมูลของอุปกรณ์ เช่น ความกว้างและความสูงของหน้าจอในการเรียกเหตุการณ์ในแอพของคุณโดยใช้ /{app-id}/activities?extinfo โดยค่าต่างๆ จะคั่นด้วยเครื่องหมายจุลภาคและต้องเรียงลำดับตามที่บ่งชี้ไว้ในคู่มืออ้างอิง /application/activites เมื่อใช้ extinfo คุณจะต้องระบุค่าทั้งหมด

• version ต้องเป็น a2 สำหรับ Android
• version ต้องเป็น i2 สำหรับ iOS

ข้อมูลอ้างอิง

• พารามิเตอร์ ApplicationActivities
• เอกสารประกอบสำหรับผู้พัฒนา Android - เกณฑ์ชี้วัดการแสดงผล
• เอกสารประกอบสำหรับผู้พัฒนา Android - พื้นที่เก็บข้อมูลภายนอก
• เอกสารประกอบสำหรับผู้พัฒนา Apple - เกณฑ์ชี้วัดการแสดงผล
• เอกสารประกอบสำหรับผู้พัฒนา Apple - พื้นที่เก็บข้อมูลภายนอก
• เอกสารประกอบสำหรับผู้พัฒนา Apple - ขนาดหน้าจอ

เรียกดูคุกกี้บนมือถือ

เราสนับสนุนให้คุณเชื่อมโยงเหตุการณ์ในแอพกับ advertiser_id อย่างไรก็ตาม สำหรับอุปกรณ์ Android และอุปกรณ์ iOS ก่อนหน้า iOS 6 คุณยังสามารถใช้พารามิเตอร์ attribution ที่ตั้งค่าเป็นคุกกี้บนมือถือของอุปกรณ์ได้ด้วย

หมายเหตุ: คุกกี้บนมือถือไม่ได้มาจากแอตทริบิวต์ของผู้ใช้และอุปกรณ์ โดยคุกกี้เหล่านี้จะมีการแปรผันและได้รับการออกแบบมาให้รีเฟรชบ่อยครั้ง โปรดอย่าใช้คุกกี้บนมือถือในการกำหนดเป้าหมายโฆษณาใหม่

Android

คุกกี้เป็นสตริงที่มีทั้งตัวอักษรและตัวเลขแบบสุ่มยาว 22 อักขระ

รับ ID การระบุที่มาบน Facebook โดยใช้ ContentProvider:

public static final Uri ATTRIBUTION_ID_CONTENT_URI = Uri.parse("content://com.facebook.katana.provider.AttributionIdProvider");

public static final String ATTRIBUTION_ID_COLUMN_NAME = "aid";

public static String getAttributionId(ContentResolver contentResolver) {
        String [] projection = {ATTRIBUTION_ID_COLUMN_NAME};
        Cursor c = contentResolver.query(ATTRIBUTION_ID_CONTENT_URI, projection, null, null, null);
        if (c == null || !c.moveToFirst()) {
            return null;
        }
        String attributionId = c.getString(c.getColumnIndex(ATTRIBUTION_ID_COLUMN_NAME));
        c.close();
        return attributionId;
    }

นอกจากนี้ คุณควรดึงข้อมูล ID การโฆษณาของแอพ Android ของคุณด้วย

iOS

คุกกี้บนมือถือสร้างขึ้นโดยแอพ Facebook บน iOS โดยใช้ CFUUIDCreateString และเป็นการแสดงสตริง UUID แบบ128 บิต

เรียกดูทั้ง ID คุกกี้และ IDFA แล้วส่งไปยัง Facebook ในฐานะตัวระบุ

ASIdentifierManager *manager = [ASIdentifierManager sharedManager];
NSString *advertiserID = [[manager advertisingIdentifier] UUIDString];

if (advertiserID) {
  // do stuff
}

ส่วนหัว X-Forwarded-For HTTP

หากมีการส่งคำขอ POST จากส่วนกลาง เช่น เซิร์ฟเวอร์หรือพร็อกซี ซึ่งโดยทั่วไปก็คือการเรียกจากเซิร์ฟเวอร์ไปยังเซิร์ฟเวอร์ ก็จำเป็นต้องมีส่วนหัว X-Forwarded-For HTTP เพื่อให้แน่ใจว่าตำแหน่งที่ตั้งและข้อมูลของอุปกรณ์นั้นถูกต้องแม่นยำ โปรดส่งที่อยู่ IP ของอุปกรณ์ในรูปแบบ IPv4 หรือ IPv6 ผ่านพารามิเตอร์ส่วนหัว X-Forwarded-For HTTP ในคำขอเหตุการณ์ในแอพแต่ละรายการที่คุณส่ง การดำเนินการดังกล่าวจะช่วยให้เราสามารถจับคู่ advertiser_id กับที่อยู่ IP ที่ถูกต้องได้ ซึ่งจากนั้นเราจะสามารถนำไปใช้ในแพลตฟอร์มของเราได้

ตัวอย่างของ IPv6

curl ...
  -H "X-Forwarded-For: fd45:f238:3b40:23b1:ffff:ffff:ffff:abcd" \
  https://graph.facebook.com/<APP_ID>/activities/

ตัวอย่างของ IPv4

curl ...
  -H "X-Forwarded-For: 192.168.0.99" \
  https://graph.facebook.com/<APP_ID>/activities

การทดสอบ

1. ไปที่ตัวจัดการเหตุการณ์
2. คลิกไอคอน "แหล่งข้อมูล" ที่ด้านซ้ายของหน้า
3. เลือกชื่อและ ID ของข้อมูลของคุณ
4. คลิกที่ "เหตุการณ์ทดสอบ" และเลือกช่องทางเป็น "แอพ"
5. ส่งคำขอ AE-API ด้วยเครื่องมือ API กราฟ
6. การโต้ตอบของคุณจะปรากฏขึ้นในแท็บ "เหตุการณ์ทดสอบ" ในไม่ช้า

ข้อแตกต่าง

ในเหตุการณ์ที่ไคลเอ็นต์เปรียบเทียบรายงานของพาร์ทเนอร์ด้านการวัดผลบนมือถือกับรายงานของ Facebook และพบเห็นข้อแตกต่าง นี่เป็นรายการบางส่วนที่ควรตรวจสอบดู:

Facebook รายงานจำนวนการติดตั้งน้อยกว่า MMP ใช่หรือไม่:

• การผสานการทำงานของ FB SDK นั้นถูกต้องหรือไม่
• ไคลเอ็นต์กำลังใช้ ID ของแอพที่ไม่ถูกต้องอยู่หรือไม่

หาก Facebook รายงานจำนวนการติดตั้งมากกว่า MMP:

• ช่วงการระบุที่มาเหมือนกันหรือไม่ โดยทั่วไปแล้ว Facebook จะมีช่วงการระบุที่มามากกว่าพาร์ทเนอร์ด้านการวัดผลบนมือถือส่วนใหญ่
• การผสานการทำงานของ MMP SDK นั้นถูกต้องหรือไม่
• ไคลเอ็นต์กำลังใช้ ID ของแอพที่ไม่ถูกต้องอยู่หรือไม่
• เป็นความแตกต่างเฉพาะของ iOS7 ใช่หรือไม่ MMP รับตัวระบุการโฆษณาของ Apple (IDFA) จากอุปกรณ์และส่งไปที่ FB อย่างถูกต้องใช่หรือไม่

ข้อมูลอ้างอิง

ข้อมูลส่วนเพิ่มเติม (Extinfo) ของกิจกรรมของแอพพลิเคชั่น

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลส่วนเพิ่มเติมของแอพที่คู่มืออ้างอิงเกี่ยวกับ /application/activites

พารามิเตอร์ข้อมูลผู้ใช้

ชื่อเหตุการณ์มาตรฐาน

พารามิเตอร์เหตุการณ์มาตรฐาน

ดูเพิ่มเติม

• เหตุการณ์ในแอพ
• หลักปฏิบัติที่ดีที่สุดสำหรับเหตุการณ์ในแอพ
• การจัดการข้อผิดพลาด
• การปฏิบัติตาม GDPR
• ตัวจัดการโฆษณาของ Facebook
• แดชบอร์ดของแอพ Facebook