API คอนเวอร์ชั่นแบบออฟไลน์

API คอนเวอร์ชั่นแบบออฟไลน์จะหยุดให้บริการในเดือนพฤษภาคม 2025 จากเดิมที่ก่อนหน้านี้มีกำหนดเลิกใช้งานในไตรมาสที่สามของปี 2024 ตั้งแต่ API กราฟเวอร์ชั่น 17.0 เป็นต้นไป API คอนเวอร์ชั่นแบบออฟไลน์จะไม่รองรับเหตุการณ์แบบออฟไลน์อีกต่อไป โดย API กราฟเวอร์ชั่น 16.0 คือเวอร์ชั่นสุดท้ายที่รองรับเหตุการณ์แบบออฟไลน์ API คอนเวอร์ชั่นแบบออฟไลน์จะหยุดให้บริการเมื่อเวอร์ชั่น 16.0 หมดอายุในเดือนพฤษภาคม 2025 ในระหว่างนี้ไปจนถึงเดือนพฤษภาคม 2025 เราจะเลิกใช้งานตำแหน่งข้อมูล API คอนเวอร์ชั่นแบบออฟไลน์ที่เหลือบน API การตลาดเวอร์ชั่น 20.0 โปรดดูรายละเอียดเพิ่มเติมในบันทึกการเปลี่ยนแปลง

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


ใช้ API คอนเวอร์ชั่นแบบออฟไลน์เพื่อส่งเหตุการณ์คอนเวอร์ชั่นแบบออฟไลน์และดูจำนวนลูกค้าที่รับชมหรือคลิกโฆษณาบน Meta ก่อนที่จะทำให้เกิดคอนเวอร์ชั่น

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

หากต้องการใช้ API นี้ คุณต้องมีสิ่งต่อไปนี้

1. ตัวจัดการธุรกิจของ Meta

หากยังไม่มี โปรดสร้างขึ้นใหม่

2. ID แอพ Meta

สำหรับเข้าถึง API การตลาด ในการสร้างแอพ Meta ให้ดำเนินการดังนี้

  • ไปที่ตัวจัดการธุรกิจ > การตั้งค่าธุรกิจ
  • เลือกแอพ
  • คลิก "เพิ่มแอพใหม่" และปฏิบัติตามคำแนะนำ

3. การตรวจสอบแอพและสิทธิ์การอนุญาต

กฎเกี่ยวกับการตรวจสอบแอพและสิทธิ์การอนุญาตขึ้นอยู่กับวิธีที่คุณนำ API ของเราไปใช้:

ประเภทของการนำไปใช้งานการตรวจสอบแอพและสิทธิ์การอนุญาต

การนำไปใช้งานโดยตรง

ในกรณีนี้ คุณเป็นผู้ลงโฆษณาที่ต้องการใช้คอนเวอร์ชั่นแบบออฟไลน์โดยตรง


ในกรณีนี้:

  • แอพของคุณไม่จำเป็นต้องผ่านการตรวจสอบแอพ
  • คุณไม่จำเป็นต้องขอสิทธิ์การอนุญาตใดๆ

พาร์ทเนอร์นำไปใช้งานเป็นแพลตฟอร์ม

ในกรณีนี้ คุณเป็นพาร์ทเนอร์จากภายนอกที่นำเสนอฟังก์ชั่นการทำงานของคอนเวอร์ชั่นแบบออฟไลน์ให้กับผู้ลงโฆษณาที่ใช้บริการของคุณ


ในกรณีนี้ ให้ดำเนินการดังนี้

  • แอพของคุณต้องผ่านการตรวจสอบแอพ
  • คุณต้องส่งคำขอสิทธิ์การอนุญาต ads_management ในระหว่างการตรวจสอบแอพ

4. ผู้ใช้ระบบตัวจัดการธุรกิจและโทเค็น

แอพของคุณสามารถส่งข้อมูลไปยัง Meta โดยใช้ API ได้ด้วยสิทธิ์การเข้าถึงผู้ใช้ระบบ วิธีสร้างมีดังนี้

  • ไปที่ตัวจัดการธุรกิจ > การตั้งค่าธุรกิจ
  • เลือกผู้ใช้ระบบ
  • คลิก "เพิ่มผู้ใช้ระบบรายใหม่"
  • เลือก "ผู้ใช้ระบบที่เป็นผู้ดูแล" เป็นบทบาทให้กับผู้ใช้ระบบรายนั้น

