RemarketingLists

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

Contém propriedades de uma lista de remarketing. O remarketing permite a você criar listas de usuários que realizaram ações específicas em um site e depois segmentar os anúncios para os membros dessas listas. Este recurso pode ser usado para gerenciar listas de remarketing que pertençam aos anunciantes. Para ver todas as que são visíveis para os anunciantes, incluindo as compartilhadas com o anunciante ou a conta, use o recurso TargetableRemarketingLists.

{
  "kind": "dfareporting#remarketingList",
  "id": long,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "name": string,
  "description": string,
  "active": boolean,
  "listSize": long,
  "lifeSpan": long,
  "listPopulationRule": {
    "floodlightActivityId": long,
    "floodlightActivityName": string,
    "listPopulationClauses": [
      {
        "terms": [
          {
            "variableName": string,
            "variableFriendlyName": string,
            "operator": string,
            "value": string,
            "negation": boolean,
            "remarketingListId": long,
            "contains": boolean,
            "type": string
          }
        ]
      }
    ]
  },
  "listSource": string
}
Nome da propriedade Valor Descrição Observações
accountId long É o ID da conta desta lista de remarketing. Este é um campo somente leitura gerado automaticamente que é retornado somente em solicitações GET.
active boolean Indica se esta lista de remarketing está ativa.
advertiserId long É o valor da dimensão do ID do anunciante proprietário desta lista de remarketing. Este campo é obrigatório.
advertiserIdDimensionValue nested object É o valor da dimensão do ID do anunciante. Este é um campo somente leitura gerado automaticamente.
description string É a descrição da lista de remarketing.
id long É o ID da lista de remarketing. Este é um campo somente leitura gerado automaticamente.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#remarketingList".
lifeSpan long É o número de dias que um usuário permanece na lista de remarketing sem uma impressão. Os valores aceitos vão de 1 a 540, inclusive.
listPopulationRule nested object É a regra usada para preencher a lista de remarketing com usuários.
listPopulationRule.floodlightActivityId long É o ID da atividade do Floodlight associada a esta regra. Este campo pode ser deixado em branco.
listPopulationRule.floodlightActivityName string É o nome da atividade do Floodlight associada a esta regra. Este é um campo somente leitura gerado automaticamente.
listPopulationRule.listPopulationClauses[] list São as cláusulas que compõem esta regra de preenchimento da lista. As cláusulas são unidas por "AND" e compostas por termos de preenchimento da lista, que são unidos por "OR".
listPopulationRule.listPopulationClauses[].terms[] list São os termos desta cláusula de preenchimento da lista. Cada cláusula é composta por termos de preenchimento da lista que representam restrições e são unidos por "OR".
listPopulationRule.listPopulationClauses[].terms[].contains boolean Será verdadeiro caso o termo procure verificar se o usuário está na lista e falso caso busque verificar se não está. Este campo só é relevante quando o tipo for definido como LIST_MEMBERSHIP_TERM. O padrão é "falso".
listPopulationRule.listPopulationClauses[].terms[].negation boolean Indica se o resultado de comparação deste termo é negado durante a avaliação da regra. Este campo só será relevante quando o tipo não for usado ou for definido como CUSTOM_VARIABLE_TERM ou REFERRER_TERM.
listPopulationRule.listPopulationClauses[].terms[].operator string É o operador de comparação deste termo. Este campo só será relevante quando o tipo não for usado ou for definido como CUSTOM_VARIABLE_TERM ou REFERRER_TERM.

Os valores aceitáveis são os seguintes:
  • "NUM_EQUALS"
  • "NUM_GREATER_THAN"
  • "NUM_GREATER_THAN_EQUAL"
  • "NUM_LESS_THAN"
  • "NUM_LESS_THAN_EQUAL"
  • "STRING_CONTAINS"
  • "STRING_EQUALS"
listPopulationRule.listPopulationClauses[].terms[].remarketingListId long É o ID da lista. Este campo só é relevante quando o tipo for definido como LIST_MEMBERSHIP_TERM.
listPopulationRule.listPopulationClauses[].terms[].type string O tipo de termo de preenchimento da lista determina os campos aplicáveis a este objeto. Se não for definido ou caso seja definido como CUSTOM_VARIABLE_TERM, então variableName, variableFriendlyName, operator, value e negation se aplicam. Se for definido como LIST_MEMBERSHIP_TERM, então remarketingListId e contains se aplicarão. Se for definido como REFERRER_TERM, então operator, value e negation se aplicarão.

Os valores aceitáveis são os seguintes:
  • "CUSTOM_VARIABLE_TERM"
  • "LIST_MEMBERSHIP_TERM"
  • "REFERRER_TERM"
listPopulationRule.listPopulationClauses[].terms[].value string É o valor literal a ser comparado à variável. Este campo só será relevante quando o tipo não for usado ou for definido como CUSTOM_VARIABLE_TERM ou REFERRER_TERM.
listPopulationRule.listPopulationClauses[].terms[].variableFriendlyName string É o nome de fácil utilização da variável deste termo. Este é um campo somente leitura gerado automaticamente. Este campo só será relevante quando o tipo não for usado ou for definido como CUSTOM_VARIABLE_TERM.
listPopulationRule.listPopulationClauses[].terms[].variableName string É o nome da variável comparada neste termo, como U1, U2, entre outros. Este campo só é relevante quando o tipo é definido como nulo, CUSTOM_VARIABLE_TERM ou REFERRER_TERM.
listSize long É o número de usuários na lista. Este é um campo somente leitura.
listSource string É o produto de origem desta lista de remarketing.

Os valores aceitáveis são os seguintes:
  • "REMARKETING_LIST_SOURCE_ADX"
  • "REMARKETING_LIST_SOURCE_DBM"
  • "REMARKETING_LIST_SOURCE_DFA"
  • "REMARKETING_LIST_SOURCE_DFP"
  • "REMARKETING_LIST_SOURCE_DMP"
  • "REMARKETING_LIST_SOURCE_GA"
  • "REMARKETING_LIST_SOURCE_GPLUS"
  • "REMARKETING_LIST_SOURCE_OTHER"
  • "REMARKETING_LIST_SOURCE_PLAY_STORE"
  • "REMARKETING_LIST_SOURCE_XFP"
  • "REMARKETING_LIST_SOURCE_YOUTUBE"
name string É o nome da lista de remarketing. Este campo é obrigatório. Não pode ter mais de 128 caracteres.
subaccountId long É o ID da subconta desta lista de remarketing. Este é um campo somente leitura gerado automaticamente que é retornado somente em solicitações GET.

Métodos

get
Recebe uma lista de remarketing por ID.
insert
Insere uma nova lista de remarketing.
list
Recupera uma lista de listas de remarketing, possivelmente filtrada. Esse método é compatível com paginação.
patch
Atualiza uma lista de remarketing existente. Esse método é compatível com a semântica de patch.
update
Atualiza uma lista de remarketing existente.