Method: users.list

Muestra una lista de los usuarios a los que el usuario actual puede acceder. Si dos usuarios tienen roles de usuario en el mismo socio o anunciante, pueden acceder entre sí.

Este método tiene requisitos de autenticación únicos. Lee los requisitos previos en nuestra Guía de administración de usuarios antes de usar este método.

La función "Probar este método" no funciona para este método.

Solicitud HTTP

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

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

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. Debe estar entre 1 y 200. Si no se especifica, se establecerá de forma predeterminada como 100.
pageToken

string

Un token que identifica una página de resultados que el servidor debe mostrar. Por lo general, este es el valor de nextPageToken que se muestra de la llamada anterior al método users.list. Si no se especifica, se mostrará la primera página de resultados.
orderBy

string

Campo según el cual se ordenan los resultados. Los valores aceptables son:

  • displayName (predeterminada)

El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar un sufijo "desc" al nombre del campo. Por ejemplo, displayName desc.
filter

string

Permite filtrar por campos de usuario.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con el operador lógico AND.
  • Una restricción tiene el formato {field} {operator} {value}.
  • Los campos displayName y email deben usar el operador HAS (:).
  • El campo lastLoginTime debe usar el operador LESS THAN OR EQUAL TO (<=) o GREATER THAN OR EQUAL TO (>=).
  • Todos los demás campos deben usar el operador EQUALS (=).

Campos admitidos:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Es un campo sintético de AssignedUserRole que se usa para filtrar. Identifica el tipo de entidad a la que se asigna el rol de usuario. Los valores válidos son Partner y Advertiser.
  • assignedUserRole.parentPartnerId: Este es un campo sintético de AssignedUserRole que se usa para filtrar. Identifica al socio superior de la entidad a la que se le asignó el rol de usuario.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (entrada en formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Ejemplos:

  • El usuario con displayName que contiene "foo": displayName:"foo"
  • El usuario con email que contiene "bar": email:"bar"
  • Todos los usuarios con roles de usuario estándar: assignedUserRole.userRole="STANDARD"
  • Todos los usuarios con roles de usuario para el socio 123: assignedUserRole.partnerId="123"
  • Todos los usuarios con roles de usuario para el anunciante 123: assignedUserRole.advertiserId="123"
  • Todos los usuarios con roles del usuario a nivel de socio: entityType="PARTNER"
  • Todos los usuarios con roles de usuario para el socio 123 y los anunciantes del socio 123: parentPartnerId="123"
  • Todos los usuarios que accedieron por última vez a partir del 2023-01-01T00:00:00Z (formato de ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

La longitud de este campo no debe superar los 500 caracteres.

Consulta nuestra guía de solicitudes de LIST de filtro para obtener más información.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campos
users[]

object (User)

La lista de usuarios.

Esta lista no aparecerá si está vacía.
nextPageToken

string

Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método users.list para recuperar la siguiente página de resultados. Este token no estará presente si no hay más resultados para mostrar.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.