Method: people.connections.list

인증된 사용자의 연락처 목록을 제공합니다.

동기화 토큰은 전체 동기화 후 7일이 지나면 만료됩니다. 동기화 토큰이 만료된 요청에는 'EXPIRED_SYNC_TOKEN'과 함께 google.rpc.ErrorInfo 오류가 발생합니다. 이러한 오류가 발생하면 클라이언트는 syncToken 없이 전체 동기화 요청을 실행해야 합니다.

전체 동기화 요청의 첫 번째 페이지에는 추가 할당량이 있습니다. 할당량이 초과되면 429 오류가 반환됩니다. 이 할당량은 고정되어 있으며 늘릴 수 없습니다.

syncToken가 지정되면 마지막 동기화 이후 삭제된 리소스가 PersonMetadata.deleted가 true로 설정된 사용자로 반환됩니다.

pageToken 또는 syncToken가 지정되면 다른 모든 요청 매개변수가 첫 번째 호출과 일치해야 합니다.

동기화 요청의 경우 쓰기에 몇 분의 적용 지연이 있을 수 있습니다. 증분 동기화는 쓰기 후 읽기 사용 사례에 적합하지 않습니다.

변경된 사용자의 연락처 나열에서 사용 예시를 참고하세요.

HTTP 요청

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

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

경로 매개변수

매개변수
resourceName
(deprecated)

string

필수 항목입니다. 연결을 반환할 리소스 이름입니다. people/me만 유효합니다.

쿼리 매개변수

매개변수
pageToken

string

선택사항입니다. 이전 응답 nextPageToken에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지로 나누는 경우, people.connections.list에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 첫 번째 호출과 일치해야 합니다.
pageSize

integer

선택사항입니다. 응답에 포함할 연결 수입니다. 유효한 값은 1 이상 1000 이하입니다. 설정하지 않거나 0으로 설정하면 기본값은 100입니다.
sortOrder

enum (SortOrder)

선택사항입니다. 연결이 정렬되어야 하는 순서입니다. 기본값은 LAST_MODIFIED_ASCENDING입니다.
requestSyncToken

boolean

선택사항입니다. 응답이 결과의 마지막 페이지에서 nextSyncToken를 반환해야 하는지 여부입니다. 요청 syncToken에서 설정하여 마지막 요청 이후의 증분 변경사항을 가져오는 데 사용할 수 있습니다.

동기화 동작에 관한 자세한 내용은 people.connections.list를 참고하세요.
syncToken

string

선택사항입니다. 이전 응답 nextSyncToken에서 수신된 동기화 토큰입니다. 이 토큰을 제공하면 마지막 요청 이후 변경된 리소스만 가져올 수 있습니다.

동기화할 때 people.connections.list에 제공된 다른 모든 매개변수는 동기화 토큰을 제공한 첫 번째 호출과 일치해야 합니다.

people.connections.list에서 동기화 동작에 관해 자세히 알아보세요.
requestMask
(deprecated)

object (RequestMask)

선택사항입니다. 지원 중단됨 (대신 personFields 사용)

결과를 사용자 필드의 하위 집합으로 제한하는 마스크입니다.
personFields

string (FieldMask format)

필수 항목입니다. 각 사용자의 어떤 필드가 반환되는지를 제한하는 필드 마스크입니다. 여러 필드를 쉼표로 구분하여 지정할 수 있습니다. 유효한 값은 다음과 같습니다.

  • addresses
  • ageRanges
  • 전기
  • 생일
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 이벤트
  • externalIds
  • 성별
  • imClients
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • 메타데이터
  • miscKeywords
  • 이름
  • 닉네임
  • 직업
  • organizations
  • phoneNumbers
  • 사진
  • 관계
  • sipAddresses
  • 기술
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

선택사항입니다. 반환할 소스 유형의 마스크입니다. 설정하지 않으면 기본값은 READ_SOURCE_TYPE_CONTACT 및 READ_SOURCE_TYPE_PROFILE입니다.

요청 본문

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

응답 본문

인증된 사용자의 연결 요청에 대한 응답입니다.

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

JSON 표현 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
필드
connections[]

object (Person)

요청자가 연결된 사용자 목록입니다.
nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.
nextSyncToken

string

마지막 요청 이후의 변경사항을 가져오기 위해 syncToken로 전송할 수 있는 토큰 요청은 동기화 토큰을 반환하도록 requestSyncToken를 설정해야 합니다. 응답에 페이지가 있는 경우 마지막 페이지에만 nextSyncToken가 포함됩니다.
totalPeople
(deprecated)

integer

지원 중단됨 (totalItems를 사용하세요.) 페이지로 나누기를 사용하지 않은 목록의 총 사용자 수입니다.
totalItems

integer

페이지로 나누기가 없는 목록의 총 항목 수입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

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

SortOrder

연결 목록을 정렬할 순서입니다. 동기화가 요청되지 않은 경우에만 사용됩니다.

열거형
LAST_MODIFIED_ASCENDING 변경된 시점을 기준으로 사용자를 정렬합니다(오래된 항목부터 먼저).
LAST_MODIFIED_DESCENDING 변경된 시점을 기준으로 사용자를 정렬합니다(최신 항목이 먼저 표시됨).
FIRST_NAME_ASCENDING 이름순으로 정렬합니다.
LAST_NAME_ASCENDING 성을 기준으로 사용자를 정렬합니다.