โทเค็นการเข้าถึงจะให้สิทธิ์การเข้าถึงข้อมูล Meta วิธีสร้างโทเค็นการเข้าถึงผู้ใช้ระบบ:

  • ไปที่ตัวจัดการธุรกิจ > การตั้งค่าธุรกิจ
  • เลือกผู้ใช้ระบบ
  • เลือกผู้ใช้ระบบและคลิก "สร้างโทเค็นใหม่"
  • เลือกแอพของคุณ > ในส่วน scope ให้เลือก ads_management

5. บัญชีโฆษณา

คุณจะต้องมีบัญชีโฆษณาเพื่อแสดงแคมเปญโฆษณาบน Meta หากต้องการสร้างบัญชีโฆษณา ให้ดู API การตลาดหรือศูนย์ช่วยเหลือทางธุรกิจ: เกี่ยวกับการตั้งค่าธุรกิจของคุณในตัวจัดการธุรกิจของ Meta

6. อนุญาตสิทธิ์การเข้าถึงผู้ใช้ระบบให้กับบัญชีผู้ใช้โฆษณา

อนุญาตสิทธิ์การเข้าถึงผู้ใช้ระบบของคุณให้กับบัญชีโฆษณา

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

7. ชุดเหตุการณ์แบบออฟไลน์

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

การใช้งานแบบเดิมทำให้คุณสามารถดำเนินการ CRUD (สร้าง อ่าน อัพเดต และลบ) กับชุดเหตุการณ์แบบออฟไลน์ได้ในระดับตัวจัดการธุรกิจ เพื่อแชร์ชุดเหตุการณ์กับอ็อบเจ็กต์และเอนทิตี้อื่นๆ

อัพโหลดข้อมูลเหตุการณ์

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

  • ผู้ดูแลตัวจัดการธุรกิจ
  • ผู้ใช้ระบบที่เป็นผู้ดูแล ซึ่งเป็นผู้สร้างชุดเหตุการณ์แบบออฟไลน์
  • ผู้ดูแลใน ad_account ที่เชื่อมต่อกับชุดเหตุการณ์แบบออฟไลน์

ดูชุดเหตุการณ์คอนเวอร์ชั่นแบบออฟไลน์, ข้อมูลอ้างอิง

1. สร้างชุดเหตุการณ์แบบออฟไลน์

curl 
  -F 'access_token=<SYSTEM_USER_ACCESS_TOKEN>' 
  -F 'name=offline_event_set',
  -F 'description=conversion data used for superbowl campaign',
  https://graph.facebook.com/<API_VERSION>/<BUSINESS_MANAGER_ID>/offline_conversion_data_sets

สร้าง HTTP POST:

POST /<BUSINESS_MANAGER_ID>/offline_conversion_data_sets HTTP/1.1
Host: graph.facebook.com
curl -X POST \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<BUSINESS_MANAGER_ID>/offline_conversion_data_sets

การตอบกลับจะมี id ของชุดเหตุการณ์รวมอยู่ด้วย:

{
  "id": <OFFLINE_EVENT_SET_ID>
}

พารามิเตอร์


พารามิเตอร์ คำอธิบาย

name

ประเภท: สตริง

ชื่อชุดเหตุการณ์

ตัวอย่าง: In store purchases, Lead registrations

description

ประเภท: สตริง

คำอธิบายชุดเหตุการณ์

ตัวอย่าง: In store purchases for the Superbowl campaign

2. กำหนดสิทธิ์การอนุญาตในบัญชีผู้ใช้โฆษณา

วิธีกำหนดการติดตามและสิทธิ์ในการอ่านให้บัญชีโฆษณา:

POST /<OFFLINE_EVENT_SET_ID>/adaccounts HTTP/1.1
Host: graph.facebook.com
curl -X POST \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<OFFLINE_EVENT_SET_ID>/adaccounts

พารามิเตอร์


พารามิเตอร์ คำอธิบาย

business

ประเภท: จำนวนเต็ม

กำหนดบัญชีโฆษณาให้กับ ID ธุรกิจนี้

account_id

ประเภท: จำนวนเต็ม

ID ของบัญชีโฆษณาที่มีการติดตามแบบออฟไลน์เปิดใช้งานอยู่

3. กำหนดการติดตามโฆษณา

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

curl \
  -F 'tracking_spec=[{action.type:"offline_conversion", dataset:["123"]}]' \
  -F 'access_token=<SYSTEM_USER_ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/<AD_ID>

วิธีอัพเดตข้อมูลจำเพาะการติดตามของโฆษณาของคุณ:

