Domain Shared Contacts API の概要

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 を使用して連絡先を管理する例について説明します。詳細については、クライアント ライブラリをご覧ください。

オーディエンス

このドキュメントは、HTTP と XML を使用して Google の連絡先リストを操作するクライアント アプリケーションを作成するデベロッパーを対象としています。Google Data APIs プロトコルの知識があることを前提としています。

Linux ユーザーと macOS ユーザーは、curl または wget を使用して、このドキュメントの例を試すことができます。Google Data APIs で curl を使用するをご覧ください。

原則

Domain Shared Contacts API は、Google Data APIs の原則に準拠しています。Google Data API は、Atom 1.0、RSS 2.0、Atom Publishing Protocol に基づいています。

バージョンを指定する

Domain Shared Contacts API を使用して送信されるすべてのリクエストで、バージョン 3.0 を指定する必要があります。

GData-Version: 3.0

HTTP ヘッダーを設定できない場合は、v=3.0 をクエリ パラメータとして指定します。HTTP ヘッダー メソッドをおすすめします。