Method: contactGroups.batchGet

指定聯絡人群組資源名稱清單，取得已驗證使用者擁有的聯絡人群組清單。

HTTP 要求

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

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

查詢參數

參數
resourceNames[]

string

必要欄位。要取得的聯絡人群組資源名稱。

最多只能有 200 個資源名稱。
maxMembers

integer

選用設定。指定每個群組要傳回的成員人數上限。如未設定，預設值為 0，且會傳回零個成員。
groupFields

string (FieldMask format)

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

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

要求主體

要求主體必須為空白。

回應主體

針對批次取得聯絡人群組要求的回應。

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

JSON 表示法 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
欄位
responses[]

object (ContactGroupResponse)

各個要求的聯絡人群組資源的回應清單。

授權範圍

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

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

詳情請參閱授權指南。

ContactGroupResponse

特定聯絡人群組的回應。

JSON 表示法 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
欄位
requestedResourceName

string

原始要求的資源名稱。
status

object (Status)

回應的狀態。
contactGroup

object (ContactGroup)

聯絡人群組。