POST /<AD_ID>/?tracking_specs=[{"action.type":"offline_conversion","dataset": <OFFLINE_EVENT_SET_ID>}] HTTP/1.1
Host: graph.facebook.com
curl -X POST \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<AD_ID>/?tracking_specs=[{"action.type":"offline_conversion","dataset": <OFFLINE_EVENT_SET_ID>}]

พารามิเตอร์


พารามิเตอร์ คำอธิบาย

action.type

ประเภท: สตริง

ติดตามการดำเนินการนี้สำหรับกลุ่มโฆษณา

ตัวอย่าง: offline_conversion

dataset

ประเภท: รายการ<id>

ID สำหรับชุดเหตุการณ์แบบออฟไลน์

ตัวอย่าง: 11111111111

4. อัพโหลดเหตุการณ์แบบออฟไลน์

คุณควรอัพโหลดธุรกรรมภายใน 62 วัน นับตั้งแต่วันที่เกิดคอนเวอร์ชั่นดังกล่าว อัพโหลดข้อมูลคอนเวอร์ชั่น:

curl \
  -F 'access_token=SYSTEM_USER_ACCESS_TOKEN' \
  -F 'upload_tag=store_data' \
  -F 'data=[ \
    { 
      match_keys: {"phone": ["HASH1","HASH2"], "email": ["HASH3","HASH4"]}, 
      currency: "USD", 
      value: 16,
      event_name: "Purchase",
      event_time: 1456870902,
      contents: [
        {id: "A", quantity: 1},
        {id: "B", quantity: 2},
        {id: "C", quantity: 1}
      ]
      custom_data: {             
      },
    }, 
    { 
      match_keys: {"lead_id": "12345"}, 
      event_name: "Lead",
      event_time: 1446336000,
      contents: [
        {id: "A", quantity: 1},
        {id: "B", quantity: 2},
        {id: "C", quantity: 1}
      ]
      custom_data: {
        event_source: "email",
        action_type: "sent_open_click",
        email_type: "email_type_code", 
        email_provider: "gmail_yahoo_hotmail",
      }
    }, 
  ]'
  https://graph.facebook.com/VERSION/OFFLINE_EVENT_SET_ID/events

หากต้องการส่งคอนเวอร์ชั่น ให้สร้าง HTTP POST:

POST /<OFFLINE_EVENT_SET_ID>/events HTTP/1.1
Host: graph.facebook.com
curl -X POST \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<OFFLINE_EVENT_SET_ID>/events

พารามิเตอร์


พารามิเตอร์ คำอธิบาย

upload_tag

ประเภท: สตริง

จำเป็นต้องระบุ

ติดตามการอัพโหลดเหตุการณ์ของคุณ

ตัวอย่าง: monthly, in-store uploads

data

ประเภท: json array

จำเป็นต้องระบุ

รวมจำนวนเหตุการณ์ที่ได้รับการอัพโหลด อัพโหลดเหตุการณ์คอนเวอร์ชั่นต่อบัญชีในศูนย์บัญชีได้สูงสุด 2,000 เหตุการณ์ต่อการเรียกใช้ API

ตัวอย่าง: ดูตัวอย่างด้านบน

namespace_id

ประเภท: จำนวนเต็ม

ระบุหรือไม่ก็ได้

ขอบเขตที่ใช้สำหรับแก้ไข extern_id หรือ tpid อาจเป็นชุดข้อมูลหรือ ID พาร์ทเนอร์ด้านข้อมูลอื่น

ตัวอย่าง: 12345

ใช้ upload_tag เดียวกันสำหรับการเรียกใช้ API การอัพโหลดเหตุการณ์ทั้งหมดในแบตช์เดียวกันเพื่อทำการจัดกลุ่ม การดำเนินการนี้จะช่วยให้คุณสามารถแก้ไขจุดบกพร่องในการอัพโหลดเหตุการณ์ได้ และคุณควรนำมาใช้กับการอัพโหลดเหตุการณ์ใดๆ ก็ตามที่ดำเนินการในการเรียกใช้ API มากกว่า 1 ครั้ง

พารามิเตอร์ใน data ประกอบด้วย:

พารามิเตอร์ คำอธิบาย

match_keys

ประเภท: พจนานุกรม JSON

จำเป็นต้องระบุ

ข้อมูลการระบุที่เราใช้เพื่อจับคู่ผู้คนบน Meta

ตัวอย่าง: {"phone": ["{HASH}","{HASH}"], "email": ["{HASH}","{HASH}"], "fn": "{HASH}",}.

event_time

ประเภท: จำนวนเต็ม

จำเป็นต้องระบุ

ประทับเวลา UNIX ของเหตุการณ์คอนเวอร์ชั่น

ตัวอย่าง: 1456870055

