com.google.api.services.dfareporting.model

Class CreativeAssetMetadata

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.

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

Method Summary

Modifier and Type	Method and Description
CreativeAssetMetadata	clone()
CreativeAssetId	getAssetIdentifier() ID of the creative asset.
List<ClickTag>	getClickTags() List of detected click tags for assets.
List<CreativeCustomEvent>	getCounterCustomEvents() List of counter events configured for the asset.
List<String>	getDetectedFeatures() List of feature dependencies for the creative asset that are detected by Campaign Manager.
List<CreativeCustomEvent>	getExitCustomEvents() List of exit events configured for the asset.
Long	getId() Numeric ID of the asset.
DimensionValue	getIdDimensionValue() Dimension value for the numeric ID of the asset.
String	getKind() Identifies what kind of resource this is.
Boolean	getRichMedia() True if the uploaded asset is a rich media asset.
List<CreativeCustomEvent>	getTimerCustomEvents() List of timer events configured for the asset.
List<String>	getWarnedValidationRules() Rules validated during code generation that generated a warning.
CreativeAssetMetadata	set(String fieldName, Object value)
CreativeAssetMetadata	setAssetIdentifier(CreativeAssetId assetIdentifier) ID of the creative asset.
CreativeAssetMetadata	setClickTags(List<ClickTag> clickTags) List of detected click tags for assets.
CreativeAssetMetadata	setCounterCustomEvents(List<CreativeCustomEvent> counterCustomEvents) List of counter events configured for the asset.
CreativeAssetMetadata	setDetectedFeatures(List<String> detectedFeatures) List of feature dependencies for the creative asset that are detected by Campaign Manager.
CreativeAssetMetadata	setExitCustomEvents(List<CreativeCustomEvent> exitCustomEvents) List of exit events configured for the asset.
CreativeAssetMetadata	setId(Long id) Numeric ID of the asset.
CreativeAssetMetadata	setIdDimensionValue(DimensionValue idDimensionValue) Dimension value for the numeric ID of the asset.
CreativeAssetMetadata	setKind(String kind) Identifies what kind of resource this is.
CreativeAssetMetadata	setRichMedia(Boolean richMedia) True if the uploaded asset is a rich media asset.
CreativeAssetMetadata	setTimerCustomEvents(List<CreativeCustomEvent> timerCustomEvents) List of timer events configured for the asset.
CreativeAssetMetadata	setWarnedValidationRules(List<String> warnedValidationRules) Rules validated during code generation that generated a warning.

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

CreativeAssetMetadata

public CreativeAssetMetadata()

Method Detail

getAssetIdentifier

public CreativeAssetId getAssetIdentifier()

ID of the creative asset. This is a required field.

Returns:

value or null for none

setAssetIdentifier

public CreativeAssetMetadata setAssetIdentifier(CreativeAssetId assetIdentifier)

ID of the creative asset. This is a required field.

Parameters:

assetIdentifier - assetIdentifier or null for none

getClickTags

public List<ClickTag> getClickTags()

List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.

Returns:

value or null for none

setClickTags

public CreativeAssetMetadata setClickTags(List<ClickTag> clickTags)

List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.

Parameters:

clickTags - clickTags or null for none

getCounterCustomEvents

public List<CreativeCustomEvent> getCounterCustomEvents()

List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.

Returns:

value or null for none

setCounterCustomEvents

public CreativeAssetMetadata setCounterCustomEvents(List<CreativeCustomEvent> counterCustomEvents)

List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.

Parameters:

counterCustomEvents - counterCustomEvents or null for none

getDetectedFeatures

public List<String> getDetectedFeatures()

List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.

Returns:

value or null for none

setDetectedFeatures

public CreativeAssetMetadata setDetectedFeatures(List<String> detectedFeatures)

List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.

Parameters:

detectedFeatures - detectedFeatures or null for none

getExitCustomEvents

public List<CreativeCustomEvent> getExitCustomEvents()

List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.

Returns:

value or null for none

setExitCustomEvents

public CreativeAssetMetadata setExitCustomEvents(List<CreativeCustomEvent> exitCustomEvents)

List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.

Parameters:

exitCustomEvents - exitCustomEvents or null for none

getId

public Long getId()

Numeric ID of the asset. This is a read-only, auto-generated field.

Returns:

value or null for none

setId

public CreativeAssetMetadata setId(Long id)

Numeric ID of the asset. This is a read-only, auto-generated field.

Parameters:

id - id or null for none

getIdDimensionValue

public DimensionValue getIdDimensionValue()

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

Returns:

value or null for none

setIdDimensionValue

public CreativeAssetMetadata setIdDimensionValue(DimensionValue idDimensionValue)

Dimension value for the numeric ID of the asset. 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#creativeAssetMetadata".

Returns:

value or null for none

setKind

public CreativeAssetMetadata setKind(String kind)

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

Parameters:

kind - kind or null for none

getRichMedia

public Boolean getRichMedia()

True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.

Returns:

value or null for none

setRichMedia

public CreativeAssetMetadata setRichMedia(Boolean richMedia)

True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.

Parameters:

richMedia - richMedia or null for none

getTimerCustomEvents

public List<CreativeCustomEvent> getTimerCustomEvents()

List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.

Returns:

value or null for none

setTimerCustomEvents

public CreativeAssetMetadata setTimerCustomEvents(List<CreativeCustomEvent> timerCustomEvents)

List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.

Parameters:

timerCustomEvents - timerCustomEvents or null for none

getWarnedValidationRules

public List<String> getWarnedValidationRules()

Rules validated during code generation that generated a warning. This is a read-only, auto- generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID"

Returns:

value or null for none

setWarnedValidationRules

public CreativeAssetMetadata setWarnedValidationRules(List<String> warnedValidationRules)

Rules validated during code generation that generated a warning. This is a read-only, auto- generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID"

Parameters:

warnedValidationRules - warnedValidationRules or null for none

set

public CreativeAssetMetadata set(String fieldName,
                                 Object value)

Overrides:

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

clone

public CreativeAssetMetadata clone()

Overrides:

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