com.google.api.services.dfareporting.model

Class PlacementGroup

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Contains properties of a package or roadblock.

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
PlacementGroup()

Method Summary

Modifier and Type	Method and Description
PlacementGroup	clone()
Long	getAccountId() Account ID of this placement group.
String	getActiveStatus() Whether this placement group is active, inactive, archived or permanently archived.
Long	getAdvertiserId() Advertiser ID of this placement group.
DimensionValue	getAdvertiserIdDimensionValue() Dimension value for the ID of the advertiser.
Long	getCampaignId() Campaign ID of this placement group.
DimensionValue	getCampaignIdDimensionValue() Dimension value for the ID of the campaign.
List<Long>	getChildPlacementIds() IDs of placements which are assigned to this placement group.
String	getComment() Comments for this placement group.
Long	getContentCategoryId() ID of the content category assigned to this placement group.
LastModifiedInfo	getCreateInfo() Information about the creation of this placement group.
Long	getDirectorySiteId() Directory site ID associated with this placement group.
DimensionValue	getDirectorySiteIdDimensionValue() Dimension value for the ID of the directory site.
String	getExternalId() External ID for this placement.
Long	getId() ID of this placement group.
DimensionValue	getIdDimensionValue() Dimension value for the ID of this placement group.
String	getKind() Identifies what kind of resource this is.
LastModifiedInfo	getLastModifiedInfo() Information about the most recent modification of this placement group.
String	getName() Name of this placement group.
String	getPlacementGroupType() Type of this placement group.
Long	getPlacementStrategyId() ID of the placement strategy assigned to this placement group.
PricingSchedule	getPricingSchedule() Pricing schedule of this placement group.
Long	getPrimaryPlacementId() ID of the primary placement, used to calculate the media cost of a roadblock (placement group).
DimensionValue	getPrimaryPlacementIdDimensionValue() Dimension value for the ID of the primary placement.
Long	getSiteId() Site ID associated with this placement group.
DimensionValue	getSiteIdDimensionValue() Dimension value for the ID of the site.
Long	getSubaccountId() Subaccount ID of this placement group.
PlacementGroup	set(String fieldName, Object value)
PlacementGroup	setAccountId(Long accountId) Account ID of this placement group.
PlacementGroup	setActiveStatus(String activeStatus) Whether this placement group is active, inactive, archived or permanently archived.
PlacementGroup	setAdvertiserId(Long advertiserId) Advertiser ID of this placement group.
PlacementGroup	setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue) Dimension value for the ID of the advertiser.
PlacementGroup	setCampaignId(Long campaignId) Campaign ID of this placement group.
PlacementGroup	setCampaignIdDimensionValue(DimensionValue campaignIdDimensionValue) Dimension value for the ID of the campaign.
PlacementGroup	setChildPlacementIds(List<Long> childPlacementIds) IDs of placements which are assigned to this placement group.
PlacementGroup	setComment(String comment) Comments for this placement group.
PlacementGroup	setContentCategoryId(Long contentCategoryId) ID of the content category assigned to this placement group.
PlacementGroup	setCreateInfo(LastModifiedInfo createInfo) Information about the creation of this placement group.
PlacementGroup	setDirectorySiteId(Long directorySiteId) Directory site ID associated with this placement group.
PlacementGroup	setDirectorySiteIdDimensionValue(DimensionValue directorySiteIdDimensionValue) Dimension value for the ID of the directory site.
PlacementGroup	setExternalId(String externalId) External ID for this placement.
PlacementGroup	setId(Long id) ID of this placement group.
PlacementGroup	setIdDimensionValue(DimensionValue idDimensionValue) Dimension value for the ID of this placement group.
PlacementGroup	setKind(String kind) Identifies what kind of resource this is.
PlacementGroup	setLastModifiedInfo(LastModifiedInfo lastModifiedInfo) Information about the most recent modification of this placement group.
PlacementGroup	setName(String name) Name of this placement group.
PlacementGroup	setPlacementGroupType(String placementGroupType) Type of this placement group.
PlacementGroup	setPlacementStrategyId(Long placementStrategyId) ID of the placement strategy assigned to this placement group.
PlacementGroup	setPricingSchedule(PricingSchedule pricingSchedule) Pricing schedule of this placement group.
PlacementGroup	setPrimaryPlacementId(Long primaryPlacementId) ID of the primary placement, used to calculate the media cost of a roadblock (placement group).
PlacementGroup	setPrimaryPlacementIdDimensionValue(DimensionValue primaryPlacementIdDimensionValue) Dimension value for the ID of the primary placement.
PlacementGroup	setSiteId(Long siteId) Site ID associated with this placement group.
PlacementGroup	setSiteIdDimensionValue(DimensionValue siteIdDimensionValue) Dimension value for the ID of the site.
PlacementGroup	setSubaccountId(Long subaccountId) Subaccount ID of this placement group.

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