event_name

ประเภท: สตริง

จำเป็นต้องระบุ

ประเภทเหตุการณ์

ตัวอย่าง: ViewContent, Search, AddToCart, AddToWishlist, InitiateCheckout, AddPaymentInfo, Purchase, Lead, Other

currency

ประเภท: สตริง

จำเป็นต้องระบุ

รหัสสกุลเงิน ISO แบบ 3 ตัวอักษรสำหรับเหตุการณ์คอนเวอร์ชั่นนี้ จำเป็นต้องระบุสำหรับเหตุการณ์ Purchase

ตัวอย่าง: USD

value

ประเภท: จำนวนทศนิยม

จำเป็นต้องระบุ

ค่าของเหตุการณ์คอนเวอร์ชั่น จำเป็นต้องระบุสำหรับเหตุการณ์ Purchase

ตัวอย่าง: 16.00

content_type

ประเภท: สตริง

ระบุหรือไม่ก็ได้

content_type ของโฆษณาแค็ตตาล็อก Advantage+ ที่ถูกต้อง

ตัวอย่าง: product

contents

ประเภท: อาร์เรย์ JSON

ระบุหรือไม่ก็ได้ จำเป็นต้องระบุ หากคุณผสานโฆษณาของคุณเข้ากับแค็ตตาล็อก

จำเป็นต้องระบุ: id, quantity


แนะนำ: price, brand, category

จำเป็นต้องระบุ: [ {id: "A", quantity: 1}, {id: "B", quantity: 2}, {id: "C", quantity: 1}]


แนะนำ: [ {id: "A", quantity: 1, brand: "Brand_A", category: "", price: 10.0}]

custom_data

ประเภท: พจนานุกรม JSON

ระบุหรือไม่ก็ได้

ข้อมูลเกี่ยวกับเหตุการณ์คอนเวอร์ชั่นนี้

ตัวอย่าง: {category: 'ICECREAM'}

order_id

ประเภท: สตริง

ระบุหรือไม่ก็ได้

ตัวระบุที่ไม่ซ้ำกันสำหรับธุรกรรมหรือคำสั่งซื้อแต่ละรายการในชุดเหตุการณ์แบบออฟไลน์ ตัวอย่างเช่น สำหรับการขายปลีกอาจเป็น ID ใบเสร็จ

ตัวอย่าง: ATN10001, 123456

item_number

ประเภท: สตริง

ระบุหรือไม่ก็ได้

ตัวระบุที่ไม่ซ้ำกันเพื่อแยกแยะเหตุการณ์ในคำสั่งซื้อหรือธุรกรรมเดียวกัน

ตัวอย่าง: 1, a

ตัวอย่างเช่น คุณสามารถอัพโหลดข้อมูลด้วยช่อง data ได้:

{
  match_keys: MATCH_KEYS,
  event_time: EVENT_TIME,
  event_name: "Purchase",
  value: 400,
  currency: "USD",
  contents: [
    {
        id: "A",
        quantity: 1,
        brand: "brand_of_A",
        category: "Apparel & Accessories | Clothing",
        price: 100,
    },
    {
        id: "B",
        quantity: 2,
        brand: "brand_of_B",
        category: "Apparel & Accessories | Shoes",
        price: 50,
    },
    {
        id: "C",
        quantity: 1,
        brand: "brand_of_C",
        category: "Apparel & Accessories | Jewelry | Watches",
        price: 200,
    }
  ],
}

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

คีย์การจับคู่

match_keys เป็นชุดตัวระบุเพื่อจับคู่ผู้คนสำหรับการระบุที่มา ดูกลุ่มเป้าหมายที่กำหนดเองจากข้อมูล CRM เพื่อทำข้อมูลให้เป็นมาตรฐานและแฮชข้อมูลของคุณ ระบบรองรับเฉพาะ SHA256 และเราไม่รับข้อมูลที่ไม่ได้ผ่านการแฮช

โปรดดาวน์โหลดไฟล์ CSV นี้

หากต้องการดูตัวอย่างข้อมูลที่แฮชและทำให้เป็นมาตรฐานอย่างเหมาะสมสำหรับพารามิเตอร์ด้านล่าง



ดาวน์โหลด (คลิกขวา > บันทึกลิงก์เป็น)
ชื่อพารามิเตอร์ พารามิเตอร์ ต้องแฮชหรือไม่

ที่อยู่อีเมล

email

ต้องแฮช

หมายเลขโทรศัพท์มือถือ

phone

ต้องแฮช

เพศ

gen

ต้องแฮช

วันเกิด

db

