인증된 사용자의 연락처 목록을 제공합니다.
동기화 토큰은 전체 동기화 후 7일이 지나면 만료됩니다. 만료된 동기화 토큰이 있는 요청에는 google.rpc.ErrorInfo 오류와 함께 'EXPIRED_SYNC_TOKEN'이라는 이유가 표시됩니다. 이러한 오류가 발생하면 클라이언트는
없이 전체 동기화를 요청해야 합니다.syncToken
전체 동기화 요청의 첫 번째 페이지에는 추가 할당량이 있습니다. 할당량을 초과하면 429 오류가 반환됩니다. 이 할당량은 고정되어 있으며 늘릴 수 없습니다.
가 지정되면 마지막 동기화 후 삭제된 리소스가 syncToken
가 true로 설정된 사용자로 반환됩니다.PersonMetadata.deleted
또는 pageToken
를 지정하면 다른 모든 요청 매개변수가 첫 번째 호출과 일치해야 합니다.syncToken
동기화 요청의 경우 쓰기가 적용되는 데 몇 분 정도 걸릴 수 있습니다. 증분 동기화는 쓰기 후 읽기 사용 사례에 적합하지 않습니다.
변경된 사용자의 연락처 목록 보기에서 사용 예를 확인하세요.
HTTP 요청
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
resourceName |
필수 항목입니다. 연결을 반환할 리소스 이름입니다. |
쿼리 매개변수
매개변수 | |
---|---|
pageToken |
선택사항. 이전 응답 페이지로 나눌 때 |
pageSize |
선택사항. 응답에 포함할 연결 수입니다. 유효한 값은 1에서 1, 000 사이입니다. 설정하지 않거나 0으로 설정하면 기본값은 100입니다. |
sortOrder |
선택사항. 연결을 정렬하는 순서입니다. 기본값은 |
requestSyncToken |
선택사항. 응답의 마지막 페이지에서 응답이
|
syncToken |
선택사항. 이전 응답에서 수신된 동기화 토큰입니다. 동기화할 때
|
requestMask |
선택사항. 지원 중단됨 (대신 사용자 필드의 하위 집합으로 결과를 제한하는 마스크입니다. |
personFields |
필수 항목입니다. 각 사용자가 반환되는 필드를 제한하는 필드 마스크입니다. 여러 필드를 쉼표로 구분하여 지정할 수 있습니다. 유효한 값은 다음과 같습니다.
|
sources[] |
선택사항. 반환할 소스 유형의 마스크입니다. 설정하지 않을 경우 기본값은 |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
인증된 사용자의 연결 요청에 대한 응답입니다.
JSON 표현 |
---|
{
"connections": [
{
object ( |
필드 | |
---|---|
connections[] |
요청자가 연결된 사용자의 목록입니다. |
nextPageToken |
다음 페이지를 검색하기 위해 |
nextSyncToken |
마지막 요청 이후 변경사항을 검색하기 위해 |
totalPeople |
지원 중단됨 (totalItems 사용). 페이지로 나누기 없이 목록에 있는 총 사용자 수입니다. |
totalItems |
페이지로 나누기가 없는 목록의 총 항목 수입니다. |
승인 범위
다음 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 |
성을 기준으로 사용자를 정렬합니다. |