com.google.api.services.dfareporting.model

Class RemarketingList

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.RemarketingList

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RemarketingList
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Campaign Manager 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RemarketingList()

Method Summary

Modifier and Type	Method and Description
RemarketingList	clone()
Long	getAccountId() Account ID of this remarketing list.
Boolean	getActive() Whether this remarketing list is active.
Long	getAdvertiserId() Dimension value for the advertiser ID that owns this remarketing list.
DimensionValue	getAdvertiserIdDimensionValue() Dimension value for the ID of the advertiser.
String	getDescription() Remarketing list description.
Long	getId() Remarketing list ID.
String	getKind() Identifies what kind of resource this is.
Long	getLifeSpan() Number of days that a user should remain in the remarketing list without an impression.
ListPopulationRule	getListPopulationRule() Rule used to populate the remarketing list with users.
Long	getListSize() Number of users currently in the list.
String	getListSource() Product from which this remarketing list was originated.
String	getName() Name of the remarketing list.
Long	getSubaccountId() Subaccount ID of this remarketing list.
RemarketingList	set(String fieldName, Object value)
RemarketingList	setAccountId(Long accountId) Account ID of this remarketing list.
RemarketingList	setActive(Boolean active) Whether this remarketing list is active.
RemarketingList	setAdvertiserId(Long advertiserId) Dimension value for the advertiser ID that owns this remarketing list.
RemarketingList	setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue) Dimension value for the ID of the advertiser.
RemarketingList	setDescription(String description) Remarketing list description.
RemarketingList	setId(Long id) Remarketing list ID.
RemarketingList	setKind(String kind) Identifies what kind of resource this is.
RemarketingList	setLifeSpan(Long lifeSpan) Number of days that a user should remain in the remarketing list without an impression.
RemarketingList	setListPopulationRule(ListPopulationRule listPopulationRule) Rule used to populate the remarketing list with users.
RemarketingList	setListSize(Long listSize) Number of users currently in the list.
RemarketingList	setListSource(String listSource) Product from which this remarketing list was originated.
RemarketingList	setName(String name) Name of the remarketing list.
RemarketingList	setSubaccountId(Long subaccountId) Subaccount ID of this remarketing list.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RemarketingList

public RemarketingList()

Method Detail

getAccountId

public Long getAccountId()

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

Returns:

value or null for none

setAccountId

public RemarketingList setAccountId(Long accountId)

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

Parameters:

accountId - accountId or null for none

getActive

public Boolean getActive()

Whether this remarketing list is active.

Returns:

value or null for none

setActive

public RemarketingList setActive(Boolean active)

Whether this remarketing list is active.

Parameters:

active - active or null for none

getAdvertiserId

public Long getAdvertiserId()

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

Returns:

value or null for none

setAdvertiserId

public RemarketingList setAdvertiserId(Long advertiserId)

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

Parameters:

advertiserId - advertiserId or null for none

getAdvertiserIdDimensionValue

public DimensionValue getAdvertiserIdDimensionValue()

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

Returns:

value or null for none

setAdvertiserIdDimensionValue

public RemarketingList setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)

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

Parameters:

advertiserIdDimensionValue - advertiserIdDimensionValue or null for none

getDescription

public String getDescription()

Remarketing list description.

Returns:

value or null for none

setDescription

public RemarketingList setDescription(String description)

Remarketing list description.

Parameters:

description - description or null for none

getId

public Long getId()

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

Returns:

value or null for none

setId

public RemarketingList setId(Long id)

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

Parameters:

id - id or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".

Returns:

value or null for none

setKind

public RemarketingList setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".

Parameters:

kind - kind or null for none

getLifeSpan

public Long getLifeSpan()

Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.

Returns:

value or null for none

setLifeSpan

public RemarketingList setLifeSpan(Long lifeSpan)

Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.

Parameters:

lifeSpan - lifeSpan or null for none

getListPopulationRule

public ListPopulationRule getListPopulationRule()

Rule used to populate the remarketing list with users.

Returns:

value or null for none

setListPopulationRule

public RemarketingList setListPopulationRule(ListPopulationRule listPopulationRule)

Rule used to populate the remarketing list with users.

Parameters:

listPopulationRule - listPopulationRule or null for none

getListSize

public Long getListSize()

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

Returns:

value or null for none

setListSize

public RemarketingList setListSize(Long listSize)

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

Parameters:

listSize - listSize or null for none

getListSource

public String getListSource()

Product from which this remarketing list was originated.

Returns:

value or null for none

setListSource

public RemarketingList setListSource(String listSource)

Product from which this remarketing list was originated.

Parameters:

listSource - listSource or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public RemarketingList setName(String name)

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

Parameters:

name - name or null for none

getSubaccountId

public Long getSubaccountId()

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

Returns:

value or null for none

setSubaccountId

public RemarketingList setSubaccountId(Long subaccountId)

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

Parameters:

subaccountId - subaccountId or null for none

set

public RemarketingList set(String fieldName,
                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RemarketingList clone()

Overrides:

clone in class com.google.api.client.json.GenericJson