Method: people.searchDirectoryPeople

Proporciona una lista de perfiles y contactos de dominio en el directorio del 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. Consulta del 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 que restringe los campos que se muestran de cada persona. Se pueden especificar varios campos separándolos con comas. Estos son los valores válidos:

  • addresses
  • ageRanges
  • biografías
  • cumpleaños
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventos
  • externalIds
  • Sexos
  • imClients
  • Intereses
  • locales
  • de ubicaciones
  • memberships
  • metadatos
  • miscKeywords
  • names
  • sobrenombres
  • profesiones
  • organizations
  • phoneNumbers
  • fotos
  • relaciones
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (DirectorySourceType)

Obligatorio. Fuentes del directorio que se mostrarán.
mergeSources[]

enum (DirectoryMergeSourceType)

Opcional. Datos adicionales que se combinarán en las fuentes del directorio si están conectadas mediante 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 deben estar entre 1 y 500, ambos inclusive. El valor predeterminado es 100 si no se configura o se establece en 0.
pageToken

string

Opcional. Un token de página, recibido de un nextPageToken de respuesta anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza 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

Es 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)

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 de la lista sin paginación.

Permisos 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.