API ข้อมูลเชิงลึกของการส่งข้อความ

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

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

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

หากต้องการดูเกณฑ์ชี้วัดสำหรับเพจ Facebook ที่คุณเป็นเจ้าของหรือสามารถดำเนินงาน ANALYZE บนเพจนั้นได้ แอพของคุณจำเป็นต้องมีสิ่งต่อไปนี้

  • ID ของเพจสำหรับเพจ Facebook ที่คุณต้องการดูเกณฑ์ชี้วัด
    • สำหรับการส่งข้อความบน Instagram ส่วนนี้จะเป็นเพจ Facebook ที่ลิงก์กับบัญชีมืออาชีพบน Instagram
  • โทเค็นการเข้าถึงเพจ
  • สิทธิ์การอนุญาตดังต่อไปนี้
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • สิทธิ์การเข้าถึงแบบมาตรฐาน

หากต้องการดูเกณฑ์ชี้วัดสำหรับเพจ Facebook ที่คุณไม่ได้เป็นเจ้าของหรือไม่สามารถดำเนินงาน ANALYZE บนเพจนั้นได้ แอพของคุณจำเป็นต้องมีสิ่งต่อไปนี้

  • ID ของเพจสำหรับเพจ Facebook ที่คุณต้องการดูเกณฑ์ชี้วัด
    • สำหรับการส่งข้อความบน Instagram ส่วนนี้จะเป็นเพจ Facebook ที่ลิงก์กับบัญชีมืออาชีพบน Instagram
  • โทเค็นการเข้าถึงเพจที่ส่งคำขอโดยผู้ใช้ที่สามารถดำเนินงาน ANALYZE บนเพจนั้นๆ ได้
  • สิทธิ์การอนุญาตต่อไปนี้ผ่านการเข้าสู่ระบบด้วย Facebook
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • สิทธิ์การเข้าถึงระดับสูง

ข้อจำกัด

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

อ่านเกณฑ์ชี้วัดของข้อมูลเชิงลึก

หากต้องการอ่านข้อมูลสำหรับเกณฑ์ชี้วัดตั้งแต่ 1 รายการขึ้นไป ให้ส่งคำขอ GET ไปยังตำแหน่งข้อมูล /PAGE-ID/insights โดยตั้งค่าพารามิเตอร์ metric เป็นรายการเกณฑ์ชี้วัดที่คุณต้องการดูซึ่งคั่นด้วยเครื่องหมายจุลภาค

ตัวอย่างคำขอ

มีการจัดรูปแบบเพื่อให้อ่านได้ง่าย
curl -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights
    ?metric=page_messages_new_conversations_unique,page_messages_blocked_conversations_unique 
    &access_token=PAGE-ACCESS-TOKEN"

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

{ 
  "data": [ 
    { 
      "name": "page_messages_new_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "42", 
          "end_time": "1665175977" 
        }, 
      ]
    },
    { 
      "name": "page_messages_blocked_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "0", 
          "end_time": "1665175977" 
        }, 
      ]
    } 
  ],
}

ตัวอย่างคำขอ Total Over Range

ตัวอย่างต่อไปนี้จะค้นหาจำนวนรวมของการสนทนาใหม่ที่ไม่ซ้ำกันในช่วงระยะเวลาหนึ่ง โดยใส่พารามิเตอร์ period ซึ่งตั้งค่าเป็น total_over_range โดยมีการกำหนดช่วงเวลาด้วยพารามิเตอร์ since และ until ในการเรียกใช้ API ของเรา

มีการจัดรูปแบบเพื่อให้อ่านได้ง่าย
curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=page_messages_new_conversations_unique
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &access_token=PAGE-ACCESS-TOKEN"

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

{
  "data": [
    {
      "name": "page_messages_new_conversations_unique",
      "period": "total_over_range",
      "values": [
        {
          "value": 27
          "end_time": "1665175977"
        }
      ],
    }
  ]
}

ตัวอย่างคำขอ Breakdown

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

curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=recurring_notifications_tokens   
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &breakdown=recurring_notifications_topic,recurring_notifications_frequency 
    &access_token=PAGE-ACCESS-TOKEN"

