- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- UserListView.
Enumera las listas de usuarios que administra el cliente de Ads Data Hub especificado.
Solicitud HTTP
GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
parent |
Obligatorio. Nombre del recurso del cliente superior, p. ej., 'customers/123' |
Parámetros de consulta
Parámetros | |
---|---|
pageSize |
Cantidad máxima de elementos que se mostrarán. Si es 0, el servidor determinará la cantidad de listas de usuarios que se mostrarán. |
pageToken |
El token de página, que muestra una llamada anterior, se usa para solicitar la página siguiente de resultados. |
filter |
Filtro de ejemplo: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 ANDpopulateTime > 2012-04-01:01-014 |
view |
Especifica qué campos incluir en cada lista de usuarios. |
showDeleted |
Si se establece como verdadera, las listas de usuarios borradas se incluirán en la respuesta. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Respuesta a una solicitud userLists.list. Contiene las listas de usuarios que administra el cliente de Ads Data Hub especificado.
Representación JSON |
---|
{
"userLists": [
{
object ( |
Campos | |
---|---|
userLists[] |
Una lista de listas de usuarios. |
nextPageToken |
Un token que se puede usar para solicitar la siguiente página de resultados. Este campo está vacío si no hay resultados adicionales. |
Alcances de la autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/adsdatahub
Vista de lista de usuarios
Es una enumeración para indicar qué campos incluir en cada lista de usuarios que muestra la API de [userLists.list].
Enumeradores | |
---|---|
USER_LIST_VIEW_UNSPECIFIED |
Es el valor predeterminado o no establecido. La API usará la vista FULL de forma predeterminada. |
BASIC |
Incluye campos, excepto [recipientAdsDataLinks]. |
FULL |
Incluya todo. |