Method: contactGroups.batchGet

연락처 그룹 리소스 이름 목록을 지정하여 인증된 사용자가 소유한 연락처 그룹 목록을 가져옵니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
resourceNames[]

string

필수 항목입니다. 가져올 연락처 그룹의 리소스 이름입니다.

리소스 이름은 최대 200개까지 허용됩니다.
maxMembers

integer

선택사항입니다. 각 그룹에 대해 반환할 최대 구성원 수를 지정합니다. 설정하지 않으면 기본값은 0으로, 멤버 0개를 반환합니다.
groupFields

string (FieldMask format)

선택사항입니다. 그룹에서 반환되는 필드를 제한하는 필드 마스크입니다. 설정하지 않거나 비워 둘 경우 기본값은 metadata, groupType, memberCount, name입니다. 유효한 필드는 다음과 같습니다.

  • clientData
  • groupType
  • memberCount
  • metadata
  • 이름

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

연락처 그룹 일괄 가져오기 요청에 대한 응답입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

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)

연락처 그룹입니다.