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 の原則に準拠しています。Google Data API は、Atom Publishing Protocol に加えて、Atom 1.0 と RSS 2.0 のシンジケーション形式に基づいています。
バージョンを指定する
Domain Shared Contacts API を使用して送信するすべてのリクエストでは、API のバージョン 3.0 を指定する必要があります。
GData-Version: 3.0
HTTP ヘッダーを設定できない場合は、URL でクエリ パラメータとして v=3.0 を指定できますが、HTTP ヘッダーを使用することをおすすめします。