REST Resource: customers.userLists

Recurso: gclsrc

Define uma lista de usuários gerenciados pelo Ads Data Hub.

Representação 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

Apenas saída. Nome que identifica exclusivamente uma lista de usuários do Ads Data Hub. Ele tem o formato customer/[customerId]/userLists/[userListId].
userListId

string (int64 format)

Apenas saída. ID da lista de usuários. Este campo é gerado pelo serviço e é usado para preencher a StatefulSet.
adsDataCustomerId

string (int64 format)

Imutável. ID de cliente do Ads Data Hub vinculado a esta lista de usuários. Esse ID precisa ser especificado como adsDataCustomerId ao executar jobs de gclsrcQuery usando essa lista de usuários. Se estiver ausente, o cliente principal será usado. Não será possível mudar isso após a criação da lista.
title

string

Obrigatório. Título da lista de usuários, que é exclusivo para o adsDataCustomerId especificado.
description

string

Obrigatório. Descrição da lista de usuários.
type

enum (UserListType)

Apenas saída. Os valores do tipo de lista de usuários devem ser consistentes com a userList. Este valor é somente leitura e poderá ser acessado em solicitações "get/list".
createEmail

string

Apenas saída. Endereço de e-mail do usuário que criou essa lista de usuários.
listSize

string (int64 format)

Apenas saída. O número de usuários na lista de usuários. Pode ocorrer um atraso na atualização do tamanho da lista.
populateTime

string (Timestamp format)

Apenas saída. Hora em que a lista foi preenchida pela última vez.

Timestamp no formato RFC3339 UTC "Zulu" com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Apenas saída. Estado da lista de usuários (Ativo/Excluído). Este valor é somente leitura e poderá ser acessado em solicitações "get/list".

Campo de união user_list. Outras configurações, dependendo do tipo da lista de usuários.

É necessário definir exatamente um. user_list pode ser apenas de um dos tipos a seguir:
frequencyList

object (FrequencyBasedListInfo)

Lista de usuários para o limite de frequência.
remarketingList

object (RemarketingListInfo)

Lista de remarketing.

Tipo de pergunta

Tipo de lista de usuários. A construção e o uso da lista de usuários no momento da segmentação dependem dessa enumeração. Não é possível alterar o tipo da lista após a criação.

Enums
USER_LIST_TYPE_UNSPECIFIED Valor padrão: não deve ser utilizado.
REMARKETING Públicos-alvo de remarketing criados com consultas SQL no ADH. A lista de remarketing pode ser usada para segmentação positiva e negativa.
FREQUENCY_BASED Públicos-alvo limitados por frequência. Os públicos-alvo desse tipo estão restritos à segmentação negativa.

FrequênciaCom baseListList

Os metadados da lista de usuários com base em frequência.

Representação JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Campos
dv360LineitemIds[]
(deprecated)

string (int64 format)

IDs para itens de linha do DV360 que contribuem para a frequência.
cmCampaignIds[]
(deprecated)

string (int64 format)

Códigos de campanhas do CM que contribuem para a frequência.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

IDs de campanhas do Google Ads que contribuem para a frequência.
eventMatchers[]

object (EventMatcher)

Quais eventos contribuem para a frequência. Ao criar listas de usuários com base em frequência, eventMatchers é preferível para especificar eventos que contribuem com a frequência. dv360LineitemIds, cmCampaignIds e googleAdsCampaignIds serão usados se eventMatchers estiver vazio.
frequencyConstraint

object (FrequencyConstraint)

Descreve quando um usuário é adicionado à lista.
slidingWindowDays

integer

Obrigatório. Tamanho da janela de tempo usado ao calcular a frequência de cada evento. Essa é a medida em dias

Correspondência de eventos

É um evento genérico que contribui para a frequência.

Representação JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Campos
matchType

enum (MatchType)

É o tipo de restrição que será incluída na contagem de frequência.
value

string

Valor da restrição. Por exemplo, para especificar um ID de campanha do Google Ads = 1234, matchType seria GOOGLE_ADS_CAMPAIGN_ID e o valor seria '1234'. Os eventos que têm esse valor para o respectivo MatchType serão incluídos na contagem de frequência.

MatchType

Tipos de restrições compatíveis com a contagem de frequência. Mais tipos podem ser adicionados a essa enumeração no futuro para oferecer suporte a restrições adicionais. É possível especificar um filtro no MatchType em describeValidFrequênciaLimitingEventMatchersRequest para restringir os matchers de eventos retornados nos resultados apenas àqueles que são compatíveis com sua API. Por exemplo, a definição do filtro como "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" retornará EventMatchers apenas desses dois tipos.

Enums
MATCH_TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
CM_CAMPAIGN_ID Tipo de restrição que representa o ID da campanha do Campaign Manager.
DV360_INSERTION_ORDER_ID Tipo de restrição que representa o ID do pedido de inserção do DV360.
DV360_LINE_ITEM_ID Tipo de restrição que representa o ID do item de linha do DV360.
GOOGLE_ADS_CAMPAIGN_ID Tipo de restrição que representa o ID da campanha do Google Ads.

Frequência de frequência

Especifique o número mínimo de eventos para o limite.

Representação JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Campos
eventType

enum (EventType)

Imutável. O tipo de evento que será contado em relação aThresholdEventCount. Por enquanto, não representamos explicitamente as restrições de comparação, supondo que todos sejam GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

Obrigatório. Cada usuário precisa aparecer em pelo menos mil eventos.

EventType

Tipos de eventos que podem ser usados para contar a frequência.

Enums
EVENT_TYPE_UNSPECIFIED Valor padrão: não deve ser utilizado.
IMPRESSIONS Contabilizar todas as impressões.

Informações de remarketing

Metadados para listas de remarketing.

Representação JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Campos
userListQuery

string

Imutável. O recurso de consulta da lista de usuários do Ads Data Hub que especifica como os usuários são adicionados a esse público-alvo. Tem o formato de: customer/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

Apenas saída. Os recursos de consulta da lista de usuários do Ads Data Hub que preencheram esse público-alvo. Ele é destinado a um campo legado para oferecer suporte a listas de usuários preenchidas por várias consultas antes do início das restrições da lista de usuários:consultas individuais. Tem o formato de: customer/[customerId]/userListQuery/[query_resource_id]

Estado

Estado da lista de usuários.

Enums
STATE_UNSPECIFIED O valor padrão / não definido.
STATE_ACTIVE A lista de usuários ainda está aberta e ativa.
STATE_DELETED A lista de usuários está marcada como excluída e não deve ser mais usada para segmentação

Métodos

addEventMatchers

 Adiciona correspondentes de eventos a uma lista de usuários com base em frequência.

addRecipients

 Adicione entidades aos destinatários de uma lista de usuários gerenciada pelo Ads Data Hub.

create

 Cria uma lista de usuários gerenciada pelo Ads Data Hub.

delete

 Exclua a lista de usuários solicitadas do Ads Data Hub gerenciada.

generateFrequencyListMemberships

 Gerar associações para a palavra-chave.

get

 Recupera a lista de usuários solicitada do Ads Data Hub gerenciada.

list

 Lista as listas de usuários gerenciadas pelo cliente especificado do Ads Data Hub.

patch

 Atualiza a lista de usuários gerenciados do Ads Data Hub.

removeRecipients

 Remove entidades dos destinatários de uma lista de usuários gerenciada pelo Ads Data Hub.