com.google.api.services.dfareporting.model

Class CreativeAssignment

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.CreativeAssignment

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Creative Assignment.

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 DCM/DFA Reporting And Trafficking 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CreativeAssignment()

Method Summary

Methods

Modifier and Type	Method and Description
CreativeAssignment	clone()
java.lang.Boolean	getActive() Whether this creative assignment is active.
java.lang.Boolean	getApplyEventTags() Whether applicable event tags should fire when this creative assignment is rendered.
ClickThroughUrl	getClickThroughUrl() Click-through URL of the creative assignment.
java.util.List<CompanionClickThroughOverride>	getCompanionCreativeOverrides() Companion creative overrides for this creative assignment.
java.util.List<CreativeGroupAssignment>	getCreativeGroupAssignments() Creative group assignments for this creative assignment.
java.lang.Long	getCreativeId() ID of the creative to be assigned.
DimensionValue	getCreativeIdDimensionValue() Dimension value for the ID of the creative.
com.google.api.client.util.DateTime	getEndTime() Date and time that the assigned creative should stop serving.
java.util.List<RichMediaExitOverride>	getRichMediaExitOverrides() Rich media exit overrides for this creative assignment.
java.lang.Integer	getSequence() Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
java.lang.Boolean	getSslCompliant() Whether the creative to be assigned is SSL-compliant.
com.google.api.client.util.DateTime	getStartTime() Date and time that the assigned creative should start serving.
java.lang.Integer	getWeight() Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
CreativeAssignment	set(java.lang.String fieldName, java.lang.Object value)
CreativeAssignment	setActive(java.lang.Boolean active) Whether this creative assignment is active.
CreativeAssignment	setApplyEventTags(java.lang.Boolean applyEventTags) Whether applicable event tags should fire when this creative assignment is rendered.
CreativeAssignment	setClickThroughUrl(ClickThroughUrl clickThroughUrl) Click-through URL of the creative assignment.
CreativeAssignment	setCompanionCreativeOverrides(java.util.List<CompanionClickThroughOverride> companionCreativeOverrides) Companion creative overrides for this creative assignment.
CreativeAssignment	setCreativeGroupAssignments(java.util.List<CreativeGroupAssignment> creativeGroupAssignments) Creative group assignments for this creative assignment.
CreativeAssignment	setCreativeId(java.lang.Long creativeId) ID of the creative to be assigned.
CreativeAssignment	setCreativeIdDimensionValue(DimensionValue creativeIdDimensionValue) Dimension value for the ID of the creative.
CreativeAssignment	setEndTime(com.google.api.client.util.DateTime endTime) Date and time that the assigned creative should stop serving.
CreativeAssignment	setRichMediaExitOverrides(java.util.List<RichMediaExitOverride> richMediaExitOverrides) Rich media exit overrides for this creative assignment.
CreativeAssignment	setSequence(java.lang.Integer sequence) Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
CreativeAssignment	setSslCompliant(java.lang.Boolean sslCompliant) Whether the creative to be assigned is SSL-compliant.
CreativeAssignment	setStartTime(com.google.api.client.util.DateTime startTime) Date and time that the assigned creative should start serving.
CreativeAssignment	setWeight(java.lang.Integer weight) Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CreativeAssignment

public CreativeAssignment()

Method Detail

getActive

public java.lang.Boolean getActive()

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.

Returns:

value or null for none

setActive

public CreativeAssignment setActive(java.lang.Boolean active)

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.

Parameters:

active - active or null for none

getApplyEventTags

public java.lang.Boolean getApplyEventTags()

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.

Returns:

value or null for none

setApplyEventTags

public CreativeAssignment setApplyEventTags(java.lang.Boolean applyEventTags)

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.

Parameters:

applyEventTags - applyEventTags or null for none

getClickThroughUrl

public ClickThroughUrl getClickThroughUrl()

Click-through URL of the creative assignment.

Returns:

value or null for none

