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 APIs プロトコルの基本を理解していることを前提としています。
UNIX オペレーティング システムを使用している場合、コードを記述せずにこのドキュメントのサンプルを試すには、UNIX コマンドライン ユーティリティ curl または wget を使用します。Google データサービスで cURL を使用する方法を学習する。
原則
このバージョンの Domain Shared Contacts API は、Google Data APIs の原則に準拠しています。Google Data API は、Atom パブリッシング プロトコルに加えて、Atom 1.0 と RSS 2.0 の両方のシンジケーション形式に基づいています。
バージョンを指定する
Domain Shared Contacts API を使用して送信するすべてのリクエストで、API のバージョン 3.0 を指定する必要があります。
GData-Version: 3.0
HTTP ヘッダーを設定できない場合は、URL のクエリ パラメータとして v=3.0 を指定できますが、HTTP ヘッダーを使用する方法をおすすめします。