ฟังก์ชันการทำงานนี้อยู่ระหว่างการพัฒนา Meta สามารถเปลี่ยนแปลงหรือลบฟังก์ชันการทำงานนี้ได้ตลอดเวลา
ส่วนขยายการแชร์สำหรับ Workplace อนุญาตให้ผู้ใช้แชร์ข้อมูลได้อย่างปลอดภัยและง่ายดายบน Workplace ด้วยแนวทางที่เคารพความเป็นส่วนตัวของเนื้อหาแหล่งที่มา
การรองรับส่วนขยายการแชร์ช่วยให้คุณมั่นใจได้ว่าเนื้อหาของคุณจะแสดงพรีวิวได้ถูกต้องบน Workplace รวมถึงช่วยให้ผู้ใช้สามารถลิงก์โฟลเดอร์กับกลุ่ม Workplace ของตน และนำเสนอเนื้อหาของคุณในช่องเขียนข้อความของกลุ่มบน Workplace ได้ จึงง่ายต่อการแชร์เนื้อหาที่สร้างขึ้นล่าสุดได้ทันทีในกลุ่ม
ผู้ใช้บน Workplace มักแชร์ลิงก์ไปยังแหล่งข้อมูลภายในของบริษัท ซึ่งควรจะมีผู้ใช้บางรายเท่านั้นที่ดูได้ กรณีนี้แตกต่างจาก Facebook ที่ผู้ใช้มักแชร์เนื้อหาสาธารณะ เช่น บทความข่าวหรือบล็อกโพสต์
Workplace จะต้องมีเมตาดาต้าบางรายการ เพื่อให้สามารถสร้างพรีวิวเนื้อหาส่วนตัวของบริษัทได้ ในฐานะผู้ให้บริการ คุณสามารถเลือกมอบเมตาดาต้าให้ผู้ชมปัจจุบันบน Workplace ได้ โดยขึ้นอยู่กับว่าผู้ชมได้รับอนุญาตให้ดูเนื้อหานั้นหรือไม่
เอกสารฉบับนี้อธิบายองค์ประกอบของการเปิดใช้งานส่วนขยายการแชร์ ซึ่งมี 3 องค์ประกอบหลัก ได้แก่
เอกสารฉบับนี้ยังอธิบายวิธีการกำหนดค่าแอพของคุณเพื่อเพิ่มการรองรับส่วนขยายการแชร์
ในการกำหนดค่าแอพให้รองรับส่วนขยายการแชร์ คุณจำเป็นต้องระบุ 3 ช่องต่อไปนี้
example.com
) จะครอบคลุมโดเมนย่อยด้วย (เช่น acme.example.com
)www.example.com/download?id=123
หรือ www.example.com/file/456
แต่ไม่รวม www.example.com/blog
คุณสามารถใช้ Regex เช่น \/(download?|file\/).+
/ ได้/.*/
)คุณควรตั้งค่าแอพของคุณให้สมัครรับข้อมูลหัวข้อ Webhook Link
และ preview
รวมถึงเปิดใช้งานสำหรับสิทธิ์การอนุญาตการขยายลิงก์
เนื่องจากฟีเจอร์นี้ยังเป็นฟีเจอร์เบต้า จึงยังไม่สามารถกำหนดค่าแอพของคุณผ่านแดชบอร์ดของผู้พัฒนาที่ developers.facebook.com ได้ในขณะนี้
โปรดติดต่อพาร์ทเนอร์ Meta ที่ได้รับมอบหมายของคุณเพื่อกำหนดค่าหรืออัพเดตช่องเหล่านี้
ฟีเจอร์หลักของส่วนขยายการแชร์นี้คือ การแสดงพรีวิวเนื้อหาของคุณอย่างถูกต้องบน Workplace ซึ่งรวมถึงการรองรับเมตาดาต้าพรีวิวที่ได้รับอนุญาตในรูปแบบที่ Workplace กำหนด ดังนั้น เมื่อมีการแชร์ URL เนื้อหาของคุณ Workplace จะสามารถดึงเมตาดาต้านั้นมาสร้างพรีวิวได้ กระบวนการนี้มักเรียกกันว่าการขยายลิงก์ (Link Unfurling)
แม้ว่า Meta จะสามารถรับเมตาดาต้าเพื่อขยาย URL สาธารณะผ่านโปรโตคอล Open Graph และครอว์เลอร์ Facebook ได้ แต่กระบวนการนี้ไม่สามารถดำเนินการกับ URL ส่วนตัว ซึ่งมีการแชร์ใน Workplace บ่อยครั้งกว่าได้ ดังนั้น เมื่อมีผู้ใช้แชร์ URL ส่วนตัวลงใน Workplace ระบบจะส่ง Webhook ไปยัง URL การเรียกกลับที่คุณกำหนด และคุณจะสามารถตอบกลับด้วยเพย์โหลดเมตาดาต้าที่อธิบาย URL ดังกล่าวสำหรับผู้ใช้ที่แชร์เพื่อแสดงพรีวิวลิงก์แทน
กระบวนการเดียวกันนี้จะเกิดขึ้นซ้ำกับผู้ใช้แต่ละรายที่ดู URL ที่แชร์บน Workplace ทำให้คุณสามารถควบคุมการมองเห็นพรีวิวตามผู้ใช้ได้
ในการเปิดใช้งานพรีวิวที่ได้รับอนุญาต คุณจำเป็นต้องกำหนดค่าแอพของคุณดังต่อไปนี้
มีหลายกรณีที่เราจะส่งคำขอไปยังผู้ให้บริการ ได้แก่
ในทุกกรณีที่ระบุข้างต้น ระบบจะส่ง Webhook เป็นคำขอ POST
ในรูปแบบต่อไปนี้
{ "object": "link", "entry": [ { "time": int, "changes": [ { "field": "preview", "value": { "community": { "id": string, }, "user": { "id": string, }, "link": string, } } ] } ] }
เพย์โหลดนี้ประกอบด้วยช่องต่อไปนี้
ชื่อช่อง | คำอธิบาย |
---|---|
| หัวข้อ Webhook ช่องนี้จะเป็น |
| รายการคำขอ จะเป็นรายการเดียวเสมอ |
| เวลาที่ส่งคำขอ |
| รายการการเปลี่ยนแปลงในคำขอนี้ จะเป็นรายการเดียวเสมอ |
| ช่อง Webhook ซึ่งจะเป็น |
| อ็อบเจ็กต์จริงที่มีบริบทของคำขอ |
| ชุมชนของผู้ใช้ที่เรียกใช้คำขอ |
| ผู้ใช้ที่เรียกใช้คำขอ |
| ลิงก์ที่ Workplace พยายามแสดงผล ซึ่งตรงกับโดเมนและ Regex ที่กำหนดค่าโดยแอพ |
POST /callback HTTP/1.1 Host: third-party.com Accept: application/json Content-Type: application/json User-Agent: Webhooks/1.0 (https://fb.me/webhooks) X-Hub-Signature: sha1=bf3102e52efd0fd4bd26277030aa180d7b5cf587 ... { "object": "link", "entry": [{ "time": 1501515097793, "changes": [{ "field": "preview", "value": { "community": { "id": "138169208138649" }, "user": { "id": "88575656148087" } "link": "https://company.third-party.com/document-about-this" } }] }] }
เมื่อคุณได้รับคำขอ Webhook คุณจะต้องมอบเพย์โหลดเมตาดาต้าในรูปแบบการตอบกลับที่กำหนด
{ "data": [ { "link": string, ?"canonical_link": string, ?"title": string, ?"description": string, ?"icon": string, ?"download_url": string, "privacy": 'organization' | 'accessible' | 'inaccessible', ?"type": 'document' | 'folder' | 'task' | 'link', ?"additional_data": [ { "title" => string, "format" => 'text' | 'date' | 'datetime' | 'user', "value" => string | number, ?"color" => 'blue' | 'green' | 'yellow' | orange' | 'red', }, ], } ], ?"linked_user": boolean }
เพย์โหลดนี้จะต้องมีช่องต่อไปนี้
ชื่อช่อง | คำอธิบาย |
---|---|
| คอลเลกชั่นรายการที่มีให้ผู้ใช้ ซึ่งอาจเว้นว่างได้หากแอพเลือกที่จะไม่ขยายลิงก์นี้สำหรับผู้ใช้รายนี้โดยเด็ดขาด |
| ช่องบูลีนที่ระบุว่าบุคคลที่สามรู้จักผู้ใช้หรือไม่ หากช่องนี้ตั้งค่าไว้เป็น |
| ลิงก์ระบุที่ไม่ซ้ำกันสำหรับรายการนี้ โดยต้องตรงกับลิงก์ในคำขอ |
| การนำเสนอ URL ที่เป็นที่ยอมรับของเนื้อหานี้ หากแตกต่างจากลิงก์ เนื้อหานี้จะเชื่อมโยงกับเนื้อหาที่เป็นที่ยอมรับเพื่อการสืบค้นการแชร์ที่เกี่ยวข้องได้ง่ายยิ่งขึ้น |
| ชื่อรายการนี้ซึ่งต้องมี ยกเว้นรายการที่ตั้งค่าความเป็นส่วนตัวเป็น "เข้าถึงไม่ได้" |
| คำอธิบายสั้นๆ ของรายการที่จะแสดงผลในพรีวิวที่สมบูรณ์ |
| องค์ประกอบของเนื้อหานี้สำหรับตำแหน่งที่ Workplace จะแสดงไอคอนของเนื้อหา โดยต้องเป็น URL ที่เข้าถึงได้แบบสาธารณะ องค์ประกอบควรเป็นสี่เหลี่ยมจัตุรัสขนาด 16px เพื่อผลลัพธ์ที่ดีที่สุด |
| URL ที่ Workplace สามารถดาวน์โหลดการนำเสนอรายการเป็น PDF เพื่อแปลงเป็นโพสต์รูปภาพ ช่องนี้จะใช้เฉพาะกับอ็อบเจ็กต์ประเภท |
| ระบุความเป็นส่วนตัวของอ็อบเจ็กต์ ซึ่งอาจเป็น |
| อาจเป็น |
| คอลเลกชั่นเมตาดาต้าที่จะแสดงผลในพรีวิวที่สมบูรณ์ ช่องนี้จะถูกข้ามไปหากเป็น |
HTTP/1.1 200 OK Content-Type: application/json X-Hub-Signature: sha1=b5a6f32f084100ae5b355174b9bb8398f5fbe983 ... { "data": [ { "link": "https://taaskly.herokuapp.com/task/4", "title": "Launch Workplace Integration for F8", "privacy": "organization", "type": "task", "additional_data": [ { "title": "Owner", "format": "user", "value": "319922278498384" }, { "title": "Created", "format": "datetime", "value": "2018-02-28T03:35:40.827Z" }, { "title": "Priority", "format": "text", "value": "high", "color": "red" } ] } ], "linked_user": true }
โหมดความเป็นส่วนตัวจะกำหนดการมองเห็น รวมถึงกำหนดว่าเราจะต้องขอการยืนยันตัวตนผู้ใช้สำหรับผู้ใช้ในปัจจุบันและผู้ใช้ในอนาคตหรือไม่
organization
: แสดงผลแก่ผู้ใช้ ไม่ต้องมีการยืนยันตัวตนผู้ใช้accessible
: แสดงผลแก่ผู้ใช้ปัจจุบัน แต่อาจต้องมีการจับคู่ข้อมูลระบุตัวตนผู้ใช้สำหรับผู้ใช้รายอื่นๆinaccessible
: ไม่แสดงผลแก่ผู้ใช้หากต้องการเพิ่มข้อมูลบนพรีวิวลิงก์ คุณสามารถส่งรายการข้อมูลเพิ่มเติมได้สูงสุด **3** รายการ รายการข้อมูลเพิ่มเติมประกอบด้วยชุดองค์ประกอบคีย์-ค่า แต่ค่าอาจมีรูปแบบต่างกัน
ปัจจุบันระบบรองรับทั้งหมด 4 รูปแบบ ได้แก่
text
: จะแสดงผลค่าตามจริง ค่าต้องเป็นสตริง ในรูปแบบนี้ ข้อมูลเพิ่มเติมยังสามารถมีพร็อพเพอร์ตี้ color
ซึ่งต้องเป็นค่าใดค่าหนึ่งจาก blue
, green
, yellow
, orange
หรือ red
หากมีค่าดังกล่าว ระบบจะแสดงผลค่าเป็นสีพื้นหลังdate
: จะแยกวิเคราะห์ค่าเป็นรูปแบบวันที่ ISO-8601 โดยไม่ระบุเวลา และแสดงผลโดยไม่มีการระบุเวลาdatetime
: จะแยกวิเคราะห์ค่าเป็นรูปแบบวันที่ ISO-8601 โดยระบุเวลาและโซนเวลา และแสดงผลโดยมีการระบุเวลาในโซนเวลาของผู้ใช้user
: จะแยกวิเคราะห์ค่าเป็น ID ผู้ใช้ และแสดงผลชื่อของผู้ใช้หากโหมดความเป็นส่วนตัวของเอกสารมีการระบุว่าเป็น organization
หรือ accessible
และมี URL สำหรับดาวน์โหลด เราจะส่งคำขอเพิ่มเติมเพื่อดาวน์โหลดข้อมูล
GET /download/super-fancy-document HTTP/1.1 Host: provider.com Accept: <some mime types> User-Agent: Webhooks/1.0 (https://fb.me/webhooks) X-Hub-Signature: sha1=bf3102e52efd0fd4bd26277030aa180d7b5cf587
จากนั้น Workplace จะนำไฟล์ดังกล่าวไปแปลงเป็นรูปภาพเพื่อสร้างโพสต์แบบหลายภาพจากไฟล์นั้น
อย่างที่เห็นข้างต้น การแสดงพรีวิวที่ได้รับอนุญาตต้องใช้การจับคู่ข้อมูลระบุตัวตนบางประเภท การจับคู่ข้อมูลระบุตัวตนจะควบคุมว่าผู้ใช้ Workplace มีสิทธิ์การอนุญาตสำหรับดูเนื้อหาที่แสดงพรีวิวหรือไม่ รวมถึงยืนยันว่าเป็นไปตามกฎการเข้าถึงเนื้อหาของคุณบน Workplace
รูปแบบที่เรียบง่ายที่สุดในการจับคู่ข้อมูลระบุตัวตนคือการจับคู่ทั้งองค์กร ซึ่งใช้เพียงสถานะการเป็นสมาชิกชุมชน Workplace เพื่ออนุญาตให้แสดงพรีวิวแก่ผู้ใช้บน Workplace กรณีดังกล่าวมีการใช้งานกันโดยทั่วไปเมื่อแสดงพรีวิวลิงก์ไปยังอินทราเน็ตที่ใช้กันทั้งบริษัท หรือบริการใดๆ ที่อ็อบเจ็กต์ทั้งหมด (หรืออย่างน้อยที่สุดก็คือ เมตาดาต้าของบริการ) ปรากฏให้เห็นทั้งบริษัท
เมื่อติดตั้งการผสานการทำงานของคุณบนชุมชน Workplace แล้ว คุณสามารถตรวจสอบ ID ชุมชนได้ผ่านทางตำแหน่งข้อมูล /community
โดยใช้โทเค็นการเข้าถึงที่ได้รับเมื่อทำการติดตั้ง คุณสามารถจัดเก็บ ID ชุมชนนี้ไว้กับโทเค็น และจับคู่กับตัวระบุผู้ใช้หรือองค์กรภายในบริการของคุณได้ ซึ่งจะเป็นการจับคู่ระหว่างชุมชน Workplace กับองค์กรในบริการของคุณ
จากนั้น เมื่อตอบกลับคำขอ Webhook พรีวิวที่ได้รับอนุญาต คุณจะสามารถตรวจสอบว่า ID ชุมชนของเพย์โหลด Webhook นั้นตรงกับ ID ชุมชนที่ลิงก์กับองค์กรหรือไม่ แล้วจึงตัดสินใจว่าปลอดภัยพอที่จะส่งคืนเพย์โหลดเมตาดาต้าหรือไม่ การระบุความเป็นส่วนตัวของเพย์โหลดเป็น ORGANIZATION ช่วยให้แน่ใจว่า เราจะไม่ต้องส่ง Webhook เพิ่มเติมให้ผู้ใช้แต่ละรายในชุมชน Workplace นั้น
หากจำเป็นต้องแบ่งระดับสิทธิ์การอนุญาตมากขึ้น คุณสามารถใช้การจับคู่รายผู้ใช้ ซึ่งช่วยให้คุณสามารถเลือกแสดงผลเมตาดาต้าแก่ผู้ชมแต่ละรายบน Workplace แยกกัน โดย Workplace จะส่ง ID ผู้ใช้ในแต่ละเพย์โหลด Webhook เพื่อขอพรีวิวที่ได้รับอนุญาต หากต้องการใช้การจับคู่รายผู้ใช้ คุณจะต้องทราบรายการข้อมูลผู้ใช้ในระบบของคุณที่จับคู่อยู่กับ ID ผู้ใช้ Workplace ที่ส่งมาในเพย์โหลด Webhook
หากคุณเพิ่งเคยเจอ ID ผู้ใช้ Workplace ดังกล่าวเป็นครั้งแรก คุณสามารถตอบกลับด้วยช่องบูลีน linked_user
ที่ตั้งค่าเป็น false
ได้ ระบบจะแจ้งให้ Workplace แสดงปุ่มเปิดใช้งานพรีวิว เพื่อแจ้งให้ผู้ใช้ลิงก์บัญชีของตน
เมื่อผู้ใช้กดปุ่มดังกล่าว Workplace จะเปิดกล่องโต้ตอบไปยังตำแหน่งข้อมูลการลิงก์บัญชีที่คุณกำหนด ซึ่งคุณสามารถตรวจสอบความถูกต้องของเซสชั่นผู้ใช้ในบริการของคุณได้ Workplace จะเปิด URL นี้ผ่านคำขอ POST และจะส่งต่อพารามิเตอร์คำขอที่ลงชื่อ ซึ่งประกอบด้วย ID ผู้ใช้ปัจจุบันและ ID ชุมชน
POST https://www.example.com/account_linking?redirect_uri=https%3A%2F%2Ffoxfabrics.facebook.com%2Flink_complete HTTP/1.1 Host: foxfabrics.third-party.com Origin: http://www.facebook.com Content-Type: application/x-www-form-urlencoded User-Agent: Mozilla/5.0 Gecko/20100101 Firefox/57.0 ... signed_request=238fsdfsd.oijdoifjsidf899
เพย์โหลดจะมีพารามิเตอร์ signed_request ที่มีข้อมูลเกี่ยวกับผู้ใช้รายนี้ คำขอดังกล่าวสามารถถอดรหัสได้ดังนี้
เพย์โหลดนี้ประกอบด้วยช่องต่อไปนี้
{ "algorithm": "HMAC-SHA256", "user_id": "88575656148087", "community_id": "138169208138649" }
ในตอนนี้ คุณจะมี ID ผู้ใช้ Workplace และ ID ชุมชน พร้อมเซสชั่นผู้ใช้ที่ได้รับการตรวจสอบแล้วในบริการของคุณ และจะสามารถบันทึก ID ใน Workplace ของผู้ใช้รายนี้ข้าง ID ผู้ใช้ในบริการของคุณได้ เมื่อดำเนินการเสร็จแล้ว คุณจะเปลี่ยนเส้นทางไปยัง URL ที่ปรากฏในคำขอเดิมเป็นพารามิเตอร์การสืบค้น redirect_uri
GET {$redirect_uri} HTTP/1.1 Host: foxfabrics.facebook.com User-Agent: Mozilla/5.0 Gecko/20100101 Firefox/57.0 Referer: https://www.example.com/account_linking ...
Workplace จะทราบว่าการจับคู่ข้อมูลระบุตัวตนเสร็จสมบูรณ์แล้ว และจะพยายามส่งคำขอเมตาดาต้าพรีวิวที่ได้รับอนุญาตอีกครั้ง ในครั้งนี้ คุณจะสามารถตอบกลับด้วย linked_user
ที่ตั้งค่าเป็น true
และมอบเมตาดาต้าที่ Workplace ต้องการได้
กระบวนการระหว่างกันทั้งหมดนี้จะเกิดขึ้นเพียงครั้งเดียวเมื่อมีผู้ใช้ที่ไม่รู้จักพยายามจะดูพรีวิวเนื้อหาเป็นครั้งแรก เมื่อจับคู่ข้อมูลระบุตัวตนเสร็จสมบูรณ์แล้ว พรีวิวต่อๆ มาจะไม่ต้องผ่านกระบวนการนี้
การแสดงพรีวิวที่ได้รับอนุญาตสำหรับลิงก์ที่ผู้ใช้แชร์ลงใน Workplace นั้นมีประสิทธิภาพอย่างเหลือเชื่ออยู่แล้ว แต่คุณสามารถทำให้ผู้ใช้แชร์เนื้อหาที่กำลังสร้างอยู่ในแอพของคุณได้ง่ายยิ่งขึ้นจาก Workplace โดยตรง ด้วยการรองรับส่วนขยายช่องเขียนข้อความ
หากการผสานการทำงานของคุณรองรับส่วนขยายช่องเขียนข้อความ คุณจะสามารถนำเสนอรายการเอกสารล่าสุดหรือเอกสารที่เกี่ยวข้องเมื่อผู้ใช้เริ่มเขียนโพสต์ในกลุ่ม Workplace ที่เปิดใช้งานฟีเจอร์นี้ และ Workplace จะแสดงรายการนั้นเพื่อให้ผู้ใช้สามารถแชร์ได้โดยไม่ต้องคัดลอก URL มาวาง อ็อบเจ็กต์การแชร์ที่ได้จะมีลักษณะเหมือนกับอ็อบเจ็กต์ที่ผู้ใช้แชร์ด้วยตนเอง ทั้งยังคำนึงถึงสิทธิ์การอนุญาตของฟังก์ชั่นพรีวิวที่ได้รับอนุญาต
ส่วนขยายช่องเขียนข้อความกำหนดให้ผู้ใช้ต้องจับคู่ข้อมูลระบุตัวตน เพื่อให้คุณสามารถแสดงรายการเอกสารที่ปรับให้เหมาะกับแต่ละบุคคลในช่องเขียนข้อความได้
แอพของคุณจะต้องมีการกำหนดค่าต่อไปนี้เพื่อรองรับส่วนขยายช่องเขียนข้อความ
link
และช่อง collection
เมื่อผู้ใช้ที่ลิงก์บัญชีแล้วเรียกใช้ส่วนขยายช่องเขียนข้อความของการผสานการทำงานของคุณ Workplace จะส่ง Webhook ไปดึงข้อมูลรายการเอกสารในรูปแบบต่อไปนี้
{ "object": "link", "entry": [ { "time": int, "changes": [ { "field": "collection", "value": { "community": { "id": string, }, "user": { "id": string, }, ?"link": string, } } ] } ] }
เพย์โหลดนี้ประกอบด้วยช่องต่อไปนี้
ชื่อช่อง | คำอธิบาย |
---|---|
| หัวข้อ Webhook ช่องนี้จะเป็น |
| รายการคำขอ จะเป็นรายการเดียวเสมอ |
| เวลาที่ส่งคำขอ |
| รายการการเปลี่ยนแปลงในคำขอนี้ จะเป็นรายการเดียวเสมอ |
| ช่อง Webhook ซึ่งจะเป็น |
| อ็อบเจ็กต์จริงที่มีบริบทของคำขอ |
| ชุมชนของผู้ใช้ที่เรียกใช้คำขอ |
| ผู้ใช้ที่เรียกใช้คำขอ |
| หากผู้ใช้ดูรายละเอียดในในโฟลเดอร์ ช่องนี้จะตั้งค่าไว้สำหรับคำขอที่ตามมา แต่จะไม่มีอยู่ในคำขอหลัก |
ตัวอย่าง
POST /callback HTTP/1.1 Host: third-party.com Accept: application/json Content-Type: application/json User-Agent: Webhooks/1.0 (https://fb.me/webhooks) X-Hub-Signature: sha1=bf3102e52efd0fd4bd26277030aa180d7b5cf587 ... { "object": "link", "entry": [{ "time": 1501515097793, "changes": [{ "field": "collection", "value": { "community": { "id": "138169208138649" }, "user": { "id": "88575656148087" } } }] }] }
ในการจัดการคำขอนี้ URL การเรียกกลับของคุณจะต้องตรวจสอบยืนยัน "X-Hub-Signature" แล้วตอบกลับด้วยชุดอ็อบเจ็กต์ที่จะแสดงในช่องเขียนข้อความในรูปแบบต่อไปนี้
{ "data": [ { "link": string, "title": string, ?"description": string, ?"icon": string, ?"download_url": string, "privacy": ORGANIZATION | ACCESSIBLE, "type": DOCUMENT | FOLDER | TASK | LINK, ?"additional_data": [ { "title" => string, "format" => 'text' | 'date' | 'datetime' | 'user', "value" => string | number, }, ], } ], ?"linked_user": boolean }
เพย์โหลดนี้จะต้องมีช่องต่อไปนี้
ชื่อช่อง | คำอธิบาย |
---|---|
| คอลเลกชั่นรายการที่พร้อมใช้งานสำหรับผู้ใช้ |
| ช่องบูลีนที่ระบุว่าบุคคลที่สามรู้จักผู้ใช้หรือไม่ หากช่องนี้ตั้งค่าไว้เป็น |
| ลิงก์ระบุที่ไม่ซ้ำกันสำหรับรายการนี้ |
| ชื่อรายการนี้ซึ่งต้องมี ยกเว้นรายการที่ตั้งค่าความเป็นส่วนตัวเป็น "เข้าถึงไม่ได้" |
| คำอธิบายสั้นๆ ของรายการที่จะแสดงผลในพรีวิวที่สมบูรณ์ |
| องค์ประกอบของเนื้อหานี้สำหรับตำแหน่งที่ Workplace จะแสดงไอคอนของเนื้อหา โดยต้องเป็น URL ที่เข้าถึงได้แบบสาธารณะ องค์ประกอบควรเป็นสี่เหลี่ยมจัตุรัสขนาด 16px เพื่อผลลัพธ์ที่ดีที่สุด |
| URL ที่ Workplace สามารถดาวน์โหลดการนำเสนอรายการเป็น PDF เพื่อแปลงเป็นโพสต์รูปภาพ ช่องนี้จะใช้เฉพาะกับอ็อบเจ็กต์ประเภท |
| ระบุความเป็นส่วนตัวของอ็อบเจ็กต์ ซึ่งอาจเป็น |
| อาจเป็น |
| คอลเลกชั่นเมตาดาต้าที่จะแสดงผลในพรีวิวที่สมบูรณ์ ช่องนี้จะถูกข้ามไปหากเป็น |
ตัวอย่าง
HTTP/1.1 200 OK Content-Type: application/json X-Hub-Signature: sha1=b5a6f32f084100ae5b355174b9bb8398f5fbe983 ... { "data": [ { "link": "https://company.third-party.com/document-A", "title": "Slides for Project A", "description": "Short summary of the slides.", "download_url": "https://company.provider.com/download/document-A", "privacy": "accessible", "type": "document" }, { "link": "https://company.third-party.com/folder-B", "title": "Folder B", "privacy": "public", "type": "folder", } ], "linked_user": true }