setClickThroughUrl

public CreativeAssignment setClickThroughUrl(ClickThroughUrl clickThroughUrl)

Click-through URL of the creative assignment.

Parameters:

clickThroughUrl - clickThroughUrl or null for none

getCompanionCreativeOverrides

public java.util.List<CompanionClickThroughOverride> getCompanionCreativeOverrides()

Companion creative overrides for this creative assignment. Applicable to video ads.

Returns:

value or null for none

setCompanionCreativeOverrides

public CreativeAssignment setCompanionCreativeOverrides(java.util.List<CompanionClickThroughOverride> companionCreativeOverrides)

Companion creative overrides for this creative assignment. Applicable to video ads.

Parameters:

companionCreativeOverrides - companionCreativeOverrides or null for none

getCreativeGroupAssignments

public java.util.List<CreativeGroupAssignment> getCreativeGroupAssignments()

Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.

Returns:

value or null for none

setCreativeGroupAssignments

public CreativeAssignment setCreativeGroupAssignments(java.util.List<CreativeGroupAssignment> creativeGroupAssignments)

Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.

Parameters:

creativeGroupAssignments - creativeGroupAssignments or null for none

getCreativeId

public java.lang.Long getCreativeId()

ID of the creative to be assigned. This is a required field.

Returns:

value or null for none

setCreativeId

public CreativeAssignment setCreativeId(java.lang.Long creativeId)

ID of the creative to be assigned. This is a required field.

Parameters:

creativeId - creativeId or null for none

getCreativeIdDimensionValue

public DimensionValue getCreativeIdDimensionValue()

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

Returns:

value or null for none

setCreativeIdDimensionValue

public CreativeAssignment setCreativeIdDimensionValue(DimensionValue creativeIdDimensionValue)

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

Parameters:

creativeIdDimensionValue - creativeIdDimensionValue or null for none

getEndTime

public com.google.api.client.util.DateTime getEndTime()

Date and time that the assigned creative should stop serving. Must be later than the start time.

Returns:

value or null for none

setEndTime

public CreativeAssignment setEndTime(com.google.api.client.util.DateTime endTime)

Date and time that the assigned creative should stop serving. Must be later than the start time.

Parameters:

endTime - endTime or null for none

getRichMediaExitOverrides

public java.util.List<RichMediaExitOverride> getRichMediaExitOverrides()

Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR

Returns:

value or null for none

setRichMediaExitOverrides

public CreativeAssignment setRichMediaExitOverrides(java.util.List<RichMediaExitOverride> richMediaExitOverrides)

Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR

Parameters:

richMediaExitOverrides - richMediaExitOverrides or null for none

getSequence

public java.lang.Integer getSequence()

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.

Returns:

value or null for none

setSequence

public CreativeAssignment setSequence(java.lang.Integer sequence)

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.

Parameters:

sequence - sequence or null for none

getSslCompliant

public java.lang.Boolean getSslCompliant()

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto- generated when the ad is inserted or updated.

Returns:

value or null for none

setSslCompliant

public CreativeAssignment setSslCompliant(java.lang.Boolean sslCompliant)

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto- generated when the ad is inserted or updated.

Parameters:

sslCompliant - sslCompliant or null for none

getStartTime

public com.google.api.client.util.DateTime getStartTime()

Date and time that the assigned creative should start serving.

Returns:

value or null for none

setStartTime

public CreativeAssignment setStartTime(com.google.api.client.util.DateTime startTime)

Date and time that the assigned creative should start serving.

Parameters:

startTime - startTime or null for none

getWeight

public java.lang.Integer getWeight()

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.

Returns:

value or null for none

setWeight

public CreativeAssignment setWeight(java.lang.Integer weight)

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.

Parameters:

weight - weight or null for none

set

public CreativeAssignment set(java.lang.String fieldName,
                     java.lang.Object value)

Overrides:

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

clone

public CreativeAssignment clone()

Overrides:

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