Method: otherContacts.list

모든 '기타 연락처', 즉 연락처 그룹에 없는 연락처를 나열합니다. '기타 연락처' 상호작용에서 자동으로 생성된 연락처입니다.

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

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

syncToken를 지정하면 마지막 동기화 이후에 삭제된 리소스는 PersonMetadata.deleted가 true로 설정된 사람으로 반환됩니다.

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

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

변경된 사용자의 다른 연락처 목록 표시에서 사용 예를 참고하세요.

HTTP 요청

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

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

쿼리 매개변수

매개변수
pageToken

string

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

페이지로 나눌 때 otherContacts.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 첫 번째 호출과 일치해야 합니다.
pageSize

integer

선택사항입니다. '기타 연락처' 수 선택합니다. 유효한 값은 1 이상 1000 이하입니다. 설정하지 않으면 기본값은 100이며, 0으로 설정됩니다.
requestSyncToken

boolean

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

otherContacts.list에서 동기화 동작에 관해 자세히 알아보세요.
syncToken

string

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

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

otherContacts.list에서 동기화 동작에 관해 자세히 알아보세요.
readMask

string (FieldMask format)

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

READ_SOURCE_TYPE_CONTACT가 사용되는 경우 유효한 값은 다음과 같습니다.

  • emailAddresses
  • 메타데이터
  • 이름
  • phoneNumbers
  • 사진

READ_SOURCE_TYPE_PROFILE이(가) 사용되는 경우 유효한 값은 다음과 같습니다.

  • 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_CONTACT를 지정하지 않고 READ_SOURCE_TYPE_PROFILE을 지정하는 것은 허용되지 않습니다.

요청 본문

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

응답 본문

인증된 사용자의 '기타 연락처' 요청에 대한 응답입니다.

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

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

object (Person)

'기타 연락처' 목록 Person 리소스로 반환됩니다. '기타 연락처' 제한된 필드 하위 집합을 지원합니다. 자세한 내용은 ListOtherContactsRequest.request_mask를 참조하세요.
nextPageToken

string

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

string

마지막 요청 이후의 변경사항을 가져오기 위해 syncToken로 전송할 수 있는 토큰 동기화 토큰을 반환하도록 요청에서 requestSyncToken를 설정해야 합니다.
totalSize

integer

페이지로 나누기를 사용하지 않은 목록의 다른 총 연락처 수입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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