PlacementGroup

public PlacementGroup()

Method Detail

getAccountId

public Long getAccountId()

Account ID of this placement group. This is a read-only field that can be left blank.

Returns:

value or null for none

setAccountId

public PlacementGroup setAccountId(Long accountId)

Account ID of this placement group. This is a read-only field that can be left blank.

Parameters:

accountId - accountId or null for none

getActiveStatus

public String getActiveStatus()

Whether this placement group is active, inactive, archived or permanently archived.

Returns:

value or null for none

setActiveStatus

public PlacementGroup setActiveStatus(String activeStatus)

Whether this placement group is active, inactive, archived or permanently archived.

Parameters:

activeStatus - activeStatus or null for none

getAdvertiserId

public Long getAdvertiserId()

Advertiser ID of this placement group. This is a required field on insertion.

Returns:

value or null for none

setAdvertiserId

public PlacementGroup setAdvertiserId(Long advertiserId)

Advertiser ID of this placement group. This is a required field on insertion.

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 PlacementGroup 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

getCampaignId

public Long getCampaignId()

Campaign ID of this placement group. This field is required on insertion.

Returns:

value or null for none

setCampaignId

public PlacementGroup setCampaignId(Long campaignId)

Campaign ID of this placement group. This field is required on insertion.

Parameters:

campaignId - campaignId or null for none

getCampaignIdDimensionValue

public DimensionValue getCampaignIdDimensionValue()

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

Returns:

value or null for none

setCampaignIdDimensionValue

public PlacementGroup setCampaignIdDimensionValue(DimensionValue campaignIdDimensionValue)

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

Parameters:

campaignIdDimensionValue - campaignIdDimensionValue or null for none

getChildPlacementIds

public List<Long> getChildPlacementIds()

IDs of placements which are assigned to this placement group. This is a read-only, auto- generated field.

Returns:

value or null for none

setChildPlacementIds

public PlacementGroup setChildPlacementIds(List<Long> childPlacementIds)

IDs of placements which are assigned to this placement group. This is a read-only, auto- generated field.

Parameters:

childPlacementIds - childPlacementIds or null for none

getComment

public String getComment()

Comments for this placement group.

Returns:

value or null for none

setComment

public PlacementGroup setComment(String comment)

Comments for this placement group.

Parameters:

comment - comment or null for none

getContentCategoryId

public Long getContentCategoryId()

ID of the content category assigned to this placement group.

Returns:

value or null for none

setContentCategoryId

public PlacementGroup setContentCategoryId(Long contentCategoryId)

ID of the content category assigned to this placement group.

Parameters:

contentCategoryId - contentCategoryId or null for none

getCreateInfo

public LastModifiedInfo getCreateInfo()

Information about the creation of this placement group. This is a read-only field.

Returns:

value or null for none

setCreateInfo

public PlacementGroup setCreateInfo(LastModifiedInfo createInfo)

Information about the creation of this placement group. This is a read-only field.

Parameters:

createInfo - createInfo or null for none

getDirectorySiteId

public Long getDirectorySiteId()

Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.

Returns:

value or null for none

setDirectorySiteId

public PlacementGroup setDirectorySiteId(Long directorySiteId)

Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.

Parameters:

directorySiteId - directorySiteId or null for none

getDirectorySiteIdDimensionValue

public DimensionValue getDirectorySiteIdDimensionValue()

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

Returns:

value or null for none

setDirectorySiteIdDimensionValue

public PlacementGroup setDirectorySiteIdDimensionValue(DimensionValue directorySiteIdDimensionValue)

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

Parameters:

directorySiteIdDimensionValue - directorySiteIdDimensionValue or null for none

