Method: people.searchDirectoryPeople
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Предоставляет список профилей домена и контактов домена в каталоге домена прошедшего проверку подлинности пользователя, соответствующих поисковому запросу.
HTTP-запрос
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
| Параметры |
|---|
query | string Необходимый. Префиксный запрос, соответствующий полям человека. НЕ использует readMask для определения того, какие поля сопоставляться. |
readMask | string ( FieldMask format) Необходимый. Маска поля, позволяющая ограничить возвращаемые поля для каждого человека. Можно указать несколько полей, разделив их запятыми. Допустимые значения: - адреса
- ВозрастДиапазоны
- биографии
- дни рождения
- календарные URL-адреса
- данные клиента
- обложкаФотографии
- электронная почтаАдреса
- события
- внешние идентификаторы
- полы
- imClients
- интересы
- локали
- локации
- членство
- метаданные
- РазноеКлючевые слова
- имена
- прозвища
- занятия
- организации
- ТелефонНомера
- фотографии
- отношения
- sipАдреса
- навыки
- URL-адреса
- определяемый пользователем
|
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 "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2024-11-14 UTC.
[null,null,["Последнее обновление: 2024-11-14 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)."]]
