รับ ID องค์ประกอบและโทเค็นการเข้าถึง

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

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

รวบรวมข้อมูล ID สำหรับตำแหน่งข้อมูล API และการกำหนดค่าธุรกิจ

วิธีดึงข้อมูลเหล่านั้นมีดังนี้

• Webhook - ต้องระบุสำหรับพาร์ทเนอร์แพลตฟอร์มทุกรายที่ต้องการมีรายชื่ออยู่ใน App Store
• API ตำแหน่งข้อมูลการติดตั้ง FBE - แนะนำสำหรับธุรกิจที่ดำเนินการโฮสต์ด้วยตนเอง

การสร้างผู้ใช้ระบบ

หลังจากผู้ใช้ติดตั้ง FBE แล้ว ส่วนขยายก็จะสร้างผู้ใช้ระบบที่เป็นพนักงานขึ้นมาในตัวจัดการธุรกิจของลูกค้า การตั้งชื่อสำหรับผู้ใช้ระบบใหม่นี้เป็นไปตามสกีมา {App Name} ผู้ใช้ระบบ (FBE)

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

ผู้ใช้ระบบรายนี้จะมีสิทธิ์การอนุญาตในองค์ประกอบ FBE ที่เกี่ยวข้องทั้งหมด โดยจะมีสิทธิ์ในการทำงานดังนี้

1. เพจ: 'MANAGE'
2. บัญชีโฆษณา: 'MANAGE'
3. แค็ตตาล็อก: 'MANAGE'
4. พิกเซล: 'EDIT'

ดึงข้อมูลโทเค็นผู้ใช้ระบบผ่าน API

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

curl -X POST \
  -F 'app_id={app_id}' \
  -F 'scope={permissions}' \ 
  -F 'access_token={access_token}' \
  -F 'fbe_external_business_id={fbe_external_business_id}' \
  https://graph.facebook.com/<API_VERSION>/<client_business_manager_id>/access_token

ในช่อง scope ให้ใช้สิทธิ์การอนุญาต manage_business_extension ทั้งนี้คุณอาจต้องใช้สิทธิ์การอนุญาต ads_management หรือ catalog_management ด้วย ขึ้นอยู่กับกรณีการใช้งาน

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

Webhook

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

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

ข้อกำหนดในการตั้งค่า

1. สร้างตำแหน่งข้อมูลบนเซิร์ฟเวอร์ที่มีการรักษาความปลอดภัย ซึ่งสามารถประมวลผลคำขอการตรวจสอบยืนยัน (GET) และการแจ้งเตือนเหตุการณ์ (POST) จาก Facebook ได้
2. กำหนดค่าการสมัครรับข้อมูล Webhooks ของ FBE ในแดชบอร์ดของแอพ:
   • ในส่วนส่วนขยาย Facebook Business ของแดชบอร์ดของแอพ ให้ไปที่แท็บตั้งค่า เลื่อนลงมาที่การ์ด Webhooks แล้วคลิกแก้ไข URL การเรียกกลับ
   • ป้อน URL ของตำแหน่งข้อมูลในช่อง URL การเรียกกลับ แล้วป้อนสตริงในช่องตรวจสอบยืนยันโทเค็น เราจะรวมสตริงนี้ไว้ในคำขอการตรวจสอบยืนยันทุกรายการ
   • เมื่อคุณคลิกที่ตรวจสอบยืนยันและบันทึก เราจะส่งคำขอการตรวจสอบยืนยันไปยังตำแหน่งข้อมูลของคุณ ซึ่งคุณต้องตรวจสอบความถูกต้อง
   • ระบบจะติดตาม Webhook ที่เป็น fbe_install โดยอัตโนมัติ การ์ดนี้ยังจะมีปุ่มเปิดปิดซึ่งใช้ปิดการติดตามได้หากต้องการ

วิธีแยกวิเคราะห์เหตุการณ์ Webhook

ในแต่ละครั้งที่ได้รับ Webhook การติดตั้ง แอพของคุณจะต้องดำเนินการต่อไปนี้

สำหรับการติดตั้งใหม่

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

สำหรับการติดตั้งที่มีอยู่แล้ว

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

การแยกวิเคราะห์ Webhook เมื่อมีการถอนการติดตั้ง

ดำเนินขั้นตอนต่อไปนี้เมื่อมีการถอนการติดตั้ง

1. ปิดใช้งานฟีเจอร์ที่แอพของคุณใช้สำหรับธุรกิจนี้
2. แจ้งให้ธุรกิจทราบเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่า

อะไรบ้างที่มากับเพย์โหลด Webhook

ช่องการตอบกลับ

ตัวอย่าง - เพย์โหลดที่มีช่อง onsite_commerce_eligible แบบบูลีน

