People API

提供個人資料和聯絡人相關資訊的存取權。

服務:People.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果應用程式需要使用您自己的程式庫來呼叫這項服務,請在提出 API 要求時使用下列資訊。

探索文件

探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件:

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://people.googleapis.com

REST 資源:v1.contactGroups

方法
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

方法
modify POST /v1/{resourceName=contactGroups/*}/members:modify
修改已驗證使用者所擁有的聯絡人群組成員。

REST 資源:v1.otherContacts

方法
copyOtherContactToMyContactsGroup POST /v1/{resourceName=otherContacts/*}:copyOtherContactToMyContactsGroup

將「其他聯絡人」複製到使用者「myContacts」群組中的新聯絡人

為同一位使用者變更要求時應依序傳送,以免延遲時間增加和故障。

list GET /v1/otherContacts
列出所有「其他聯絡人」,也就是不在聯絡人群組中的聯絡人。
search GET /v1/otherContacts:search
在已驗證使用者的其他聯絡人中,提供符合搜尋查詢的聯絡人清單。

REST 資源:v1.people

方法
batchCreateContacts POST /v1/people:batchCreateContacts

建立一批新聯絡人,然後傳回新聯絡人的 PersonResponses

為同一位使用者變更要求時應依序傳送,以免延遲時間增加和故障。

batchDeleteContacts POST /v1/people:batchDeleteContacts
刪除大量聯絡人。
batchUpdateContacts POST /v1/people:batchUpdateContacts
更新整批聯絡人,並將資源名稱對應表傳回更新聯絡人的 PersonResponses。
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

方法
list GET /v1/{resourceName=people/*}/connections
提供已驗證使用者的聯絡人清單。