Domain Shared Contacts API 可讓您的應用程式取得及更新與 Google Workspace 網域中所有使用者共用的外部聯絡人。共用聯絡人可供 Google Workspace 網域的所有使用者查看,所有 Google 服務都能存取聯絡人清單。
應用程式可以使用 Domain Shared Contacts API 建立共用聯絡人、編輯或刪除現有的共用聯絡人,以及查詢符合特定條件的共用聯絡人。
Domain Shared Contacts API 僅適用於 Google Workspace 帳戶。如要使用 API,請在管理控制台中啟用 Domain Shared Contacts API。共用聯絡人的變更最多可能需要 24 小時才會在電子郵件地址自動完成功能和聯絡人管理員中生效。
除了提供 Domain Shared Contacts API 功能的背景資訊,這份文件也提供使用 XML 和 HTTP 管理聯絡人的範例。閱讀完這份文件後,您可以使用用戶端程式庫,進一步瞭解如何與 API 互動。
目標對象
本文件適用於想要編寫用戶端應用程式的開發人員,這些應用程式可透過 HTTP 和 XML 操控 Google 聯絡人名單。本文假設您已瞭解 Google Data API 通訊協定背後的基礎知識。
如果您使用的是 UNIX 作業系統,且想在不編寫任何程式碼的情況下嘗試本文件中的範例,請使用 UNIX 指令列公用程式 curl 或 wget。瞭解如何搭配 Google 資料服務使用 cURL。
原則
這個版本的 Domain Shared Contacts API 遵循 Google Data API 的相關原則。Google Data API 除了採用 Atom 發布協定外,也採用 Atom 1.0 和 RSS 2.0 聯合發布格式。
指定版本
您使用 Domain Shared Contacts API 傳送的每項要求都應指定 API 的 3.0 版:
GData-Version: 3.0
如果無法設定 HTTP 標頭,您可以將 v=3.0
指定為網址中的查詢參數,但我們建議使用 HTTP 標頭方法。