Method: users.list

Lista os usuários que podem ser acessados pelo usuário atual. Se dois usuários tiverem funções de usuário no mesmo parceiro ou anunciante, eles poderão acessar um ao outro.

Esse método tem requisitos de autenticação exclusivos. Leia os pré-requisitos no nosso guia "Como gerenciar usuários" antes de usar esse método.

O recurso "Testar este método" não funciona para esse método.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/users

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O valor precisa estar entre 1 e 200. Se não for especificado, 100 será usado como padrão.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da chamada anterior para o método users.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

Campo que classifica a lista. Os valores aceitáveis são:

  • displayName (padrão)

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente de um campo, um sufixo "desc" precisa ser adicionado ao nome dele. Por exemplo, displayName desc.
filter

string

Permite filtrar por campos do usuário.

Sintaxe aceita:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas pelo operador lógico AND.
  • Uma restrição tem o formato {field} {operator} {value}.
  • Os campos displayName e email precisam usar o operador HAS (:).
  • O campo lastLoginTime precisa usar o operador LESS THAN OR EQUAL TO (<=) ou GREATER THAN OR EQUAL TO (>=).
  • Todos os outros campos precisam usar o operador EQUALS (=).

Campos compatíveis:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: é o campo sintético de AssignedUserRole usado para filtrar. Identifica o tipo de entidade a que a função do usuário é atribuída. Os valores válidos são Partner e Advertiser.
  • assignedUserRole.parentPartnerId: é um campo sintético de AssignedUserRole usado para filtragem. Identifica o parceiro principal da entidade a que a função do usuário é atribuída.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (entrada no formato ISO 8601 ou YYYY-MM-DDTHH:MM:SSZ)

Exemplos:

  • O usuário com displayName contendo "foo": displayName:"foo"
  • O usuário com email contendo "bar": email:"bar"
  • Todos os usuários com funções padrão: assignedUserRole.userRole="STANDARD"
  • Todos os usuários com funções de usuário para o parceiro 123: assignedUserRole.partnerId="123"
  • Todos os usuários com funções de usuário para o anunciante 123: assignedUserRole.advertiserId="123"
  • Todos os usuários com funções de usuário no nível do parceiro: entityType="PARTNER"
  • Todos os usuários com funções de usuário para o parceiro 123 e os anunciantes do parceiro 123: parentPartnerId="123"
  • Todos os usuários que fizeram login pela última vez em ou após 2023-01-01T00:00:00Z (formato ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

O comprimento desse campo não pode exceder 500 caracteres.

Consulte nosso guia de filtragem de solicitações LIST para mais informações.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campos
users[]

object (User)

A lista de usuários.

Essa lista não será exibida se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente para o método users.list para recuperar a próxima página de resultados. Esse token não vai estar presente se não houver mais resultados a serem retornados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/display-video-user-management

Para mais informações, consulte OAuth 2.0 Overview.