Method: users.list

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

Solicitud HTTP

GET https://displayvideo.googleapis.com/v1beta2/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 ser un valor entre 1 y 100. Si no se especifica, el valor predeterminado será 100.
pageToken

string

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

string

Campo por el que se ordenará la lista. Los valores aceptables son:

  • displayName (predeterminada)

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

string

Permite filtrar por propiedades del usuario.

Sintaxis compatible:

  • Las expresiones de filtro se componen de una o más restricciones.
  • El operador lógico AND puede combinar las restricciones.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El operador debe ser CONTAINS (:) o EQUALS (=).
  • El operador debe ser CONTAINS (:) en los siguientes campos:
    • displayName
    • email
  • El operador debe ser EQUALS (=) en los siguientes campos:
    • assignedUserRole.userRole
    • assignedUserRole.partnerId
    • assignedUserRole.advertiserId
    • assignedUserRole.entityType: Es un campo sintético de AssignedUserRole que se usa para el filtrado. Identifica el tipo de entidad al que se asigna el rol del usuario. Los valores válidos son Partner y Advertiser.
    • assignedUserRole.parentPartnerId: Es un campo sintético de AssignedUserRole que se usa para el filtrado. Identifica al socio principal de la entidad a la que se le asignó el rol del usuario".

Ejemplos:

  • El usuario con displayName que contiene foo: displayName:"foo"
  • El usuario con un correo electrónico que contiene bar: email:"bar"
  • Todos los usuarios con roles del usuario estándar: assignedUserRole.userRole="STANDARD"
  • Todos los usuarios con roles del socio 123: assignedUserRole.partnerId="123"
  • Todos los usuarios con roles del anunciante 123: assignedUserRole.advertiserId="123"
  • Todos los usuarios con roles a nivel del socio: entityType="PARTNER"
  • Todos los usuarios con roles de usuario para el socio 123 y los anunciantes bajo el socio 123: parentPartnerId="123"

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

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)

Es la lista de usuarios.

Esta lista no estará disponible 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 estará ausente si no hay más resultados para mostrar.

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