列出所有「其他聯絡人」(即不是聯絡人群組中的聯絡人)。「其他聯絡人」通常是系統根據互動資料自動建立的聯絡人。
同步權杖會在完整同步後的 7 天後失效。同步處理權杖已過期的要求會收到錯誤訊息,並顯示 google.rpc.ErrorInfo,原因包括「EXPIRED_SYNC_TOKEN」。在這種情況下,用戶端應在不使用
的情況下提出完整的同步要求。syncToken
完整同步要求的第一頁會提供額外配額。如果超過配額,系統會傳回 429 錯誤。這項配額是固定的,無法增加。
指定
時,系統會將上次同步處理後刪除的資源傳回,做為 syncToken
設為 true 的使用者。PersonMetadata.deleted
指定
或 pageToken
時,所有其他要求參數都必須與第一個呼叫相符。syncToken
對於同步要求,寫入作業可能會產生幾分鐘的傳播延遲。增量同步處理不適用於寫入後的讀取用途,
如需使用情形範例,請參閱列出使用者其他已變更的聯絡人。
HTTP 要求
GET https://people.googleapis.com/v1/otherContacts
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
pageToken |
選用設定。接收自先前回應 進行分頁時,提供至 |
pageSize |
選用設定。要加入回應的「其他聯絡人」數量。有效值介於 1 到 1000 (含首尾)。如未設定或設為 0,預設值為 100。 |
requestSyncToken |
選用設定。回應是否應在結果的最後一頁傳回 如要進一步瞭解同步處理行為,請前往 |
syncToken |
選用設定。從先前回應收到的同步處理權杖 執行同步處理作業時,提供給 如要進一步瞭解同步處理行為,請前往 |
readMask |
必要欄位。欄位遮罩,用於限制傳回每個人上的欄位。如要指定多個欄位,請用半形逗號分隔。有效的值取決於使用的 ReadSourceType。 如果使用 READ_SOURCE_TYPE_CONTACT,有效值如下:
如果使用 READ_SOURCE_TYPE_PROFILE,則有效值如下:
|
sources[] |
選用設定。要傳回哪些來源類型的遮罩。如未設定,預設值為 這個欄位可能的值如下: 不允許在未指定 |
要求主體
要求主體必須為空白。
回應主體
已驗證使用者「其他聯絡人」要求的回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"otherContacts": [
{
object ( |
欄位 | |
---|---|
otherContacts[] |
系統會以「個人」資源的形式傳回「其他聯絡人」清單。「其他聯絡人」僅支援部分欄位。詳情請參閱 ListOtherContactsRequest.request_mask。 |
nextPageToken |
可做為 |
nextSyncToken |
可做為 |
totalSize |
清單中其他不含分頁的聯絡人總數。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/contacts.other.readonly
詳情請參閱授權指南。