เมื่อดำเนินการสำเร็จ แอพของคุณจะได้รับการตอบกลับแบบ JSON ดังต่อไปนี้ โดยมีการจัดกลุ่มโทเค็นตามหัวข้อ ได้แก่ "newproducts" และ "10percentsale" ส่วนความถี่ของข้อความที่เปิดให้แต่ละหัวข้อใช้งานได้ ได้แก่ "daily" "weekly" และ "monthly" สำหรับ "newproducts" และ "daily" และ "weekly" สำหรับ "10percentsale"

{
  "data": [
    {
      "name": "recurring_notifications_tokens",
      "period": "total_over_range",
      "values": [ 
        {
          "value": 3,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 15,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "weekly"
        },
        {
          "value": 8,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "monthly"
        },
        {
          "value": 17,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 14,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "weekly"
        },
      ]
    }
  ]
}

พารามิเตอร์ข้อมูลเชิงลึก

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

breakdown

มิติที่ใช้จัดกลุ่มการตอบกลับ โดยอาจเป็นรายการต่อไปนี้ตั้งแต่ 1 รายการขึ้นไป

ชื่อคำอธิบาย

campaign_id

ดูข้อมูลของคุณตามหมายเลข ID แคมเปญ ตัวอย่าง เช่น "abc123", "Summer messaging campaign" และ "Spring sale 2"

engagement_source

ดูข้อมูลของคุณตามประเภทการมีส่วนร่วมกับข้อความทางการตลาด ตัวอย่าง เช่น ID CTA หลักและรอง (CTA ที่มีการคลิก)

message_type

ดูข้อมูลของคุณตามประเภทข้อความที่ธุรกิจของคุณส่ง ตัวอย่าง เช่น ข้อความทางการตลาด

messaging_channel

ดูข้อมูลของคุณตามช่องทางที่ใช้ส่งข้อความถึงผู้ใช้ ตัวอย่าง เช่น Messenger และ Instagram

recurring_notifications_entry_point

ดูข้อมูลของคุณตามจุดเข้าใช้งานข้อความทางการตลาด ตัวอย่าง เช่น ในเธรด, ปลั๊กอินแชท, โฆษณาแบบ CTM, ปลั๊กอินกล่องกาเครื่องหมาย, ลิงก์ m.me หรือ ig.me และเพจ Facebook

recurring_notifications_frequency

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

recurring_notifications_topic

ดูข้อมูลของคุณตามหัวข้อของข้อความทางการตลาด ตัวอย่าง เช่น ข้อความส่งเสริมการขาย การเปิดตัวสินค้า และดีล

date_preset

ช่วงวันที่สัมพัทธ์ซึ่งสามารถใช้แทน since และ until ได้ อาจเป็น last_week, last_month, last_quarter และอื่นๆ ดูค่าต่างๆ เพิ่มเติมในคู่มือข้อมูลเชิงลึกของเพจ

metric

จำเป็นต้องระบุรายการเกณฑ์ชี้วัดที่จะส่งคืนโดยคั่นด้วยเครื่องหมายจุลภาค

period

การรวมที่ให้ไว้ภายในช่วง since/until หรือ date_preset ค่า total_over_range จะให้ค่าเดียวสำหรับเกณฑ์ชี้วัดในช่วงวันที่ที่กำหนด อาจเป็น day, week, month, days_28 หรือ total_over_range

since

วันที่เริ่มต้นสำหรับช่วงวันที่ซึ่งคุณต้องการดูข้อมูล ทั้งนี้จะรวมข้อมูลสำหรับวันที่ที่ตั้งไว้ โดยเริ่มที่เวลา 0:00 น. รูปแบบของค่าคือ YYYY-MM-DD ค่า 2022-01-31 จะให้ข้อมูลตั้งแต่วันที่ 31 มกราคม 2022 ณ เวลา 0:00 น.

until

วันที่สิ้นสุดสำหรับช่วงวันที่ซึ่งคุณต้องการดูข้อมูล ทั้งนี้จะไม่รวมข้อมูลสำหรับวันที่ที่ตั้งไว้ โดยเริ่มที่เวลา 0:00 น. รูปแบบของค่าคือ YYYY-MM-DD ค่า 2022-02-01 จะให้ข้อมูลถึงวันที่ 31 มกราคม 2022 ณ เวลา 23:59 น.

เกณฑ์ชี้วัดที่พร้อมใช้งาน

