Method: contactGroups.list

인증된 사용자가 소유한 모든 연락처 그룹을 나열합니다. 연락처 그룹의 회원이 채워지지 않습니다.

HTTP 요청

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

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

쿼리 매개변수

매개변수
pageToken

string

선택사항. 이전 contactGroups.list 호출에서 반환된 nextPageToken 값입니다. 리소스의 다음 페이지를 요청합니다.

pageSize

integer

선택사항. 반환할 최대 리소스 수입니다. 유효한 값은 1에서 1, 000 사이입니다. 설정하지 않거나 0으로 설정하면 기본값은 30입니다.

syncToken

string

선택사항. 이전 contactgroups.list 호출에서 반환된 동기화 토큰입니다. 동기화 토큰이 생성된 이후 변경된 리소스만 반환됩니다.

groupFields

string (FieldMask format)

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

  • 고객 데이터
  • 그룹 유형
  • 회원수
  • metadata
  • 이름

요청 본문

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

응답 본문

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

연락처 그룹 목록 요청에 대한 응답입니다.

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

자세한 내용은 승인 가이드를 참고하세요.