CreativeAssignment (Campaign Manager 360 API v5-rev20251009-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,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 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

CreativeAssignment()

Constructors
Constructor and Description
`CreativeAssignment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreativeAssignment`	`clone()`
`Boolean`	`getActive()` Whether this creative assignment is active.
`Boolean`	`getApplyEventTags()` Whether applicable event tags should fire when this creative assignment is rendered.
`ClickThroughUrl`	`getClickThroughUrl()` Click-through URL of the creative assignment.
`List<CompanionClickThroughOverride>`	`getCompanionCreativeOverrides()` Companion creative overrides for this creative assignment.
`List<CreativeGroupAssignment>`	`getCreativeGroupAssignments()` Creative group assignments for this creative assignment.
`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()`
`List<RichMediaExitOverride>`	`getRichMediaExitOverrides()` Rich media exit overrides for this creative assignment.
`Integer`	`getSequence()` Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
`Boolean`	`getSslCompliant()` Whether the creative to be assigned is SSL-compliant.
`com.google.api.client.util.DateTime`	`getStartTime()`
`Integer`	`getWeight()` Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
`CreativeAssignment`	`set(String fieldName, Object value)`
`CreativeAssignment`	`setActive(Boolean active)` Whether this creative assignment is active.
`CreativeAssignment`	`setApplyEventTags(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(List<CompanionClickThroughOverride> companionCreativeOverrides)` Companion creative overrides for this creative assignment.
`CreativeAssignment`	`setCreativeGroupAssignments(List<CreativeGroupAssignment> creativeGroupAssignments)` Creative group assignments for this creative assignment.
`CreativeAssignment`	`setCreativeId(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)`
`CreativeAssignment`	`setRichMediaExitOverrides(List<RichMediaExitOverride> richMediaExitOverrides)` Rich media exit overrides for this creative assignment.
`CreativeAssignment`	`setSequence(Integer sequence)` Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
`CreativeAssignment`	`setSslCompliant(Boolean sslCompliant)` Whether the creative to be assigned is SSL-compliant.
`CreativeAssignment`	`setStartTime(com.google.api.client.util.DateTime startTime)`
`CreativeAssignment`	`setWeight(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, 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
  - CreativeAssignment
```
public CreativeAssignment()
```
- Method Detail
  - getActive
```
public 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(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 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(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 List<CompanionClickThroughOverride> getCompanionCreativeOverrides()
```
    Companion creative overrides for this creative assignment. Applicable to video ads.
    
    Returns:
    
    value or null for none
  - setCompanionCreativeOverrides
```
public CreativeAssignment setCompanionCreativeOverrides(List<CompanionClickThroughOverride> companionCreativeOverrides)
```
    Companion creative overrides for this creative assignment. Applicable to video ads.
    
    Parameters:
    
    companionCreativeOverrides - companionCreativeOverrides or null for none
  - getCreativeGroupAssignments
```
public 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(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 Long getCreativeId()
```
    ID of the creative to be assigned. This is a required field.
    
    Returns:
    
    value or null for none
  - setCreativeId
```
public CreativeAssignment setCreativeId(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()
```
    Returns:
    
    value or null for none
  - setEndTime
```
public CreativeAssignment setEndTime(com.google.api.client.util.DateTime endTime)
```
    Parameters:
    
    endTime - endTime or null for none
  - getRichMediaExitOverrides
```
public 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(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 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(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 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(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()
```
    Returns:
    
    value or null for none
  - setStartTime
```
public CreativeAssignment setStartTime(com.google.api.client.util.DateTime startTime)
```
    Parameters:
    
    startTime - startTime or null for none
  - getWeight
```
public 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(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(String fieldName,
                              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

Class CreativeAssignment

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

CreativeAssignment

Method Detail

getActive

setActive

getApplyEventTags

setApplyEventTags

getClickThroughUrl

setClickThroughUrl

getCompanionCreativeOverrides

setCompanionCreativeOverrides

getCreativeGroupAssignments

setCreativeGroupAssignments

getCreativeId

setCreativeId

getCreativeIdDimensionValue

setCreativeIdDimensionValue

getEndTime

setEndTime

getRichMediaExitOverrides

setRichMediaExitOverrides

getSequence

setSequence

getSslCompliant

setSslCompliant

getStartTime

setStartTime

getWeight

setWeight

set

clone