ต้องแฮช

นามสกุล

ln

ต้องแฮช

ชื่อจริง

fn

ต้องแฮช

เมือง

ct

ต้องแฮช

รัฐในสหรัฐฯ

st

ต้องแฮช

รหัสไปรษณีย์

zip

ต้องแฮช

ประเทศ

country

ต้องแฮช

ตัวระบุโฆษณาของ Apple

madid

ต้องแฮช

ID การโฆษณาของ Android

madid

ต้องแฮช

ID ผู้ใช้ภายนอก

external_id

แนะนำเป็นอย่างยิ่ง

ID ข้อมูลลูกค้าจากโฆษณาแบบกรอกฟอร์ม

lead_id

ไม่ต้องแฮช

การตอบกลับ:

ชื่อ ประเภท คำอธิบาย

num_processed_entries

จำนวนเต็ม

จำนวนรายการที่ประมวลผล

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

ดูสถิติการอัพโหลด

ผู้ดูแลตัวจัดการธุรกิจหรือผู้ใช้ระบบที่สร้างชุดเหตุการณ์แบบออฟไลน์สามารถเรียกดูสถิติการอัพโหลดได้ นอกจากนี้ ผู้ดูแลทุกรายใน ad_account ที่เชื่อมต่อกับชุดเหตุการณ์แบบออฟไลน์ยังสามารถอ่านข้อมูลนี้ได้อีกด้วย

วิธีการดูสถิติเกี่ยวกับชุดเหตุการณ์แบบออฟไลน์ เช่น รายการที่ถูกต้องและรายการที่ตรงกัน:

GET /<OFFLINE_EVENT_SET_ID>/uploads HTTP/1.1
Host: graph.facebook.com
curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<OFFLINE_EVENT_SET_ID>/uploads

ดูข้อมูลแยกย่อยแบบรายวันของเหตุการณ์แบบออฟไลน์ใน Offline Events Manager ในตัวจัดการธุรกิจ สำหรับข้อมูลแยกย่อยที่แม่นยำยิ่งขึ้น โปรดเรียก:

GET /<OFFLINE_EVENT_SET_ID>/stats HTTP/1.1
Host: graph.facebook.com
curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<OFFLINE_EVENT_SET_ID>/stats

พารามิเตอร์


พารามิเตอร์ คำอธิบาย

start

ประเภท: จำนวนเต็ม

ระบุหรือไม่ก็ได้

ประทับเวลา UNIX สืบค้นเหตุการณ์โดยเริ่มจากเวลานี้

ตัวอย่าง: 1456870055

end

ประเภท: จำนวนเต็ม

ระบุหรือไม่ก็ได้

ประทับเวลา UNIX โดยไม่รวมเหตุการณ์ที่เกิดขึ้น ณ ตอนนี้เป็นต้นไป

ตัวอย่าง: 1456870056

fields

ประเภท: string[]

ระบุหรือไม่ก็ได้

รายการของสตริง ตำแหน่งข้อมูลนี้จะมีช่องทั้งหมดให้จนถึงเวอร์ชั่น 3.0 และสำหรับเวอร์ชั่นหลังจากนั้นจะมี count, event และ time ให้เป็นค่าเริ่มต้น โดยมีช่องเพิ่มเติม ได้แก่ matched_count, attributed_count, usd_amount, matched_usd_amount, attributed_usd_amount หรือ duplicate_count

summary

ประเภท: บูลีน

ระบุหรือไม่ก็ได้

ส่งกลับเวลาอัพโหลดล่าช้าเฉลี่ยเป็นจำนวนวินาที เมื่อตั้งค่าเวลารวบรวมเป็น upload_time และตั้งค่าช่องนี้เป็น true

aggr_time

ประเภท: สตริง

ระบุหรือไม่ก็ได้

รวมผลลัพธ์ตามเวลาที่ตั้งไว้นี้ ตัวเลือกคือ upload_time และ event_time ค่าเริ่มต้นคือ event_time

สร้างคอนเวอร์ชั่นที่กำหนดเองแบบออฟไลน์

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

หากต้องการสร้างคอนเวอร์ชั่นแบบกำหนดเองโดยใช้เหตุการณ์แบบออฟไลน์ของคุณ ให้สร้าง POST:

POST /act_<ACCOUNT_ID>/customconversions HTTP/1.1
Host: graph.facebook.com
curl -X POST \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/act_<ACCOUNT_ID>/customconversions

พารามิเตอร์:

พารามิเตอร์ คำอธิบาย

name

ประเภท: สตริง

