Method: otherContacts.list

列出所有「其他聯絡人」，也就是未加入聯絡人群組的聯絡人。「其他聯絡人」通常是根據互動資料自動建立聯絡人。

同步權杖會在完整同步的 7 天後失效。同步權杖過期的要求會收到 google.rpc.ErrorInfo，原因為「EXPIRED_SYNC_TOKEN」。如果發生這類錯誤，用戶端不應在沒有 syncToken 的情況下提出完整的同步要求。

完整同步要求的第一頁會有額外配額。超過配額時，系統會傳回 429 錯誤。這項配額已修正，無法增加。

如果指定 syncToken，則 PersonMetadata.deleted 設為 true 的個人會傳回自上次同步處理以來刪除的資源。

如果指定 pageToken 或 syncToken，則所有其他要求參數都必須與第一個呼叫相符。

同步要求在寫入上可能會延遲幾分鐘。漸進式同步不適用於寫入後讀取的用途。

如需使用範例，請參閱「列出使用者的其他聯絡人已變更」一節。

HTTP 要求

GET https://people.googleapis.com/v1/otherContacts

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageToken

string

選用設定。屬於接收自前一個回應 nextPageToken 的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 otherContacts.list 的所有其他參數須與提供網頁權杖的第一個呼叫相符。
pageSize

integer

選用設定。「其他聯絡人」的人數您是否要加入回應中有效值介於 1 到 1000 (含首尾) 之間。如未設定或設為 0，預設值為 100。
requestSyncToken

boolean

選用設定。回應是否應在結果的最後一頁傳回 nextSyncToken。此函式可在要求 syncToken 上設定，以取得自上次要求以來的漸進式變更。

如要進一步瞭解同步處理行為，請前往 otherContacts.list。
syncToken

string

選用設定。從先前的回應接收的同步處理權杖nextSyncToken提供這項資訊，即可只擷取自上次要求後變更的資源。

同步處理時，提供給 otherContacts.list 的所有其他參數都必須與提供同步權杖的第一個呼叫相符。

如要進一步瞭解同步處理行為，請前往 otherContacts.list。
readMask

string (FieldMask format)

必要欄位。欄位遮罩可限制系統傳回每個人的哪些欄位。如要指定多個欄位，請以半形逗號分隔。哪些有效值有效，視所用的 ReadSourceType 而定。

如果使用 READ_SOURCE_TYPE_CONTACT，其有效值如下：

  • emailAddresses
  • 中繼資料
  • 名稱
  • phoneNumbers
  • 相片

如果使用 READ_SOURCE_TYPE_PROFILE，有效值如下：

  • addresses
  • ageRanges
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 位置
  • 會籍
  • 中繼資料
  • miscKeywords
  • 名稱
  • 暱稱
  • 職業
  • 機構組織
  • phoneNumbers
  • 相片
  • 關係
  • sipAddresses
  • skills
  • 網址
  • userDefined
sources[]

enum (ReadSourceType)

選用設定。指定要傳回哪些來源類型的遮罩。如未設定，預設為 READ_SOURCE_TYPE_CONTACT。

這個欄位可能的值如下：

如未指定 READ_SOURCE_TYPE_CONTACT，則不得指定 READ_SOURCE_TYPE_PROFILE。

要求主體

要求主體必須為空白。

回應主體

對已驗證使用者「其他聯絡人」的要求的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
欄位
otherContacts[]

object (Person)

「其他聯絡人」清單以 Person 資源的形式傳回「其他聯絡人」僅支援部分欄位詳情請參閱 ListOtherContactsRequest.request_mask。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。
nextSyncToken

string

可做為 syncToken 傳送的權杖，用來擷取自上次要求以來的變更。要求必須設定 requestSyncToken，才能傳回同步處理權杖。
totalSize

integer

清單中其他 (不含分頁) 的聯絡人總數。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/contacts.other.readonly

詳情請參閱授權指南。