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 Data 服務使用 cURL。
原則
這個版本的 Domain Shared Contacts API 遵循 Google Data API 的原則。除了 Atom 發布通訊協定之外,Google Data API 也採用 Atom 1.0 和 RSS 2.0 聯合發布格式。
指定版本
凡是使用 Domain Shared Contacts API 傳送的每項要求,都必須指定 API 3.0 版:
GData-Version: 3.0
如果您無法設定 HTTP 標頭,可以在網址中指定 v=3.0
做為查詢參數,但我們建議您使用 HTTP 標頭方法。