ชื่อคอนเวอร์ชั่นแบบกำหนดเองใหม่

ตัวอย่าง: Offline purchases over 100 dollars

event_source_id

ประเภท: จำนวนเต็ม

ID ชุดเหตุการณ์แบบออฟไลน์เพื่อติดตาม

ตัวอย่าง: 11111111111

custom_event_type

ประเภท: สตริง

เหตุการณ์มาตรฐานสำหรับพิกเซลของ Meta จำนวน 1 จาก 9 เหตุการณ์

ตัวอย่าง: "ViewContent", "Search", "AddToCart", "AddToWishlist", "InitiateCheckout", "AddPaymentInfo", "Purchase", "Lead", "CompleteRegistration", "Other"

rule

ประเภท: สตริงที่เข้ารหัสด้วย JSON

ตัวดำเนินการและข้อมูลสำหรับกฎคอนเวอร์ชั่นของคุณ ดูคอนเวอร์ชั่นแบบกำหนดเอง, ข้อมูลอ้างอิง ตัวอย่างเช่น การซื้อที่สูงกว่า 100 ดอลลาร์สหรัฐ

ตัวอย่าง: {"and":[{"event_name":{"eq": "Purchase"}},{"value":{"gt":100}}]}

การตอบกลับเมื่อสำเร็จ:

{
  "id": <CUSTOM_CONVERSION_ID>
}

วัดผลด้วยข้อมูลที่กำหนดเอง

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

ตัวอย่างเช่น ใส่หมวดหมู่สินค้าให้กับรายการที่อัพโหลดโดยใช้ custom_data:

data=[
  {
    match_keys: {"phone": ["<HASH>","<HASH>"], "email": ["<HASH>","<HASH>"]}, 
    currency: "USD", 
    value: 16,
    event_name: "Purchase",
    event_time: 1456870902,
    custom_data: {
      product_category: "ICECREAM",
    },
  },
]

จากนั้นใช้ custom_data.{YOUR_CUSTOM_PARAM} เพื่อสร้างกฎคอนเวอร์ชั่นแบบกำหนดเอง:

curl \
  -F 'name=Ice Cream Purchasers' \
  -F 'custom_event_type=Purchase' \
  -F 'event_source_id=<OFFLINE_EVENT_SET_ID>' \
  -F 'rule={"and": [{"event_name":{"eq":"Purchase"}},{"custom_data.product_category":{"i_contains":"ICECREAM"}}]}' \
  -F 'access_token=<ACCESS_TOKEN>' \

"https://graph.facebook.com/<API_VERSION>/act_<ACCOUNT_ID>/customconversions"

คอนเวอร์ชั่นแบบออฟไลน์สำหรับพาร์ทเนอร์

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

  1. พาร์ทเนอร์ - สร้างชุดเหตุการณ์แบบออฟไลน์
  2. พาร์ทเนอร์ - แบ่งปันชุดเหตุการณ์กับตัวจัดการธุรกิจของลูกค้า
  3. ลูกค้า - กำหนดสิทธิ์การอนุญาตการติดตามบัญชีผู้ใช้โฆษณาแบบออฟไลน์
  4. ลูกค้า - ตั้งค่าการติดตามแบบออฟไลน์บนโฆษณา
  5. พาร์ทเนอร์ - อัพโหลดเหตุการณ์แบบออฟไลน์ ดูสถิติ
  6. พาร์ทเนอร์ - แสดงข้อมูลเชิงลึกของโฆษณาสำหรับลูกค้า

ขั้นตอนต่อไปนี้ขึ้นอยู่กับวิธีการตั้งค่าสิทธิ์การอนุญาตพาร์ทเนอร์หรือเอเจนซี่ด้วยบัญชีผู้ใช้โฆษณาของลูกค้า:

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

หากต้องการตั้งค่าสิทธิ์การอนุญาตเหล่านี้ โปรดดูองค์ประกอบของตัวจัดการธุรกิจ

พาร์ทเนอร์ - แชร์ชุดเหตุการณ์

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

GET /<OFFLINE_EVENT_SET_ID>/agencies HTTP/1.1
Host: graph.facebook.com
curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<OFFLINE_EVENT_SET_ID>/agencies

พารามิเตอร์


พารามิเตอร์ คำอธิบาย

business

ประเภท: จำนวนเต็ม

ID ของตัวจัดการธุรกิจของลูกค้า

ลูกค้า - กำหนดสิทธิ์การอนุญาตการติดตามบัญชีผู้ใช้โฆษณาแบบออฟไลน์

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

