Method: people.searchDirectoryPeople
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Fornece uma lista de perfis de domínio e contatos do domínio no diretório de domínio do usuário autenticado que corresponde à consulta de pesquisa.
Solicitação HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros |
query |
string
Obrigatório. Prefixo da consulta que corresponde aos campos na pessoa. NÃO usa o readMask para determinar quais campos serão correspondentes.
|
readMask |
string (FieldMask format)
Obrigatório. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separando-os com vírgulas. Os valores válidos são:
- addresses
- ageRanges
- biografias
- aniversários
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- eventos
- externalIds
- sexos
- imClients
- interesses
- locales
- locais
- dos canais
- metadados
- miscKeywords
- nomes
- apelidos
- ocupações
- organizations
- phoneNumbers
- fotos
- relações
- sipAddresses
- skills
- urls
- userDefined
|
sources[] |
enum (DirectorySourceType)
Obrigatório. Fontes de diretório a serem retornadas.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
Opcional. Dados adicionais a serem mesclados nas fontes de diretório se estiverem conectados por chaves de junção verificadas, como endereços de e-mail ou números de telefone.
|
pageSize |
integer
Opcional. O número de pessoas a serem incluídas na resposta. Os valores válidos estão entre 1 e 500, inclusive. O padrão é 100 se não for definido ou for definido como 0.
|
pageToken |
string
Opcional. Um token de página recebido de uma resposta nextPageToken Ao paginar, todos os outros parâmetros enviados para [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] precisam corresponder à primeira chamada que forneceu o token da página.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
A resposta a uma solicitação de pessoas no diretório de domínio do usuário autenticado que correspondem à consulta especificada.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Campos |
people[] |
object (Person)
A lista de pessoas no diretório do domínio que corresponde à consulta.
|
nextPageToken |
string
Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
|
totalSize |
integer
O número total de itens na lista sem paginação.
|
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/directory.readonly
Para mais informações, consulte o Guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-11-08 UTC.
[null,null,["Última atualização 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)."]]
