People API では次のことができます。
- 認証済みユーザーの連絡先の読み取りと管理
- 認証済みユーザーの「その他の連絡先」を確認してコピーします
- 認証済みユーザーとその連絡先のプロファイル情報を読み取る
- ドメインのプロフィールと連絡先の読み取り
たとえば、認証済みのユーザー Jen のプライベート連絡先に Fabian と Ranjith が含まれているとします。アプリが people.connections.list を呼び出して接続のリストを読み取ると、そのリストへのアクセス権をアプリに付与する同意画面が表示されます。Jen が同意すると、アプリは Fabian と Ranjith の person resources を含むリストを読み取ります。
アプリが特定のユーザーの情報を必要とする場合は、people.get を呼び出してリソース名を渡し、そのユーザーの person resource を取得できます。
また、people.createContact を使用して新しい連絡先を作成し、people.connections.list から読み取った既存の連絡先を people.updateContact を使用して更新し、people.deleteContact を使用して連絡先を削除します。
Google Workspace ユーザーは、people.listDirectoryPeople を使用してディレクトリ ドメインのプロファイルとドメインの連絡先を一覧表示することや、people.searchDirectoryPeople を使用してそれらを検索することもできます。
統合されたユーザービュー
People API が読み取る個人情報は、次の条件に応じてさまざまなソースから統合されます。
| ソース | 条件 |
|---|---|
| Google の一般公開プロフィール データ | 常に。 |
| Google Workspace ドメインのプロフィール データ | ドメイン管理者がドメイン スコープ データの外部連絡先とプロファイル共有を有効にして、directory.readonly スコープが付与されている |
| 認証されたユーザーの非公開プロフィール情報 | いずれかの profile スコープが付与されています。 |
| 認証されたユーザーの連絡先 | contacts スコープが付与されています。 |
統合された人物データについて
個人のデータは、1 つの主なソースタイプから取得されます。確認済みのソースが確認済みのメールアドレス、電話番号、プロフィール URL を介して接続されている場合、他のソースからデータはこのデータと統合されます。個人は次のように構成できます。
| メインソース | 連絡先 | プロフィール | Google Workspace ドメイン プロファイル | Google Workspace ドメインの連絡先 | 使用方法 |
|---|---|---|---|---|---|
| Contact | 1 | 0+ | 0+ | 0+ | ほとんどのエンドポイントに対して返される |
| プロフィール | 0+ | 1 | 0 または 1 | 0 | people.get で、ログイン ユーザーをユーザーから取得したり、別のユーザーの Google アカウントに関するユーザーを取得したりする場合に返されます。 |
| ドメインの連絡先 | 0+ | 0 | 0 | 1 | people.listDirectoryPeople または people.searchDirectoryPeople で返されます。 |
ミューテーション エンドポイントで変更できるのは連絡先ベースのユーザーのみです。プロファイルとドメインの連絡先のミューテーションはサポートされていません。