REST Resource: customers.userLists

Risorsa: elenco utenti

Definisce un elenco di utenti gestito da Ads Data Hub.

Rappresentazione 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.
}
Campi
name

string

Solo output. Nome che identifica in modo univoco un elenco di utenti di Ads Data Hub. Il formato è customer//customerId]/userLists/[userListId]
userListId

string (int64 format)

Solo output. ID elenco utenti. Questo campo viene generato dal servizio e utilizzato per completare l'elenco utenti.
adsDataCustomerId

string (int64 format)

Immutabile. ID cliente Ads Data Hub collegato associato a questo elenco di utenti. Questo ID deve essere specificato come adsDataCustomerId durante l'esecuzione di job UserListQuery utilizzando questo elenco di utenti. Se il tag non è presente, verrà utilizzato il cliente principale. Questo valore non può essere modificato dopo la creazione dell'elenco.
title

string

Obbligatorio. Titolo dell'elenco di utenti, che è univoco per il parametro adsDataCustomerId specificato.
description

string

Obbligatorio. Descrizione dell'elenco di utenti.
type

enum (UserListType)

Solo output. I valori del tipo UserList devono essere coerenti con useruser. Questo valore è di sola lettura e sarà accessibile su richieste get/list.
createEmail

string

Solo output. Indirizzo email dell'utente che ha creato questo elenco di utenti.
listSize

string (int64 format)

Solo output. Il numero di utenti nell'elenco di utenti. L'aggiornamento delle dimensioni degli elenchi potrebbe subire ritardi.
populateTime

string (Timestamp format)

Solo output. L'ultima volta che l'elenco è stato compilato.

Un timestamp in formato RFC3339 UTC "Zulu", con una risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Solo output. Stato dell'elenco di utenti (Attivo/Eliminato). Questo valore è di sola lettura e sarà accessibile su richieste get/list.

Campo unione user_list. Ulteriore configurazione a seconda del tipo di elenco di utenti.

Deve essere impostata una sola. user_list può essere solo uno dei seguenti:
frequencyList

object (FrequencyBasedListInfo)

Elenco utenti per la quota limite.
remarketingList

object (RemarketingListInfo)

Elenco per il remarketing.

TipoElencoUtente

Tipo di elenco utenti. La creazione e l'utilizzo dell'elenco utenti al momento del targeting dipendono da questo enumerazione. Impossibile cambiare il tipo dell'elenco dopo la creazione.

Enum
USER_LIST_TYPE_UNSPECIFIED Valore predefinito: non deve essere utilizzato.
REMARKETING Segmenti di pubblico per il remarketing creati con query SQL su ADH. L'elenco per il remarketing può essere utilizzato per targeting positivo e negativo.
FREQUENCY_BASED Segmenti di pubblico con frequenza limitata. I segmenti di pubblico di questo tipo sono limitati al targeting per esclusione.

InformazioniElenchi basati sulla frequenza

Metadati dell'elenco utenti basato sulla frequenza.

Rappresentazione JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Campi
dv360LineitemIds[]
(deprecated)

string (int64 format)

ID per gli elementi pubblicitari DV360 che contribuiscono alla frequenza.
cmCampaignIds[]
(deprecated)

string (int64 format)

ID per le campagne CM che contribuiscono alla frequenza.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

ID per le campagne Google Ads che contribuiscono alla frequenza.
eventMatchers[]

object (EventMatcher)

Quali eventi contribuiscono alla frequenza. Quando si creano elenchi di utenti basati sulla frequenza, preferMatchersers è specificato per specificare gli eventi che contribuiscono alla frequenza. dv360LineitemIds, cmCampaignIds e googleAdsCampaignIds vengono utilizzati se eventMatchers è vuoto.
frequencyConstraint

object (FrequencyConstraint)

Descrive quando un utente viene aggiunto all'elenco.
slidingWindowDays

integer

Obbligatorio. Dimensione della finestra temporale utilizzata per il calcolo della frequenza di ogni evento. Questo valore è misurato in giorni

Corrispondenza evento

Evento generico che contribuisce alla frequenza.

