Method: people.searchDirectoryPeople
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zawiera listę profili domen i kontaktów z domeny w katalogu domeny uwierzytelnionego użytkownika, które pasują do zapytania.
Żądanie HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
| Parametry |
query |
string
Wymagane. Prefiks zapytania, które pasuje do pól w osobie. Nie używa parametru readMask do określania, które pola mają być dopasowywane.
|
readMask |
string (FieldMask format)
Wymagane. Maska pola ograniczająca, które pola każdej osoby są zwracane. Można określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:
- adresy
- ageRanges
- biografie
- urodziny
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- wydarzenia
- externalIds
- płeć
- imClients
- zainteresowania
- locales
- lokalizacje
- kanału
- metadane
- miscKeywords
- nazwy
- pseudonimy,
- zawody
- organizacje
- phoneNumbers
- zdjęcia
- relacje
- sipAddresses
- umiejętności
- adresy
- userDefined
|
sources[] |
enum (DirectorySourceType)
Wymagane. Źródła katalogów do zwrócenia.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
Opcjonalnie: dodatkowe dane do scalenia z źródłami katalogu, jeśli są one połączone za pomocą zweryfikowanych kluczy łączenia, np. adresów e-mail lub numerów telefonów;
|
pageSize |
integer
Opcjonalnie: Liczba osób, które mają zostać uwzględnione w odpowiedzi. Prawidłowe wartości to od 1 do 500 włącznie. Jeśli nie zostanie ustawiony lub zostanie ustawiony na 0, domyślna wartość to 100.
|
pageToken |
string
Opcjonalnie: Token strony otrzymany z poprzedniej odpowiedzi nextPageToken Podczas dzielenia na strony wszystkie pozostałe parametry podane dla [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] muszą być zgodne z pierwszym wywołaniem, które dostarczyło token strony.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź na żądanie dotyczące osób w katalogu domeny uwierzytelnionego użytkownika, które pasują do określonego zapytania.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Pola |
people[] |
object (Person)
Lista osób w katalogu domeny, które pasują do zapytania.
|
nextPageToken |
string
token, który może być wysyłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.
|
totalSize |
integer
Łączna liczba elementów na liście bez podziału na strony.
|
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/directory.readonly
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-11-08 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