คุณสามารถกำหนดสิทธิ์การอนุญาตการติดตามและการดูเหตุการณ์แบบออฟไลน์ให้กับบัญชีโฆษณาได้ด้วยการเรียกนี้:

POST /<OFFLINE_EVENT_SET_ID>/adaccounts HTTP/1.1
Host: graph.facebook.com
curl -X POST \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<OFFLINE_EVENT_SET_ID>/adaccounts

พารามิเตอร์

พารามิเตอร์ คำอธิบาย

business

ประเภท: จำนวนเต็ม

กำหนดบัญชีโฆษณาให้กับ ID ธุรกิจนี้

account_id

ประเภท: จำนวนเต็ม

ID บัญชีโฆษณาที่มีการติดตามแบบออฟไลน์เปิดใช้งานอยู่

ระบุ ID ภายนอก

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

พาร์ทเนอร์ด้านข้อมูลที่ได้ดำเนินกระบวนการจับคู่มาแล้วจะสามารถใช้ ID พาร์ทเนอร์เป็น ID เนมสเปซและ extern_id เป็น tpid ของคุณได้

ระบุเฉพาะ match_keys เท่านั้น

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

ระบุทั้ง match_keys และ extern_id

เราใช้ match_keys เพื่อพยายามค้นหาผู้คนบน Meta และส่งต่อการจับคู่จาก {dataset_id, extern_id} ไปยัง {facebook_user_id} หากคุณระบุ match_keys และ extern_id คุณจะไม่สามารถระบุ namespace_id ไปด้วยได้

ระบุเฉพาะ extern_id เท่านั้น

หากคุณส่งข้อมูลที่มี match_keys และ extern_id แล้ว Meta จะใช้ {dataset_id, extern_id} เพื่อเรียกดู {facebook_user_id}

ระบุ namespace_id

พารามิเตอร์ namespace_id จะใช้กับการเรียกใช้ API ทั้งหมด คุณสามารถใช้พารามิเตอร์นี้เพื่ออ้างอิงถึงชุดเหตุการณ์แบบออฟไลน์อื่นที่ธุรกิจหรือ ID โปรไฟล์พาร์ทเนอร์สามารถเข้าถึงได้หรือเป็นเจ้าของ หากคุณส่งข้อมูลที่มี match_keys และ extern_id แล้ว Meta จะใช้ {namespace_id, extern_id} เพื่อเรียกดู {facebook_user_id} คุณควรระบุ extern_id เพียง 1 รายการต่อแถวข้อมูล 1 แถวเท่านั้น

ข้อมูลเชิงลึกและการระบุที่มา

ดูเหตุการณ์แบบออฟไลน์ที่ระบุที่มาไปยังโฆษณาที่มีผู้ดูหรือคลิก เราจะระบุที่มาให้กับคอนเวอร์ชั่นแบบออฟไลน์หลังผ่านไปมากกว่า 1 วัน ซึ่งหมายความว่าคุณจะต้องตั้งค่าช่วงการระบุที่มาเป็น 28d_view หรือ action_attribution_windows=['28d_view']' มิฉะนั้นคุณจะไม่เห็นคอนเวอร์ชั่นใดๆ ในรายงาน ดู API ข้อมูลเชิงลึกและคู่มือเกี่ยวกับข้อมูลเชิงลึก

GET /act_<ADACCOUNT_ID>/insights HTTP/1.1
Host: graph.facebook.com
curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/act_<ADACCOUNT_ID>/insights

พารามิเตอร์

พารามิเตอร์ คำอธิบาย

action_breakdowns

ประเภท: string[]

ข้อมูลแยกย่อยของอิมเพรสชั่น การคลิก หรือข้อมูลคอนเวอร์ชั่น แบ่งกลุ่มตามประเภทการดำเนินการ ได้แก่ ออฟไลน์ ออนไลน์ และอื่นๆ

ตัวอย่าง: ["action_type", "placement", "age", "gender", "country", "region"]

fields

ประเภท: string[]

เกณฑ์ชี้วัดโฆษณาพื้นฐาน

ตัวอย่าง: ["impressions", "clicks", "actions",]

level

ประเภท: สตริง

รวมหรือยกเลิกการทำซ้ำข้อมูลที่ระดับของผลลัพธ์การรายงานระดับนี้

ตัวอย่าง: ad หรือ adset หรือ campaign

date_preset

ประเภท: สตริง

ช่วงเวลาที่เกี่ยวข้องเพื่อสืบค้นเกณฑ์ชี้วัด

ตัวอย่าง: last_n_days (n = 7, 14, 28) หรือ yesterday หรือ today หรือ last_month หรือ lifetime