{
  "data": [{
    "ad_account_id": "<ad_account_id>",
    "business_manager_id": "<business_manager_id>",
    "catalog_id": "<catalog_id>",
    "commerce_merchant_settings_id": "<commerce_merchant_settings_id>",
    "onsite_eligible": true,
    "profiles": [
      "<page_id>",
      "<instagram_profile_id>"
    ],
    "pages": [
      "<page_id>"
    ],
    "instagram_profiles": [
      "<instagram_profile_id>"
    ],
    "pixel_id": "<pixel_id>",
    "token_type": "<token_type>",
    "installed_features": [
        {
            "feature_instance_id": "<unique_id>",
            "feature_name" : string, 
            "feature_type": enum,
            "connected_assets": {
                "ad_account_id": "<ad_account_id>",
                "business_manager_id": "<business_manager_id>",
                "catalog_id": "<catalog_id>",
                "commerce_merchant_settings_id": "<commerce_merchant_settings_id>",
                "ig_profile_id": "<instagram_profile_id>"               
                "page_id": "<page_id>",
                "pixel_id": "<pixel_id>",
            },
            "additional_info": {
                            "onsite_commerce_eligible": bool
                        },
                        {
                        "shop_status": array
                        },
                        {
                        "shop_status_info": array
                        }
                }
         ]
    }]
}

API การติดตั้ง FBE

สำหรับธุรกิจที่ติดตั้ง FBE ไว้ คุณสามารถสืบค้นข้อมูลการติดตั้งพื้นฐาน (pixel_id และรายการโปรไฟล์ที่มี IG Business ID and/or Page ID) ได้โดยใช้ตำแหน่งข้อมูลต่อไปนี้

ตัวอย่าง

CURL -X GET 'https://graph.facebook.com/<API_VERSION>/fbe_business/fbe_installs?fbe_external_business_id=<fbe_external_business_id>&access_token=<access_token>'

การตอบกลับ

{
  "data": [{
    "token_type": "<token_type>"
    "installed_features": [
        {
            "feature_instance_id": "<unique_id>",
            “feature_name” : string, 
            "feature_type": enum,
            "connected_assets": {
                “ad_account_id”: "<ad_account_id>",
                “business_manager_id”: "<business_manager_id>",
                “catalog_id”: "<catalog_id>",
                “commerce_merchant_settings_id”: "<commerce_merchant_settings_id>",
                “ig_profile_id”: "<instagram_profile_id>"               
                "page_id": "<page_id>",
                "pixel_id": "<pixel_id>",
            },
            "additional_info": {
                            "onsite_commerce_eligible": bool
                        },
                        {
                        "shop_status": array
                        },
                        {
                        "shop_status_info": array
                        }
                }
         ]
    }]
}

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

การตอบกลับ API การกำหนดค่าฟีเจอร์

โมเดลนี้จะมี ID อินสแตนซ์ฟีเจอร์สำหรับแต่ละฟีเจอร์ และช่องที่ประกอบไปด้วยอาร์เรย์ฟีเจอร์ประเภทนั้นๆ ทั้งหมดที่ธุรกิจได้ติดตั้งไว้ (เช่น CTA หลายรายการบนเพจ)

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

รูปแบบนี้จะแตกต่างจาก API การติดตั้ง FBE เนื่องจากรูปแบบนี้จะให้ข้อมูลฟีเจอร์เพิ่มเติม นอกเหนือจากองค์ประกอบที่เชื่อมต่อ รวมถึงสถานะที่เปิดใช้งานและการปรับแต่งฟีเจอร์ที่เฉพาะเจาะจง หลังจากเรียกใช้ API การติดตั้ง FBE แล้ว ให้ใช้ API นี้หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับสถานะที่เปิดใช้งานหรือการกำหนดค่าของฟีเจอร์

อ่าน

คุณสามารถอ่านสถานะการกำหนดค่าฟีเจอร์ปัจจุบันของธุรกิจใดก็ได้ด้วยคำขอต่อไปนี้

CURL -X GET 
'https://graph.facebook.com/<API_VERSION>/fbe_business/?fbe_external_business_id=<fbe_external_business_id>&access_token=<access_token>'

อัพเดต

ในการอัพเดตฟีเจอร์ทั้งหมด ให้ใช้คำขอ POST ต่อไปนี้

CURL -i -X POST \   
  -F 'fbe_external_business_id=<fbe_external_business_id>' \
  -F 'business_config={business_config object}' \
  -F 'access_token=<access_token>' 
  "https://graph.facebook.com/<API_VERSION>/fbe_business"

การตอบกลับ

{
  "page_cta": {
     "feature_instance_id": id1,
     "enabled": true,
     "cta_button_text": "Book Now",
     "cta_button_url": "https://partner-site.com/foo-business1",
     "below_button_text": "Powered by FBE Partner"
  },
  "page_ctas": [
    {
        "feature_instance_id": id1,
        "enabled": true,
        "cta_button_text": "Book Now",
        "cta_button_url": "https://partner-site.com/foo-business1",
        "below_button_text": "Powered by FBE Partner"
    },
    {
        "feature_instance_id": id2,
        "enabled": true,
        "cta_button_text": "Book Now",
        "cta_button_url": "https://partner-site.com/foo-business2",
        "below_button_text": "Powered by FBE Partner"
    }
  ],
  “ig_cta”: {...}
  "ig_ctas": [{...}, {...}],
  “ads”: [
    {
      "feature_instance_id": id3,
      “enabled”: true,
    },
    {
      "feature_instance_id": id4,
      “enabled”: true,
    },
  ],
  ...
}

ขั้นตอนถัดไป

• กำหนดค่าฟีเจอร์ของธุรกิจ
• ส่งเหตุการณ์พิกเซล
• อัพเดตแค็ตตาล็อกของคุณ