Method: people.searchDirectoryPeople

인증된 사용자의 도메인 디렉터리에서 검색어와 일치하는 도메인 프로필 및 도메인 연락처 목록을 제공합니다.

HTTP 요청

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

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

쿼리 매개변수

매개변수
query

string

필수 항목입니다. 사람의 필드와 일치하는 프리픽스 쿼리입니다. 일치할 필드를 결정하는 데 readMask를 사용하지 않습니다.
readMask

string (FieldMask format)

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

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

enum (DirectorySourceType)

필수 항목입니다. 반환할 디렉터리 소스입니다.
mergeSources[]

enum (DirectoryMergeSourceType)

선택사항입니다. 이메일 주소나 전화번호와 같은 확인된 조인 키를 통해 연결된 경우 디렉터리 소스에 병합할 추가 데이터입니다.
pageSize

integer

선택사항입니다. 응답에 포함할 사용자 수입니다. 유효한 값은 1 이상 500 이하입니다. 설정하지 않으면 기본값은 100이며, 0으로 설정됩니다.
pageToken

string

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

페이지로 나눌 때 [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] 에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 첫 번째 호출과 일치해야 합니다.

요청 본문

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

응답 본문

인증된 사용자의 도메인 디렉터리에 있는 사용자 중 지정된 검색어와 일치하는 사용자에 대한 요청에 대한 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

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

object (Person)

쿼리와 일치하는 도메인 디렉터리에 있는 사용자 목록입니다.
nextPageToken

string

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

integer

페이지로 나누지 않은 목록의 총 항목 수입니다.

승인 범위

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

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

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