REST Resource: targetableRemarketingLists

  • Targetable remarketing lists help target ads to users based on their website actions, and this resource provides read-only access to those lists.

  • You can access both advertiser-owned and shared remarketing lists using this resource but manage advertiser-owned lists via the RemarketingLists resource.

  • This resource includes properties like list ID, name, description, size, lifespan, and source, allowing you to understand and utilize the list for targeting.

  • The JSON representation and detailed field descriptions offer a comprehensive view of the data structure and properties associated with a TargetableRemarketingList object.

  • You can retrieve individual lists using the get method or a filtered list using the list method, enabling efficient data retrieval for specific needs.

Resource: TargetableRemarketingList

Contains properties of a targetable 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 is a read-only view of a remarketing list to be used to facilitate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.

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

string (int64 format)

Targetable remarketing list ID.

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 targetable remarketing list.

advertiserIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the advertiser.

name

string

Name of the targetable remarketing list. Is no greater than 128 characters long.

description

string

Targetable remarketing list description.

active

boolean

Whether this targetable 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 targetable remarketing list without an impression.

listSource

enum (RemarketingListSource)

Product from which this targetable remarketing list was originated.

kind

string

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

"dfareporting#targetableRemarketingList"

.

Methods

get

Gets one remarketing list by ID.

list

Retrieves a list of targetable remarketing lists, possibly filtered.