- Resource: RemarketingList
- ListPopulationRule
- ListPopulationClause
- ListPopulationTerm
- ListPopulationOperator
- ListPopulationTermType
- Methods
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 ( |
Fields | |
---|---|
id |
Remarketing list ID. This is a read-only, auto-generated field. |
accountId |
Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in
requests. |
subaccountId |
Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in
requests. |
advertiserId |
Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
advertiserIdDimensionValue |
Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
name |
Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
description |
Remarketing list description. |
active |
Whether this remarketing list is active. |
listSize |
Number of users currently in the list. This is a read-only field. |
lifeSpan |
Number of days that a user should remain in the remarketing list without an impression. Acceptable values are
to
, inclusive. |
listPopulationRule |
Rule used to populate the remarketing list with users. |
listSource |
Product from which this remarketing list was originated. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
ListPopulationRule
Remarketing remarketingLists.list Population Rule.
JSON representation |
---|
{
"floodlightActivityId": string,
"floodlightActivityName": string,
"listPopulationClauses": [
{
object ( |
Fields | |
---|---|
floodlightActivityId |
Floodlight activity ID associated with this rule. This field can be left blank. |
floodlightActivityName |
Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
listPopulationClauses[] |
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 ( |
Fields | |
---|---|
terms[] |
Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
ListPopulationTerm
Remarketing remarketingLists.list Population Rule Term.
JSON representation |
---|
{ "variableName": string, "variableFriendlyName": string, "operator": enum ( |
Fields | |
---|---|
variableName |
Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null,
or
. |
variableFriendlyName |
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
. |
operator |
Comparison operator of this term. This field is only relevant when type is left unset or set to
or
. |
value |
Literal to compare the variable to. This field is only relevant when type is left unset or set to
or
. |
negation |
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
or
. |
remarketingListId |
ID of the list in question. This field is only relevant when type is set to
. |
contains |
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
. False by default. |
type |
remarketingLists.list population term type determines the applicable fields in this object. If left unset or set to
, then
,
,
,
, and
are applicable. If set to
then
and
are applicable. If set to
then
,
, and
are applicable. |
ListPopulationOperator
Comparison operators that can be used in remarketing list population expressions.
Enums | |
---|---|
NUM_EQUALS |
|
NUM_LESS_THAN |
|
NUM_LESS_THAN_EQUAL |
|
NUM_GREATER_THAN |
|
NUM_GREATER_THAN_EQUAL |
|
STRING_EQUALS |
|
STRING_CONTAINS |
ListPopulationTermType
Enums | |
---|---|
CUSTOM_VARIABLE_TERM |
|
LIST_MEMBERSHIP_TERM |
|
REFERRER_TERM |
Methods |
|
---|---|
|
Gets one remarketing list by ID. |
|
Inserts a new remarketing list. |
|
Retrieves a list of remarketing lists, possibly filtered. |
|
Updates an existing remarketing list. |
|
Updates an existing remarketing list. |