getExternalId

public String getExternalId()

External ID for this placement.

Returns:

value or null for none

setExternalId

public PlacementGroup setExternalId(String externalId)

External ID for this placement.

Parameters:

externalId - externalId or null for none

getId

public Long getId()

ID of this placement group. This is a read-only, auto-generated field.

Returns:

value or null for none

setId

public PlacementGroup setId(Long id)

ID of this placement group. This is a read-only, auto-generated field.

Parameters:

id - id or null for none

getIdDimensionValue

public DimensionValue getIdDimensionValue()

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

Returns:

value or null for none

setIdDimensionValue

public PlacementGroup setIdDimensionValue(DimensionValue idDimensionValue)

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

Parameters:

idDimensionValue - idDimensionValue or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public PlacementGroup setKind(String kind)

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

Parameters:

kind - kind or null for none

getLastModifiedInfo

public LastModifiedInfo getLastModifiedInfo()

Information about the most recent modification of this placement group. This is a read-only field.

Returns:

value or null for none

setLastModifiedInfo

public PlacementGroup setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)

Information about the most recent modification of this placement group. This is a read-only field.

Parameters:

lastModifiedInfo - lastModifiedInfo or null for none

getName

public String getName()

Name of this placement group. This is a required field and must be less than 256 characters long.

Returns:

value or null for none

setName

public PlacementGroup setName(String name)

Name of this placement group. This is a required field and must be less than 256 characters long.

Parameters:

name - name or null for none

getPlacementGroupType

public String getPlacementGroupType()

Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.

Returns:

value or null for none

setPlacementGroupType

public PlacementGroup setPlacementGroupType(String placementGroupType)

Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.

Parameters:

placementGroupType - placementGroupType or null for none

getPlacementStrategyId

public Long getPlacementStrategyId()

ID of the placement strategy assigned to this placement group.

Returns:

value or null for none

setPlacementStrategyId

public PlacementGroup setPlacementStrategyId(Long placementStrategyId)

ID of the placement strategy assigned to this placement group.

Parameters:

placementStrategyId - placementStrategyId or null for none

getPricingSchedule

public PricingSchedule getPricingSchedule()

Pricing schedule of this placement group. This field is required on insertion.

Returns:

value or null for none

setPricingSchedule

public PlacementGroup setPricingSchedule(PricingSchedule pricingSchedule)

Pricing schedule of this placement group. This field is required on insertion.

Parameters:

pricingSchedule - pricingSchedule or null for none

getPrimaryPlacementId

public Long getPrimaryPlacementId()

ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.

Returns:

value or null for none

setPrimaryPlacementId

public PlacementGroup setPrimaryPlacementId(Long primaryPlacementId)

ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.

Parameters:

primaryPlacementId - primaryPlacementId or null for none

getPrimaryPlacementIdDimensionValue

public DimensionValue getPrimaryPlacementIdDimensionValue()

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

Returns:

value or null for none

setPrimaryPlacementIdDimensionValue

public PlacementGroup setPrimaryPlacementIdDimensionValue(DimensionValue primaryPlacementIdDimensionValue)

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

Parameters:

primaryPlacementIdDimensionValue - primaryPlacementIdDimensionValue or null for none

getSiteId

public Long getSiteId()

Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.

Returns:

value or null for none

setSiteId

public PlacementGroup setSiteId(Long siteId)

Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.

Parameters:

siteId - siteId or null for none

getSiteIdDimensionValue

public DimensionValue getSiteIdDimensionValue()

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

Returns:

value or null for none

setSiteIdDimensionValue

public PlacementGroup setSiteIdDimensionValue(DimensionValue siteIdDimensionValue)

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

Parameters:

siteIdDimensionValue - siteIdDimensionValue or null for none

getSubaccountId

public Long getSubaccountId()

Subaccount ID of this placement group. This is a read-only field that can be left blank.

Returns:

value or null for none

setSubaccountId

public PlacementGroup setSubaccountId(Long subaccountId)

Subaccount ID of this placement group. This is a read-only field that can be left blank.

Parameters:

subaccountId - subaccountId or null for none

set

public PlacementGroup set(String fieldName,
                          Object value)

Overrides:

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

clone

public PlacementGroup clone()

Overrides:

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