Method: people.listDirectoryPeople

Proporciona una lista de perfiles y contactos de dominio en el directorio de dominio del usuario autenticado.

Cuando se especifica syncToken, los recursos borrados desde la última sincronización se mostrarán como una persona con PersonMetadata.deleted establecido como verdadero.

Cuando se especifican los valores de pageToken o syncToken, todos los demás parámetros de solicitud deben coincidir con la primera llamada.

Las escrituras pueden tener un retraso de propagación de varios minutos para las solicitudes de sincronización. Las sincronizaciones incrementales no están diseñadas para casos de uso de lectura después de escritura.

Consulta un ejemplo de uso en Enumera el directorio en el que las personas que cambiaron.

Solicitud HTTP

GET https://people.googleapis.com/v1/people:listDirectoryPeople

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
readMask

string (FieldMask format)

Obligatorio. Es 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
  • profesiones
  • organizaciones
  • phoneNumbers
  • fotos
  • relaciones
  • sipAddresses
  • skills
  • url
  • userDefined
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

Opcional. Datos adicionales para combinar en las fuentes de directorio si están conectados 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 deben estar entre 1 y 1,000, inclusive. Si no se establece o se establece en 0, el valor predeterminado es 100.
pageToken

string

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

Durante la paginación, todos los demás parámetros proporcionados a people.listDirectoryPeople deben coincidir con la primera llamada que proporcionó el token de la página.
requestSyncToken

boolean

Opcional. Indica si la respuesta debe mostrar nextSyncToken. Se puede usar para obtener cambios incrementales desde la última solicitud configurándola en la solicitud syncToken.

Obtén más información sobre el comportamiento de sincronización en people.listDirectoryPeople.
syncToken

string

Opcional. Es un token de sincronización que se recibió de una respuesta anterior nextSyncToken. Proporciona esto para recuperar solo los recursos que cambiaron desde la última solicitud.

Durante la sincronización, todos los demás parámetros proporcionados a people.listDirectoryPeople deben coincidir con la primera llamada que proporcionó el token de sincronización.

Obtén más información sobre el comportamiento de sincronización en people.listDirectoryPeople.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta a una solicitud para el directorio de dominio del usuario autenticado.

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

Representación JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Campos
people[]

object (Person)

Es la lista de personas en el directorio del dominio.
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.
nextSyncToken

string

Es un token, que se puede enviar como syncToken para recuperar los cambios desde la última solicitud. La solicitud debe establecer requestSyncToken para que devuelva el token de sincronizació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.