Method: people.searchDirectoryPeople
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Proporciona una lista de perfiles de dominio y contactos de dominio en el directorio de dominio del usuario autenticado que coinciden con la búsqueda.
Solicitud HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
| Parámetros |
query |
string
Obligatorio. Es una consulta de prefijo que coincide con los campos de la persona. NO usa la readMask para determinar los campos que deben coincidir.
|
readMask |
string (FieldMask format)
Obligatorio. Una máscara de campo para restringir qué campos de cada persona se muestran. Para especificar varios campos, sepáralos con comas. Estos son los valores válidos:
- direcciones
- ageRanges
- biografías
- cumpleaños
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- eventos
- externalIds
- Sexos
- imClients
- Intereses
- locales
- ubicaciones
- memberships
- metadatos
- miscKeywords
- names
- sobrenombres
- ocupaciones
- organizaciones
- phoneNumbers
- fotos
- relaciones
- sipAddresses
- skills
- url
- userDefined
|
sources[] |
enum (DirectorySourceType)
Obligatorio. Son las fuentes de directorio que se mostrarán.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
Opcional. Datos adicionales que se deben combinar en las fuentes del directorio si están conectadas a través de claves de unión verificadas, como direcciones de correo electrónico o números de teléfono.
|
pageSize |
integer
Opcional. Es la cantidad de personas que se deben incluir en la respuesta. Los valores válidos están entre 1 y 500 inclusive. El valor predeterminado es 100 si no se establece o si se establece en 0.
|
pageToken |
string
Opcional. Es un token de página, recibido desde una respuesta nextPageToken Durante la paginación, todos los demás parámetros proporcionados a [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] deben coincidir con la primera llamada que proporcionó el token de la página.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
La respuesta a una solicitud de personas en el directorio del dominio del usuario autenticado que coinciden con la consulta especificada.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Campos |
people[] |
object (Person)
Es la lista de personas en el directorio del dominio que coinciden con la búsqueda.
|
nextPageToken |
string
Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.
|
totalSize |
integer
La cantidad total de elementos en la lista sin paginación.
|
Alcances de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/directory.readonly
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-11-08 (UTC)
[null,null,["Última actualización: 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)."]]
