The DCM/DFA Reporting and Trafficking API v3.0 is deprecated and will be sunset on November 30th, 2018. All users must migrate to a newer API version by that date.

RemarketingLists

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.

{
  "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
}
Property name Value Description Notes
accountId long Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
active boolean Whether this remarketing list is active.
advertiserId long Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
advertiserIdDimensionValue nested object Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
description string Remarketing list description.
id long Remarketing list ID. This is a read-only, auto-generated field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
lifeSpan long Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
listPopulationRule nested object Rule used to populate the remarketing list with users.
listPopulationRule.floodlightActivityId long Floodlight activity ID associated with this rule. This field can be left blank.
listPopulationRule.floodlightActivityName string Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
listPopulationRule.listPopulationClauses[] list Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
listPopulationRule.listPopulationClauses[].terms[] list Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
listPopulationRule.listPopulationClauses[].terms[].contains boolean Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
listPopulationRule.listPopulationClauses[].terms[].negation boolean Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
listPopulationRule.listPopulationClauses[].terms[].operator string Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.

Acceptable values are:
  • "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 ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
listPopulationRule.listPopulationClauses[].terms[].type string List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.

Acceptable values are:
  • "CUSTOM_VARIABLE_TERM"
  • "LIST_MEMBERSHIP_TERM"
  • "REFERRER_TERM"
listPopulationRule.listPopulationClauses[].terms[].value string Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
listPopulationRule.listPopulationClauses[].terms[].variableFriendlyName string Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
listPopulationRule.listPopulationClauses[].terms[].variableName string Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
listSize long Number of users currently in the list. This is a read-only field.
listSource string Product from which this remarketing list was originated.

Acceptable values are:
  • "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 Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
subaccountId long Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

Methods

get
Gets one remarketing list by ID.
insert
Inserts a new remarketing list.
list
Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
patch
Updates an existing remarketing list. This method supports patch semantics.
update
Updates an existing remarketing list.

Send feedback about...

Campaign Manager
Campaign Manager