Method: people.searchDirectoryPeople
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Stellt eine Liste der Domainprofile und Domainkontakte im Domainverzeichnis des authentifizierten Nutzers bereit, die mit der Suchanfrage übereinstimmen.
HTTP-Anfrage
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
| Parameter |
query |
string
Erforderlich. Präfixabfrage, die mit Feldern in der Person übereinstimmt. Die readMask wird NICHT verwendet, um zu bestimmen, welche Felder abgeglichen werden sollen.
|
readMask |
string (FieldMask format)
Erforderlich. Eine Feldmaske, um einzuschränken, welche Felder für jede Person zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:
- Adressen
- ageRanges
- Biografien
- Geburtstage
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- Veranstaltungen
- externalIds
- geschlechter
- imClients
- Interessen
- locales
- Standorte
- mitgliedschaft
- Metadaten
- miscKeywords
- Namen
- Aliasse
- Berufe
- Organisationen
- phoneNumbers
- Fotos
- Beziehungen
- sipAddresses
- skills
- URLs
- userDefined
|
sources[] |
enum (DirectorySourceType)
Erforderlich. Verzeichnisquellen, die zurückgegeben werden sollen.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
Optional. Zusätzliche Daten, die in den Verzeichnisquellen zusammengeführt werden sollen, wenn sie über bestätigte Join-Schlüssel wie E-Mail-Adressen oder Telefonnummern verbunden sind.
|
pageSize |
integer
Optional. Die Anzahl der Personen, die in die Antwort aufgenommen werden sollen. Gültige Werte liegen zwischen 1 und 500. Wenn kein Wert festgelegt ist oder der Wert 0 ist, wird der Standardwert 100 verwendet.
|
pageToken |
string
Optional. Ein Seitentoken, das von einer vorherigen Antwort nextPageToken Beim Paginieren müssen alle anderen für [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Die Antwort auf eine Anfrage nach Personen im Domainverzeichnis des authentifizierten Nutzers, die mit der angegebenen Suchanfrage übereinstimmen.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Felder |
people[] |
object (Person)
Die Liste der Personen im Domainverzeichnis, die der Abfrage entsprechen.
|
nextPageToken |
string
Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
|
totalSize |
integer
Die Gesamtzahl der Elemente in der Liste ohne Paginierung.
|
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/directory.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-11-08 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]