เกณฑ์ชี้วัดต่อไปนี้สามารถใช้งานได้ผ่าน API ข้อมูลเชิงลึกของการส่งข้อความ

ชื่อ metricคำอธิบาย

page_messages_blocked_conversations_unique

จำนวนการสนทนากับเพจที่ถูกบล็อก

page_messages_engagement

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

ค่า breakdown ที่เป็นไปได้:

  • campaign_id
  • engagement_source
  • message_type
  • messaging_channel
  • recurring_notifications_topic

เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

page_messages_new_conversations_unique

จำนวนการสนทนาผ่านการส่งข้อความบน Messenger ที่เริ่มต้นจากบุคคลที่ไม่เคยส่งข้อความถึงธุรกิจของคุณมาก่อน

page_messages_order_count

จำนวนครั้งที่คุณสร้างคำสั่งซื้อในการสนทนาผ่านการส่งข้อความ หรือในแอพหรือเว็บไซต์จากภายนอกที่ใช้เพื่อจัดการการสนทนาผ่านการส่งข้อความ


เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

page_messages_paid_order_earnings

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


เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

page_messages_read_ratio

จำนวนข้อความทางการตลาดที่ถูกอ่านแล้ว หารด้วยจำนวนข้อความทางการตลาดที่เพจของคุณส่ง

ระบบอาจไม่ได้บันทึกการอ่านข้อความบางรายการ เช่น ในกรณีที่ลูกค้าปิดใบตอบรับการเปิดอ่านไว้

ค่า breakdown ที่เป็นไปได้:

  • campaign_id
  • message_type
  • messaging_channel
  • recurring_notifications_topic

เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

page_messages_reported_conversations_unique

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

page_messages_sent

จำนวนข้อความทางการตลาดที่เพจธุรกิจของคุณส่งไปหาลูกค้า


ค่า breakdown ที่เป็นไปได้:

  • campaign_id
  • messsage_type
  • messaging_channel
  • recurring_notifications_topic

เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

page_messages_total_messaging_connections

จำนวนผู้ใช้ที่ธุรกิจของคุณสามารถส่งข้อความไปถึงได้


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

page_messages_with_business_outcomes

จำนวนคนที่เชื่อมต่อกันทางข้อความที่สร้างคำสั่งซื้ออย่างน้อย 1 รายการ


เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

recurring_notifications_tokens

จำนวนครั้งที่บัญชีหนึ่งๆ สมัครรับข้อความทางการตลาดจากธุรกิจของคุณ หากบัญชีหนึ่งๆ สมัครรับข้อความหลายหัวข้อ ระบบจะนับการสมัครรับข้อความอีกครั้งสำหรับแต่ละหัวข้อ


วิธีคำนวณ คือ เกณฑ์ชี้วัดนี้จะนับจำนวนครั้งที่บัญชียินยอมรับข้อความประจำ ลบด้วยจำนวนครั้งที่บัญชียกเลิกการสมัครรับข้อความ


ค่า breakdown ที่เป็นไปได้:

  • messaging_channel
  • recurring_notifications_frequency
  • recurring_notifications_topic

เกณฑ์ชี้วัดนี้อยู่ระหว่างการพัฒนา

เรียนรู้เพิ่มเติมเกี่ยวกับเกณฑ์ชี้วัดที่อยู่ระหว่างการพัฒนา

คุณสมบัติการตอบกลับ

ระบบอาจส่งคืนข้อมูลต่อไปนี้ในการเรียกใช้ไปยัง API ข้อมูลเชิงลึก

คุณสมบัติ คำอธิบาย

data

อาร์เรย์ของอ็อบเจ็กต์

รายการอ็อบเจ็กต์เกณฑ์ชี้วัด

name
สตริง

ชื่อของเกณฑ์ชี้วัด

period
สตริง

ช่วงเวลาที่ข้อมูลมีการรายงาน

values
อาร์เรย์ของอ็อบเจ็กต์

รายการข้อมูลสำหรับเกณฑ์ชี้วัด

value
จำนวนเต็ม

จำนวนเกณฑ์ชี้วัดที่ร้องขอในระหว่างช่วงวันที่ที่ระบุไว้

end_time
ประทับเวลา Unix

ประทับเวลา UTC ของเวลาสิ้นสุดสำหรับเกณฑ์ชี้วัด