Method: contactGroups.batchGet

連絡先グループのリソース名のリストを指定して、認証されたユーザーが所有する連絡先グループのリストを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
resourceNames[]

string

必須。取得する連絡先グループのリソース名。

リソース名の最大数は 200 です。
maxMembers

integer

省略可。各グループについて返されるメンバーの最大数を指定します。設定しない場合のデフォルトは 0 で、0 人のメンバーが返されます。
groupFields

string (FieldMask format)

省略可。グループで返されるフィールドを制限するフィールド マスク。未設定または空に設定した場合のデフォルトは、metadata、groupType、memberCount、name です。有効なフィールドは次のとおりです。

  • clientData
  • groupType
  • memberCount
  • メタデータ
  • name

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

連絡先グループの一括取得リクエストに対するレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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)

連絡先グループ。