เอกสารนี้นี้ได้รับการอัพเดตแล้ว
คำแปลเป็น ภาษาไทย ยังไม่เสร็จสมบูรณ์
ภาษาอังกฤษที่อัพเดต: 6 ต.ค. 2021

API คอลเลกชั่นชุดสินค้า

คุณสามารถใช้ API นี้เพื่อสร้างคอลเลกชั่นสำหรับใช้ในร้านค้าและเพิ่มเมตาดาต้าลงในชุดสินค้า เช่น รูปภาพหน้าปกและคำอธิบาย จากนั้นชุดสินค้าจะพร้อมใช้งานเป็นคอลเลกชั่นในตัวจัดการการค้าสำหรับปรับแต่งร้านค้าบน Facebook หรือ Instagram (มิฉะนั้นจะต้องสร้างคอลเลกชั่นด้วยตนเอง) คุณยังสามารถกรอก ID ร้านค้าเพื่อเผยแพร่ชุดสินค้าที่พร้อมใช้งานนั้นได้โดยตรง โดยสามารถดู ID ร้านค้าได้จาก API การค้า

เรียนรู้เพิ่มเติมเกี่ยวกับวิธีสร้างคอลเลกชั่นในตัวจัดการการค้าได้ที่ศูนย์ช่วยเหลือทางธุรกิจ

POST (สร้าง/อัพเดต API)

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

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

metadata

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

พารามิเตอร์หลักสำหรับบล็อกเมตาดาต้าของคอลเลกชั่น

publish_to_shops

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

พารามิเตอร์ที่ระบุ shop_id สำหรับสร้าง/อัพเดตชุดสินค้าและเผยแพร่ไปยังร้านค้าได้โดยตรง

ช่องเมตาดาต้า


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

cover_image_url

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

URL รูปภาพหน้าปกของคอลเลกชั่น

description

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

คำอธิบายชุดสินค้าที่แสดงให้ลูกค้าเห็น

external_url

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

URL คอลเลกชั่น URL นี้จะไม่แสดงให้ผู้บริโภคเห็น แต่จะเป็นค่าเริ่มต้นเมื่อสร้างโฆษณาที่โปรโมทชุดสินค้าของคุณ

ช่องเผยแพร่ไปยังร้านค้า

ช่อง publish_to_shops ยอมรับอาร์เรย์เว้นว่างหรืออาร์เรย์ที่มีพารามิเตอร์ตามที่ปรากฏในตัวอย่างด้านล่าง หากอาร์เรย์เว้นว่าง ชุดสินค้านั้นจะเลิกเผยแพร่ในทุกร้าน (หากเคยเผยแพร่ไว้ก่อนหน้านี้)


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

shop_id

shop_id จะปรากฏที่นี่และสามารถดูได้โดยใช้ API การค้า

ตัวอย่าง - เพย์โหลด

