提供已驗證使用者的聯絡人清單。
同步憑證會在完整同步處理 7 天後失效。如果請求的同步處理憑證已過期,就會收到 google.rpc.ErrorInfo 錯誤訊息,原因為「EXPIRED_SYNC_TOKEN」。在這種情況下,用戶端應發出不含
的完整同步處理要求。syncToken
完整同步處理要求的第一頁有額外的配額。超過配額時,系統會傳回 429 錯誤。這項配額是固定的,無法增加。
指定
之後,如果從上次同步後刪除的資源將以 syncToken
的值設為 true,將傳回資源。PersonMetadata.deleted
指定
或 pageToken
時,所有其他要求參數都必須與第一個呼叫相符。syncToken
針對同步處理要求,寫入作業可能會延遲幾分鐘。漸進式同步處理不適用於寫入後的用途。
如需使用範例,請參閱列出已變更的聯絡人。
HTTP 要求
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
resourceName |
必要欄位。要傳回連線的資源名稱。只有 |
查詢參數
參數 | |
---|---|
pageToken |
選用,從先前回應 進行分頁時,提供給 |
pageSize |
選用,回應中包含的連線數。有效值介於 1 到 1000 (含首尾)。如未設定或設為 0,則預設值為 100。 |
sortOrder |
選用,連線的排序順序。預設值為 |
requestSyncToken |
選用,回應是否應在最後一頁傳回 如要進一步瞭解同步處理行為,請前往 |
syncToken |
選用,根據先前回應收到的同步處理權杖 同步處理時,提供給 如要進一步瞭解同步處理行為,請前往 |
requestMask |
選用,已淘汰 (請改用 可將結果限制為某個人欄位的遮罩。 |
personFields |
必要欄位。欄位遮罩,以限制每位使用者傳回哪些欄位。如要指定多個欄位,請以半形逗號加以分隔。以下為有效值:
|
sources[] |
選用,要傳回的來源類型遮罩。如果未設定,將預設為 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
對已驗證使用者連線要求的回應。
JSON 表示法 |
---|
{
"connections": [
{
object ( |
欄位 | |
---|---|
connections[] |
要求者所連線的使用者名單。 |
nextPageToken |
以 |
nextSyncToken |
這個符記可作為 |
totalPeople |
已淘汰 (請使用 totalItems) 清單中不含分頁的總人數。 |
totalItems |
清單中不含分頁的項目總數。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
詳情請參閱授權指南。
SortOrder
連線清單的排序順序。只有在您未要求同步時,才會使用這個選項。
列舉 | |
---|---|
LAST_MODIFIED_ASCENDING |
依變更時間排序使用者;先將較舊的項目排序。 |
LAST_MODIFIED_DESCENDING |
依變更時間排序使用者;先顯示較新的項目。 |
FIRST_NAME_ASCENDING |
依名字排序使用者。 |
LAST_NAME_ASCENDING |
依姓氏排序使用者。 |