REST Resource: customers.userLists

Recurso: UserList

Define una lista de usuarios administrada por el Centro de Datos de Anuncios.

Representación JSON 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
Campos
name

string

Solo salida. Nombre que identifica de forma única una lista de usuarios del Centro de Datos de Anuncios. Tiene el formato customers/[customerId]/userLists/[userListId]
userListId

string (int64 format)

Solo salida. ID de lista de usuarios. El servicio genera este campo y se usa para completar la lista de usuarios.
adsDataCustomerId

string (int64 format)

Inmutable. Es el ID de cliente del Centro de Datos de Anuncios Vinculados asociado a esta lista de usuarios. Este ID debe especificarse como adsDataCustomerId cuando se ejecutan trabajos de UserListQuery con esta lista de usuarios. Si está ausente, se usará el cliente superior. No se puede cambiar después de crear la lista.
title

string

Obligatorio. Es el título de la lista de usuarios, que es único para el valor especificado para adsDataCustomerId.
description

string

Obligatorio. Descripción de la lista de usuarios.
type

enum (UserListType)

Solo salida. Los valores de tipo UserList deben ser coherentes con userList. Este valor es de solo lectura y se podrá acceder a él en las solicitudes get/list.
createEmail

string

Solo salida. Dirección de correo electrónico del usuario que creó esta lista de usuarios.
listSize

string (int64 format)

Solo salida. Indica la cantidad de usuarios en la lista de usuarios. Es posible que la actualización del tamaño de la lista esté retrasada.
populateTime

string (Timestamp format)

Solo salida. Hora en la que se propagó la lista por última vez.

Una marca de tiempo en formato RFC3339 UTC (Zulú) con resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Solo salida. Estado de la lista de usuarios (activa/eliminada). Este valor es de solo lectura y se podrá acceder a él en las solicitudes get/list.

Campo de unión user_list. Configuración adicional según el tipo de lista de usuarios.

Se debe establecer exactamente uno. user_list puede ser una de las siguientes opciones:
frequencyList

object (FrequencyBasedListInfo)

Lista de usuarios para la limitación de frecuencia.
remarketingList

object (RemarketingListInfo)

Lista de remarketing.

TipoListaDeUsuario

Tipo de lista de usuarios. La creación y el uso de la lista de usuarios en el momento de la orientación dependen de esta enumeración. No se puede cambiar el tipo de la lista después de su creación.

Enumeradores
USER_LIST_TYPE_UNSPECIFIED Valor predeterminado: No se debe usar.
REMARKETING Públicos de remarketing creados con consultas de SQL en el CDA La lista de remarketing puede utilizarse para una orientación positiva y negativa.
FREQUENCY_BASED Públicos limitados por la frecuencia. Este tipo de público está restringido a la orientación negativa.

Información de la lista basada en la frecuencia

Metadatos de la lista de usuarios basada en la frecuencia

Representación JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Campos
dv360LineitemIds[]
(deprecated)

string (int64 format)

Son los ID de las líneas de pedido de DV360 que contribuyen a la frecuencia.
cmCampaignIds[]
(deprecated)

string (int64 format)

Son los ID de las campañas de CM que contribuyen a la frecuencia.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

Son los ID de las campañas de Google Ads que contribuyen a la frecuencia.
eventMatchers[]

object (EventMatcher)

Qué eventos contribuyen a la frecuencia Cuando se crean listas de usuarios basadas en la frecuencia, se prefiere eventMatchers para especificar eventos que contribuyen a la frecuencia. Se usan dv360LineitemIds, cmCampaignIds y googleAdsCampaignIds si eventMatchers está vacío.
frequencyConstraint

object (FrequencyConstraint)

Describe cuándo se agrega un usuario a la lista.
slidingWindowDays

integer

Obligatorio. Tamaño del período utilizado para calcular la frecuencia de cada evento. Esto se mide en días

EventMatcher

Evento genérico que contribuye a la frecuencia

Representación JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Campos
matchType

enum (MatchType)