ผลลัพธ์จะมีลักษณะดังนี้:

{
  "data": [
    {
      "date_start": "2015-12-01",
      "date_stop": "2015-12-01",
      "actions": [
        {
          "action_type": "offline_conversion.purchase",
          "value": 1
        },
        {
          "action_type": "offsite_conversion.lead",
          "value": 3
        },
      ],
      ...
    }
  ]
}

ตัวอย่างเช่น วิธีดูการระบุที่มา:

curl -G \
  -d 'access_token=<SYSTEM_USER_ACCESS_TOKEN>' \
  -d 'fields=unique_actions,action_values' \
  https://graph.facebook.com/<API_VERSION>/act_<AD_ACCOUNT_ID>/insights

ผลลัพธ์จะมีลักษณะดังนี้

{
  "data": [
    {
      "unique_actions": [
        {
          "action_type": "link_click",
          "value": 94
        },
        {
          "action_type": "offline_conversion",
          "value": 1
        },
        {
          "action_type": "offline_conversion.purchase",
          "value": 1
        },
        {
....
          "value": 1
        }
      ],
      "action_values": [
        {
          "action_type": "offline_conversion.purchase",
          "value": 27.5
        },
        {
          "action_type": "offline_conversion",
          "value": 27.5
        }
      ],
      "date_start": "2016-06-06",
      "date_stop": "2016-06-07"
    }
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MAZDZD"
    }
  }
}

ตัวเลือกการประมวลผลข้อมูลสำหรับผู้ใช้ในสหรัฐฯ

สำหรับ API ทั้งสองนี้ ให้ใช้ตัวเลือกการประมวลผลข้อมูลด้วยการเพิ่ม data_processing_options, data_processing_options_country และ data_processing_options_state ในแต่ละเหตุการณ์ภายในพารามิเตอร์ข้อมูลของเหตุการณ์ของคุณ

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

หากต้องการไม่เปิดใช้งานการใช้ข้อมูลแบบจำกัด (LDU) อย่างชัดแจ้ง ให้ระบุอาร์เรย์ว่างสำหรับแต่ละเหตุการณ์หรือเพียงแค่ลบช่องในเพย์โหลดออก:

{
    "data": [
        {
            "event_name": "Purchase",
            "event_time": <EVENT_TIME>,
            "user_data": {
                "em": "<EMAIL>"
            },
            "custom_data": {
                "currency": "<CURRENCY>",
                "value": "<VALUE>"
            },
            "data_processing_options": []
        }
    ]
}

หากต้องการเปิดใช้งาน LDU และให้ Meta ทำการระบุตำแหน่งทางภูมิศาสตร์ ให้ใช้โค้ดต่อไปนี้

{
    "data": [
        {
            "event_name": "Purchase",
            "event_time": <EVENT_TIME>,
            "user_data": {
                "em": "<EMAIL>",
                "client_ip_address": "256.256.256.256"
            },
            "custom_data": {
                "currency": "<CURRENCY>",
                "value": "<VALUE>"
            },
            "data_processing_options": ["LDU"],
            "data_processing_options_country": 0,
            "data_processing_options_state": 0
        }
    ]
}

หากต้องการเปิดใช้งาน LDU และระบุตำแหน่งที่ตั้งด้วยตนเอง เช่น สำหรับรัฐแคลิฟอร์เนีย ให้ใช้โค้ดต่อไปนี้

{
    "data": [
        {
            "event_name": "Purchase",
            "event_time": <EVENT_TIME>,
            "user_data": {
                "em": "<EMAIL>"
            },
            "custom_data": {
                "currency": "<CURRENCY>",
                "value": "<VALUE>"
            },
            "data_processing_options": ["LDU"],
            "data_processing_options_country": 1,
            "data_processing_options_state": 1000
        }
    ]
}

UI การอัพโหลดด้วยตนเอง

API คอนเวอร์ชั่นแบบออฟไลน์มีตัวเลือกให้อัพโหลดเหตุการณ์ของคุณด้วยตนเองจากไฟล์ .csv ในกรณีนี้ ให้เพิ่มตัวเลือกการประมวลผลข้อมูล ประเทศที่ประมวลผลข้อมูล และรัฐที่ประมวลผลข้อมูลเป็นคอลัมน์ในไฟล์ของคุณ ดูข้อมูลเพิ่มเติมเกี่ยวกับเรื่องนี้ได้ในอินเทอร์เฟซผู้ใช้ของการอัพโหลด


เรียนรู้เพิ่มเติมเกี่ยวกับตัวเลือกการประมวลผลข้อมูล