{ 
    "name": "Best sellers",
    "filter": {
      "retailer_id": {
        "is_any": [
          "pid1",
          "pid2"
        ]
      } 
    },
    "metadata": {
      "cover_image_url": "https://foo.com/image.jpg" (https://foo.com/image.jpg%E2%80%9D),
      "external_url": "https://foo.com/best-sellers",
      "description":"Our best selling products"
    }
  "publish_to_shops": [{"shop_id": "shop_id1"}, {"shop_id": "shop_id2"}]
}

สร้างชุดสินค้า

สร้างชุดสินค้าด้วยเมตาดาต้าคอลเลกชั่นที่ตรงกับ ID สินค้าที่เฉพาะเจาะจง:

curl \
  -F "name=Best Sellers" \
  -F "filter={'retailer_id': {'is_any': ['pid1', 'pid2']}}" 
  -F "metadata={'cover_image_url':'https://foo.com/image.jpg', 'external_url':'https://foo.com/best-sellers', 'description':'Our best selling products'}" \
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_CATALOG_ID/product_sets

อัพเดตชุดสินค้า

อัพเดตชุดสินค้าที่มีอยู่ด้วยเมตาดาต้าคอลเลกชั่นและเผยแพร่ไปยังร้านค้า:

curl \
  -F "name=Updated Best Sellers" \
  -F "metadata={'cover_image_url':'https://foo.com/image_updated.jpg', 'external_url':'https://foo.com/best-sellers-updated', 'description':'Our updated best selling products'}" \
  -F "publish_to_shops=[{'shop_id':'shop_id1'}, {'shop_id':'shop_id2'}]"
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_SET_ID

GET (API การอ่าน)

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

ช่องทั้งหมดไม่ใช่ช่องค่าเริ่มต้น และควรเรียกใช้เป็นพารามิเตอร์ช่องให้ชัดเจนใน API กราฟ

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

latest_metadata

ข้อมูลเมตาดาต้าล่าสุดที่ส่งไป อาจแตกต่างจาก live_metadata (เช่น หาก review_status เป็น REJECTED)

live_metadata

เมตาดาต้าปัจจุบันที่ใช้งานอยู่สำหรับชุดสินค้านี้

ช่องเมตาดาต้า


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

cover_image_url

URL รูปภาพหน้าปกของชุดสินค้าที่แสดงให้ลูกค้าเห็น

description

คำอธิบายชุดสินค้าที่แสดงให้ลูกค้าเห็น

external_url

URL คอลเลกชั่น URL นี้จะไม่แสดงให้ผู้บริโภคเห็น แต่จะเป็นค่าเริ่มต้นเมื่อสร้างโฆษณาที่โปรโมทชุดสินค้าของคุณ

integrity_review_status

สถานะการตรวจสอบความถูกต้องสมบูรณ์ อาจเป็น APPROVED, REJECTED หรือ PENDING

ตัวอย่าง - อ่านชุดสินค้าเพื่อดูว่าเมตาดาต้าใดที่ใช้งานอยู่:

curl -G \
  -d "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/<API_VERSION>/<PRODUCT_SET_ID>/?fields=id,name,latest_metadata{cover_image_url, description, review_status},live_metadata{cover_image_url, description, review_status}

การตอบกลับ:

{ 
    "id": 1234567890,
    "name": "Best sellers",
    "latest_metadata": {
        "cover_image_url": "https://foo.com/some_new_image.jpg" (https://foo.com/image.jpg%E2%80%9D),
        "description":"Our best selling products",
        "integrity_review_status": "REJECTED"
    },
    "live_metadata": {
        "cover_image_url": "https://foo.com/some_good_image.jpg", 
        "description":"Our best selling products",
        "integrity_review_status": "APPROVED"
    }
}

คำถามที่พบบ่อย

คำถาม: อัตราส่วนกว้างยาวขั้นต่ำของรูปภาพหน้าปกที่ระบบยอมรับคือเท่าไร

คำตอบ: รูปภาพต้องมีอัตราส่วนอย่างน้อย 600x600 (แม้จะไม่สามารถครอบตัดเพื่อแก้ไขได้ในอัตราส่วนนี้) หากคุณอัพโหลดรูปภาพในอัตราส่วน 800x800 ขึ้นไป ระบบจะเลือกอัตราส่วนกว้างยาวแบบสี่เหลี่ยมจัตุรัสเป็นค่าเริ่มต้น เพื่อผลลัพธ์ที่ดีที่สุด เราขอแนะนำให้ใช้อัตราส่วนกว้างยาว 1080x1080

คำถาม: ขนาดไฟล์สูงสุดของรูปภาพหน้าปกอยู่ที่เท่าไร

คำตอบ: ขนาดไฟล์สูงสุดคือ 8 MB

คำถาม: ระบบรองรับรูปภาพหน้าปกในรูปแบบไฟล์ใดบ้าง

คำตอบ: ระบบรองรับไฟล์ JPG และ PNG

คำถาม: คำอธิบายมีความยาวจำกัดหรือไม่

คำตอบ: คำอธิบายไม่มีการจำกัดความยาวขั้นต่ำ แต่จำกัดความยาวสูงสุดที่ 200 ตัวอักษร

คำถาม: ฉันจะเลิกเผยแพร่คอลเลกชั่น (ชุดสินค้า) จากร้านค้าได้อย่างไร

คำตอบ: คุณสามารถใช้ API การอัพเดตและลบช่อง shop_id ออกจากรายการ publish_to_shop ที่เคยเผยแพร่ หากระบุอาร์เรย์เว้นว่าง ([]) ชุดสินค้าจะเลิกเผยแพร่ในทุกร้านค้า