Method: people.listDirectoryPeople

Fornece uma lista de perfis de domínio e contatos do domínio no diretório de domínio do usuário autenticado.

Quando syncToken for especificado, os recursos excluídos desde a última sincronização serão retornados como uma pessoa com PersonMetadata.deleted definido como verdadeiro.

Quando pageToken ou syncToken é especificado, todos os outros parâmetros de solicitação precisam corresponder à primeira chamada.

As gravações podem ter um atraso de vários minutos na propagação das solicitações de sincronização. Sincronizações incrementais não são destinadas a casos de uso de leitura após gravação.

Veja um exemplo de uso em Listar o diretório que as pessoas alteraram.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
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 separados por vírgulas. Os valores válidos são:

  • addresses
  • ageRanges
  • biografias
  • aniversários
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • events
  • externalIds
  • sexos
  • imClients
  • interesses
  • locales
  • locais
  • dos canais
  • metadados
  • miscKeywords
  • names
  • apelidos
  • ocupações
  • organizations
  • phoneNumbers
  • fotos
  • relações
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (DirectorySourceType)

Obrigatório. Origens de diretório a serem retornadas.
mergeSources[]

enum (DirectoryMergeSourceType)

Opcional. Dados adicionais a serem mesclados nas origens do diretório se estiverem conectados por chaves de mesclagem 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 1.000, inclusive. O padrão será 100 se não for definido ou for definido como 0.
pageToken

string

Opcional. Um token de página, recebido de uma resposta nextPageToken anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para people.listDirectoryPeople precisam corresponder à primeira chamada que forneceu o token da página.
requestSyncToken

boolean

Opcional. Indica se a resposta precisa retornar nextSyncToken. Ele pode ser usado para receber mudanças incrementais desde a última solicitação, definindo-o na solicitação syncToken.

Mais detalhes sobre o comportamento de sincronização em people.listDirectoryPeople.
syncToken

string

Opcional. Um token de sincronização, recebido de uma resposta anterior. nextSyncToken Forneça isso para recuperar apenas os recursos alterados desde a última solicitação.

Ao sincronizar, todos os outros parâmetros fornecidos para people.listDirectoryPeople precisam corresponder à primeira chamada que forneceu o token de sincronização.

Mais detalhes sobre o comportamento de sincronização em people.listDirectoryPeople.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta a uma solicitação para o diretório de domínio do usuário autenticado.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Campos
people[]

object (Person)

A lista de pessoas no diretório do domínio.
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.
nextSyncToken

string

Um token, que pode ser enviado como syncToken para recuperar as mudanças desde a última solicitação. A solicitação precisa definir requestSyncToken para retornar o token de sincronizaçã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.