Method: accountTypes.accounts.userLists.list

Enumera UserLists.

Encabezados de autorización:

Este método admite los siguientes encabezados opcionales para definir cómo la API autoriza el acceso a la solicitud:

  • login-account: (Opcional) Es el nombre del recurso de la cuenta en la que la Cuenta de Google de las credenciales es un usuario. Si no se configura, se establece de forma predeterminada en la cuenta de la solicitud. Formato: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Opcional) Es el nombre del recurso de la cuenta con una vinculación del producto establecida con el login-account. Formato: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Solicitud HTTP

GET https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/userLists

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es la cuenta principal que posee esta colección de listas de usuarios. Formato: accountTypes/{accountType}/accounts/{account}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de listas de usuarios que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 listas de usuarios. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
pageToken

string

Opcional. Un token de página, recibido desde una llamada userLists.list anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a userLists.list deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Opcional. Es una cadena de filtro. Todos los campos deben estar en el lado izquierdo de cada condición (por ejemplo, display_name = "list 1"). Los campos se deben especificar con todo en camel case o todo en snake case. No uses una combinación de camel case y snake case.

Operaciones admitidas:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (tiene)

Campos admitidos:

  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es el mensaje de respuesta de userLists.list.

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

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

object (UserList)

Son las listas de usuarios de la cuenta especificada.
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.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/datamanager