The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: remarketingLists

Resource: RemarketingList

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.

JSON representation
{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "advertiserIdDimensionValue": {
    object (DimensionValue)
  },
  "name": string,
  "description": string,
  "active": boolean,
  "listSize": string,
  "lifeSpan": string,
  "listPopulationRule": {
    object (ListPopulationRule)
  },
  "listSource": enum (ListSource),
  "kind": string
}
Fields
id

string (int64 format)

Remarketing list ID. This is a read-only, auto-generated field.

accountId

string (int64 format)

Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in

GET

requests.

subaccountId

string (int64 format)

Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in

GET

requests.

advertiserId

string (int64 format)

Dimension value for the advertiser ID that owns this remarketing list. This is a required field.

advertiserIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

name

string

Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.

description

string

Remarketing list description.

active

boolean

Whether this remarketing list is active.

listSize

string (int64 format)

Number of users currently in the list. This is a read-only field.

lifeSpan

string (int64 format)

Number of days that a user should remain in the remarketing list without an impression. Acceptable values are

1

to

540

, inclusive.

listPopulationRule

object (ListPopulationRule)

Rule used to populate the remarketing list with users.

listSource

enum (ListSource)

Product from which this remarketing list was originated.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#remarketingList"

.

ListPopulationRule

Remarketing accountPermissionGroups.list Population Rule.

JSON representation
{
  "floodlightActivityId": string,
  "floodlightActivityName": string,
  "listPopulationClauses": [
    {
      object (ListPopulationClause)
    }
  ]
}
Fields
floodlightActivityId

string (int64 format)

Floodlight activity ID associated with this rule. This field can be left blank.

floodlightActivityName

string

Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.

listPopulationClauses[]

object (ListPopulationClause)

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.

ListPopulationClause

A group clause made up of list population terms representing constraints joined by ORs.

JSON representation
{
  "terms": [
    {
      object (ListPopulationTerm)
    }
  ]
}
Fields
terms[]

object (ListPopulationTerm)

Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.

ListPopulationTerm

Remarketing accountPermissionGroups.list Population Rule Term.

JSON representation
{
  "variableName": string,
  "variableFriendlyName": string,
  "operator": enum (Operator),
  "value": string,
  "negation": boolean,
  "remarketingListId": string,
  "contains": boolean,
  "type": enum (Type)
}
Fields
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

.

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

.

operator

enum (Operator)

Comparison operator of this term. This field is only relevant when type is left unset or set to

CUSTOM_VARIABLE_TERM

or

REFERRER_TERM

.

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

.

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

.

remarketingListId

string (int64 format)

ID of the list in question. This field is only relevant when type is set to

LIST_MEMBERSHIP_TERM

.

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.

type

enum (Type)

accountPermissionGroups.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.

Operator

Enums
NUM_EQUALS
NUM_LESS_THAN
NUM_LESS_THAN_EQUAL
NUM_GREATER_THAN
NUM_GREATER_THAN_EQUAL
STRING_EQUALS
STRING_CONTAINS

Type

Enums
CUSTOM_VARIABLE_TERM
LIST_MEMBERSHIP_TERM
REFERRER_TERM

ListSource

Enums
REMARKETING_LIST_SOURCE_OTHER
REMARKETING_LIST_SOURCE_ADX
REMARKETING_LIST_SOURCE_DFP
REMARKETING_LIST_SOURCE_XFP
REMARKETING_LIST_SOURCE_DFA
REMARKETING_LIST_SOURCE_GA
REMARKETING_LIST_SOURCE_YOUTUBE
REMARKETING_LIST_SOURCE_DBM
REMARKETING_LIST_SOURCE_GPLUS
REMARKETING_LIST_SOURCE_DMP
REMARKETING_LIST_SOURCE_PLAY_STORE

Methods

get

Gets one remarketing list by ID.

insert

Inserts a new remarketing list.

list

Retrieves a list of remarketing lists, possibly filtered.

patch

Updates an existing remarketing list.

update

Updates an existing remarketing list.