Rappresentazione JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Campi
matchType

enum (MatchType)

Il tipo di vincolo che sarà incluso nel conteggio della frequenza.
value

string

Valore del vincolo. Ad esempio, per specificare un ID campagna Google Ads = 1234, matchType sarà GOOGLE_ADS_CAMPAIGN_ID e il valore sarà '1234'. Gli eventi con questo valore per il rispettivo MatchType verranno inclusi nel conteggio della frequenza.

Tipo di corrispondenza

Tipi di vincoli supportati per il conteggio della frequenza. In futuro potrebbero essere aggiunti altri tipi a questa enumerazione per supportare ulteriori vincoli. Puoi specificare un filtro in corrispondenza del tipo di corrispondenza in DescribeValidfrequencyLimitingEventMatchersRequest, in modo da limitare gli eventi corrispondenti restituiti nei risultati solo a quelli supportati dall'API. Ad esempio, l'impostazione del filtro come "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" restituirà EventMatchers solo di questi due tipi.

Enum
MATCH_TYPE_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
CM_CAMPAIGN_ID Tipo di vincolo che rappresenta l'ID campagna di Campaign Manager.
DV360_INSERTION_ORDER_ID Tipo di vincolo che rappresenta l'ID ordine di inserzione DV360.
DV360_LINE_ITEM_ID Tipo di vincolo che rappresenta l'ID elemento pubblicitario DV360.
GOOGLE_ADS_CAMPAIGN_ID Tipo di vincolo che rappresenta l'ID campagna Google Ads.

Vincolo di frequenza

Specifica il numero minimo di eventi per il limite.

Rappresentazione JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Campi
eventType

enum (EventType)

Immutabile. Il tipo di evento che verrà conteggiato rispetto alla soglia dell'evento evento. Per ora non rappresentiamo esplicitamente i vincoli di confronto supponendo che tutti siano GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

Obbligatorio. Ogni utente deve figurare almeno in eventi K.

EventType

Tipi di eventi che possono essere utilizzati per conteggiare la frequenza.

Enum
EVENT_TYPE_UNSPECIFIED Valore predefinito: non deve essere utilizzato.
IMPRESSIONS Conteggia tutte le impressioni.

RemarketingListInfo

Metadati per gli elenchi per il remarketing

Rappresentazione JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Campi
userListQuery

string

Immutabile. La risorsa di query dell'elenco utenti di Ads Data Hub che specifica come gli utenti vengono aggiunti a questo segmento di pubblico. Ha la forma di customer/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

Solo output. Le risorse di query dell'elenco utenti di Ads Data Hub che hanno completato questo segmento di pubblico. Questo è un campo legacy per supportare elenchi di utenti che sono stati compilati da più query prima che siano state applicate le limitazioni di tipo 1:1 userlist:query. Ha la forma di customer/[customerId]/userListQuery/[query_resource_id]

Stato

Stato dell'elenco di utenti.

Enum
STATE_UNSPECIFIED Il valore predefinito / non impostato.
STATE_ACTIVE L'elenco degli utenti è ancora aperto e attivo.
STATE_DELETED L'elenco utenti è contrassegnato come eliminato e non deve più essere utilizzato per il targeting

Metodi

addEventMatchers

 Aggiunge i matcher evento a un elenco di utenti basato sulla frequenza.

addRecipients

 Aggiungere entità ai destinatari di un elenco utenti gestito da Ads Data Hub.

create

 Crea un elenco di utenti gestito da Ads Data Hub.

delete

 Elimina l'elenco di utenti gestito da Ads Data Hub richiesto.

generateFrequencyListMemberships

 Genera iscrizioni per l'elenco utenti.

get

 Recupera l'elenco di utenti gestito da Ads Data Hub richiesto.

list

 Elenca gli elenchi di utenti gestiti dal cliente Ads Data Hub specificato.

patch

 Aggiorna l'elenco di utenti gestito da Ads Data Hub richiesto.

removeRecipients

 Rimuove le entità dai destinatari di un elenco di utenti gestito da Ads Data Hub.