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
자세한 내용은 승인 가이드를 참고하세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-11-08(UTC)
[null,null,["최종 업데이트: 2024-11-08(UTC)"],[[["\u003cp\u003eSearch for people in your domain directory using a prefix query that matches various person fields.\u003c/p\u003e\n"],["\u003cp\u003eCustomize the search by specifying fields to return, directory sources, and optional data merging.\u003c/p\u003e\n"],["\u003cp\u003eResults are paginated with controls for page size and retrieval of subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/directory.readonly\u003c/code\u003e scope for read access to the directory.\u003c/p\u003e\n"]]],["This describes how to search for people in a domain directory. Use a `GET` request to `https://people.googleapis.com/v1/people:searchDirectoryPeople`. Required query parameters include `query`, `readMask`, and `sources`. Optional parameters are `mergeSources`, `pageSize`, and `pageToken`. The request body is empty. The response contains a list of matching `people`, `nextPageToken` for pagination, and `totalSize`. Requires `directory.readonly` authorization scope.\n"],null,["# Method: people.searchDirectoryPeople\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchDirectoryPeopleResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.\n\n### HTTP request\n\n`GET https://people.googleapis.com/v1/people:searchDirectoryPeople`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. Prefix query that matches fields in the person. Does NOT use the readMask for determining what fields to match. |\n| `readMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: - addresses - ageRanges - biographies - birthdays - calendarUrls - clientData - coverPhotos - emailAddresses - events - externalIds - genders - imClients - interests - locales - locations - memberships - metadata - miscKeywords - names - nicknames - occupations - organizations - phoneNumbers - photos - relations - sipAddresses - skills - urls - userDefined |\n| `sources[]` | `enum (`[DirectorySourceType](/people/api/rest/v1/DirectorySourceType)`)` Required. Directory sources to return. |\n| `mergeSources[]` | `enum (`[DirectoryMergeSourceType](/people/api/rest/v1/DirectoryMergeSourceType)`)` Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. |\n| `pageSize` | `integer` Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0. |\n| `pageToken` | `string` Optional. A page token, received from a previous response [`nextPageToken`](/people/api/rest/v1/people/searchDirectoryPeople#body.SearchDirectoryPeopleResponse.FIELDS.next_page_token). Provide this to retrieve the subsequent page. When paginating, all other parameters provided to \\[`people.searchDirectoryPeople`\\]\\[google.people.v1.SearchDirectoryPeople\\] must match the first call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response to a request for people in the authenticated user's domain directory that match the specified query.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"people\": [ { object (/people/api/rest/v1/people#Person) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `people[]` | `object (`[Person](/people/api/rest/v1/people#Person)`)` The list of people in the domain directory that match the query. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n| `totalSize` | `integer` The total number of items in the list without pagination. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/directory.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
