API รายชื่อติดต่อที่แชร์ของโดเมนช่วยให้แอปพลิเคชันของคุณรับและอัปเดตรายชื่อติดต่อภายนอกที่แชร์กับผู้ใช้ทุกคนในโดเมน Google Workspace รายชื่อติดต่อที่แชร์จะแสดงต่อผู้ใช้ทุกคนในโดเมน Google Workspace และบริการทั้งหมดของ Google มีสิทธิ์เข้าถึงรายชื่อติดต่อได้
แอปพลิเคชันของคุณสามารถใช้ Domain Shared Contacts API เพื่อสร้างรายชื่อติดต่อที่แชร์ แก้ไข หรือลบรายชื่อติดต่อที่แชร์ที่มีอยู่ รวมถึงค้นหารายชื่อติดต่อที่แชร์ซึ่งตรงกับเกณฑ์ที่เจาะจงได้
Domain Shared Contacts API ใช้ได้กับบัญชี Google Workspace เท่านั้น หากต้องการใช้ API ให้เปิดใช้ API รายชื่อติดต่อที่แชร์ของโดเมนในคอนโซลผู้ดูแลระบบ การเปลี่ยนแปลงรายชื่อติดต่อที่แชร์อาจใช้เวลาถึง 24 ชั่วโมงจึงจะแสดงในการเติมข้อความอัตโนมัติของอีเมลและโปรแกรมจัดการรายชื่อติดต่อ
นอกเหนือจากข้อมูลเบื้องต้นเกี่ยวกับความสามารถของ API รายชื่อติดต่อที่แชร์ของโดเมนแล้ว เอกสารนี้ยังให้ตัวอย่างเกี่ยวกับวิธีจัดการรายชื่อติดต่อโดยใช้ XML และ HTTP ด้วย หลังจากอ่านเอกสารนี้แล้ว ดูข้อมูลเพิ่มเติมเกี่ยวกับการโต้ตอบกับ API ได้โดยใช้ไลบรารีของไคลเอ็นต์
ผู้ชม
เอกสารนี้มีไว้สําหรับนักพัฒนาซอฟต์แวร์ที่ต้องการเขียนแอปพลิเคชันไคลเอ็นต์ซึ่งจัดการรายชื่อติดต่อของ Google ได้โดยใช้ HTTP และ XML เอกสารนี้จะถือว่าคุณเข้าใจข้อมูลพื้นฐานเกี่ยวกับโปรโตคอล Google Data API
หากคุณใช้ระบบปฏิบัติการ UNIX และต้องการลองใช้ตัวอย่างในเอกสารนี้โดยไม่เขียนโค้ด ให้ใช้ยูทิลิตีบรรทัดคําสั่ง UNIX curl หรือ wget ดูวิธีใช้ cURL กับบริการข้อมูลของ Google
หลักการ
Domain Shared Contacts API เวอร์ชันนี้เป็นไปตามหลักการของ Google Data API Google Data API อิงตามรูปแบบการเผยแพร่แบบ Atom 1.0 และ RSS 2.0 นอกเหนือจากโปรโตคอลการเผยแพร่ Atom
ระบุเวอร์ชัน
ทุกคําขอที่คุณส่งโดยใช้ Domain Shared Contacts API ควรระบุ API เวอร์ชัน 3.0 ดังนี้
GData-Version: 3.0
หากตั้งค่าส่วนหัว HTTP ไม่ได้ ให้ระบุ v=3.0 เป็นพารามิเตอร์การค้นหาใน URL แต่เราขอแนะนําให้ใช้วิธีการของส่วนหัว HTTP