Method: people.searchContacts

검색어와 일치하는 인증된 사용자의 그룹화된 연락처에 있는 연락처 목록을 제공합니다. 이 쿼리는 CONTACT 소스에 있는 연락처의 names, nickNames, emailAddresses, phoneNumbers, organizations 필드와 일치합니다.

중요: 검색하기 전에 클라이언트는 빈 쿼리와 함께 준비 요청을 보내 캐시를 업데이트해야 합니다. https://developers.google.com/people/v1/contacts#search_the_users_contacts를 참조하세요.

HTTP 요청

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

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

쿼리 매개변수

매개변수
query

string

필수 항목입니다. 요청에 대한 일반 텍스트 쿼리입니다. 쿼리는 사람에 있는 입력란의 접두사 구문을 일치시키는 데 사용됩니다. 예를 들어 이름이 'foo name'인 사람은 'f', 'fo', 'foo', 'foo n', 'nam' 등의 검색어와 일치하지만 'oo n'과는 일치하지 않습니다.
pageSize

integer

선택사항입니다. 반환할 결과 수입니다. 필드가 설정되지 않은 경우 기본값은 10이고 그렇지 않은 경우 0으로 설정됩니다. 30보다 큰 값은 30으로 제한됩니다.
readMask

string (FieldMask format)

필수 항목입니다. 각 개인에서 반환되는 필드를 제한하는 필드 마스크. 여러 입력란은 쉼표로 구분하여 지정할 수 있습니다. 유효한 값은 다음과 같습니다.

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

enum (ReadSourceType)

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

요청 본문

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

응답 본문

성공한 경우 응답 본문에 SearchResponse의 인스턴스가 포함됩니다.

승인 범위

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

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

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