Method: contactGroups.list

列出已驗證使用者擁有的所有聯絡人群組。系統不會填入聯絡人群組的成員。

HTTP 要求

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

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

查詢參數

參數
pageToken

string

選用設定。先前的呼叫 contactGroups.list 傳回的 nextPageToken 值。要求下一頁的資源。
pageSize

integer

選用設定。要傳回的資源數量上限。有效值介於 1 到 1000 (含首尾)。如未設定或設為 0，預設值為 30。
syncToken

string

選用設定。先前呼叫 contactgroups.list 傳回的同步權杖。系統只會傳回同步權杖建立後有所變更的資源。
groupFields

string (FieldMask format)

選用設定。欄位遮罩，用於限制傳回群組中的欄位。如未設定或設為空白，預設值為 metadata、groupType、memberCount 和 name。有效欄位如下：

  • clientData
  • groupType
  • memberCount
  • 中繼資料
  • 名稱

要求主體

要求主體必須為空白。

回應主體

聯絡人群組要求的回應。

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

JSON 表示法 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
欄位
contactGroups[]

object (ContactGroup)

聯絡人群組清單。系統不會填入聯絡人群組的成員。
totalItems

integer

清單中不含分頁的項目總數。
nextPageToken

string

可用來擷取下一頁結果的權杖。
nextSyncToken

string

此權杖可用來擷取自上次要求以來的變更。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。