People API

プロフィールと連絡先に関する情報へのアクセスを許可します。

サービス: people.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストを行う際に次の情報を使用します。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次の検索ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することがあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://people.googleapis.com

REST リソース: v1.contactGroups

Methods
batchGet GET /v1/contactGroups:batchGet
連絡先グループのリソース名のリストを指定して、認証されたユーザーが所有する連絡先グループのリストを取得します。
create POST /v1/contactGroups
認証されたユーザーが所有する新しい連絡先グループを作成します。
delete DELETE /v1/{resourceName=contactGroups/*}
連絡先グループのリソース名を指定して、認証されたユーザーが所有する既存の連絡先グループを削除します。
get GET /v1/{resourceName=contactGroups/*}
連絡先グループのリソース名を指定して、認証されたユーザーが所有する特定の連絡先グループを取得します。
list GET /v1/contactGroups
認証されたユーザーが所有するすべての連絡先グループを一覧表示します。
update PUT /v1/{contactGroup.resourceName=contactGroups/*}
認証されたユーザーが所有する既存の連絡先グループの名前を更新します。

REST リソース: v1.contactGroups.members

Methods
modify POST /v1/{resourceName=contactGroups/*}/members:modify
認証されたユーザーが所有する連絡先グループのメンバーを変更します。

REST リソース: v1.otherContacts

Methods
copyOtherContactToMyContactsGroup POST /v1/{resourceName=otherContacts/*}:copyOtherContactToMyContactsGroup

ユーザーの「myContacts」グループ内の新しい連絡先に「その他の連絡先」をコピーします

レイテンシとエラーの増大を避けるため、同じユーザーに対する変更リクエストは順番に送信する必要があります。
list GET /v1/otherContacts
[その他の連絡先]（連絡先グループに属していない連絡先）をすべて表示します。
search GET /v1/otherContacts:search
認証されたユーザーの他の連絡先のうち、検索クエリと一致する連絡先のリストを提供します。

REST リソース: v1.people

Methods
batchCreateContacts POST /v1/people:batchCreateContacts

新しい連絡先のバッチを作成し、新しい連絡先の PersonResponses を返します。

レイテンシとエラーの増大を避けるため、同じユーザーに対する変更リクエストは順番に送信する必要があります。
batchDeleteContacts POST /v1/people:batchDeleteContacts
複数の連絡先をまとめて削除します。
batchUpdateContacts POST /v1/people:batchUpdateContacts
一連の連絡先を更新し、更新された連絡先の PersonResponse にリソース名のマップを返します。
createContact POST /v1/people:createContact
新しい連絡先を作成し、その連絡先の人リソースを返します。
deleteContact DELETE /v1/{resourceName=people/*}:deleteContact
連絡先担当者を削除します。
deleteContactPhoto DELETE /v1/{resourceName=people/*}:deleteContactPhoto
連絡先の写真を削除します。
get GET /v1/{resourceName=people/*}
リソース名を指定して個人に関する情報を提供します。
getBatchGet GET /v1/people:batchGet
リクエストされたリソース名のリストを指定して、特定のユーザーのリストに関する情報を提供します。
listDirectoryPeople GET /v1/people:listDirectoryPeople
認証されたユーザーのドメイン ディレクトリ内にある、ドメイン プロフィールとドメインの連絡先のリストを提供します。
searchContacts GET /v1/people:searchContacts
認証されたユーザーのグループ化された連絡先のうち、検索クエリと一致する連絡先のリストを提供します。
searchDirectoryPeople GET /v1/people:searchDirectoryPeople
認証されたユーザーのドメイン ディレクトリ内にある、検索語句に一致するドメイン プロフィールとドメインの連絡先のリストを提供します。
updateContact PATCH /v1/{person.resourceName=people/*}:updateContact
既存の連絡先担当者の連絡先データを更新します。
updateContactPhoto PATCH /v1/{resourceName=people/*}:updateContactPhoto
連絡先の写真を更新します。

REST リソース: v1.people.connections

Methods
list GET /v1/{resourceName=people/*}/connections
認証されたユーザーの連絡先のリストを提供します。