Method: people.searchDirectoryPeople

Proporciona una lista de los perfiles del dominio autenticados y los contactos del dominio que coinciden con la consulta de 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. Prefija la consulta que coincide con los campos de la persona. NO usa readMask para determinar con qué campos coincidir.
readMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran en cada persona. Se pueden especificar varios campos separándolos con comas. A continuación, se indican los valores válidos:

  • addresses
  • Rangos de edad
  • biografías
  • cumpleaños
  • URL de calendario
  • datosdelcliente
  • fotos de portada
  • Direcciones de correo electrónico
  • eventos
  • ID externos
  • Sexos
  • clientes potenciales
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • metadata
  • palabras clave varias
  • names
  • sobrenombres
  • profesiones
  • organizations
  • númerosdeteléfono
  • fotos
  • relaciones
  • direccionessip
  • skills
  • url
  • definido por el usuario
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

Opcional. Datos adicionales para combinar en las fuentes del directorio si están conectados 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 incluidos. El valor predeterminado es 100 si no se establece 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 realices 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

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Es la respuesta a una solicitud de personas que aparecen en el directorio del dominio del usuario autenticado que coincide con la consulta especificada.

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

Alcances de la 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.