El tipo de restricción que se incluirá en el recuento de frecuencia.
value

string

Valor de la restricción. Por ejemplo, para especificar un ID de campaña de Google Ads = 1,234, matchType sería GOOGLE_ADS_CAMPAIGN_ID y el valor sería '1234&#39. Los eventos que tienen este valor para el MatchType correspondiente se incluirán en el recuento de frecuencia.

MatchType

Tipos de restricciones compatibles para el recuento de frecuencia. Es posible que se agreguen más tipos a esta enumeración en el futuro para admitir restricciones adicionales. Puedes especificar un filtro para MatchMatch en la solicitud DescribeValidFrequencyLimitingEventMatchersRequest para restringir los comparadores de eventos que se muestran en los resultados solo a los que son compatibles con tu API. Por ejemplo, si se establece el filtro como "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" mostrará EventMatchers solo esos dos tipos.

Enumeradores
MATCH_TYPE_UNSPECIFIED Valor predeterminado Este valor no se usa.
CM_CAMPAIGN_ID Tipo de restricción que representa el ID de la campaña de Campaign Manager.
DV360_INSERTION_ORDER_ID Tipo de restricción que representa el ID de pedido de inserción de DV360.
DV360_LINE_ITEM_ID Tipo de restricción que representa el ID de la línea de pedido de DV360.
GOOGLE_ADS_CAMPAIGN_ID Tipo de restricción que representa el ID de la campaña de Google Ads.

Limitación de frecuencia

Especifica la cantidad mínima de eventos para el límite.

Representación JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Campos
eventType

enum (EventType)

Inmutable. Es el tipo de evento que se contará en los límites de eventEventCount. Por ahora, no representamos de forma explícita las restricciones de comparación, suponiendo que todas son GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

Obligatorio. Cada usuario debe aparecer en al menos K eventos.

EventType

Tipos de eventos que se pueden utilizar para contar la frecuencia.

Enumeradores
EVENT_TYPE_UNSPECIFIED Valor predeterminado: No se debe usar.
IMPRESSIONS Contar todas las impresiones

Información de la lista de remarketing

Metadatos de las listas de remarketing

Representación JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Campos
userListQuery

string

Inmutable. El recurso de consulta de lista de usuarios del Centro de Datos de Anuncios que especifica cómo se agregan usuarios a este público. Tiene el siguiente formato: customers/[customerId]/userListQueries/[query_resource_id]
populatingUserListQueries[]

string

Solo salida. La lista de usuarios del Centro de Datos de Anuncios recopiló recursos de consulta que propagaron este público. Este campo se diseñó como un campo heredado para admitir las listas de usuarios que se completaron en varias consultas antes de que entraran en vigencia las restricciones de usuario 1:1. Tiene el siguiente formato: customers/[customerId]/userListQueries/[query_resource_id]

State

Estado de la lista de usuarios

Enumeradores
STATE_UNSPECIFIED Es el valor predeterminado o no establecido.
STATE_ACTIVE La lista de usuarios sigue abierta y activa.
STATE_DELETED La lista de usuarios se marcó como eliminada y ya no se utilizará para la orientación

Métodos

addEventMatchers

 Agrega comparadores de eventos a una lista de usuarios basada en la frecuencia.

addRecipients

 Agregue entidades a los destinatarios de una lista de usuarios administradas por el Centro de Datos de Anuncios.

create

 Crea una lista de usuarios administrada por Ads Data Hub.

delete

 Borra la lista de usuarios administrada de Ads Data Hub solicitado.

generateFrequencyListMemberships

 Genera membresías para la lista de usuarios.

get

 Recupera la lista de usuarios administrada de Ads Data Hub solicitada.

list

 Enumera las listas de usuarios que administra el cliente de Ads Data Hub especificado.

patch

 Actualiza la lista de usuarios administrada de Ads Data Hub solicitado.

removeRecipients

 Quita entidades de los destinatarios de una lista de usuarios administradas por el Centro de Datos de Anuncios.