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