com.google.api.services.dfareporting.model

Class CreativeCustomEvent

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Creative Custom Event.

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

Method Summary

Modifier and Type	Method and Description
CreativeCustomEvent	clone()
Long	getAdvertiserCustomEventId() Unique ID of this event used by Reporting and Data Transfer.
String	getAdvertiserCustomEventName() User-entered name for the event.
String	getAdvertiserCustomEventType() Type of the event.
String	getArtworkLabel() Artwork label column, used to link events in Campaign Manager back to events in Studio.
String	getArtworkType() Artwork type used by the creative.This is a read-only field.
CreativeClickThroughUrl	getExitClickThroughUrl() Exit click-through URL for the event.
Long	getId() ID of this event.
PopupWindowProperties	getPopupWindowProperties() Properties for rich media popup windows.
String	getTargetType() Target type used by the event.
String	getVideoReportingId() Video reporting ID, used to differentiate multiple videos in a single creative.
CreativeCustomEvent	set(String fieldName, Object value)
CreativeCustomEvent	setAdvertiserCustomEventId(Long advertiserCustomEventId) Unique ID of this event used by Reporting and Data Transfer.
CreativeCustomEvent	setAdvertiserCustomEventName(String advertiserCustomEventName) User-entered name for the event.
CreativeCustomEvent	setAdvertiserCustomEventType(String advertiserCustomEventType) Type of the event.
CreativeCustomEvent	setArtworkLabel(String artworkLabel) Artwork label column, used to link events in Campaign Manager back to events in Studio.
CreativeCustomEvent	setArtworkType(String artworkType) Artwork type used by the creative.This is a read-only field.
CreativeCustomEvent	setExitClickThroughUrl(CreativeClickThroughUrl exitClickThroughUrl) Exit click-through URL for the event.
CreativeCustomEvent	setId(Long id) ID of this event.
CreativeCustomEvent	setPopupWindowProperties(PopupWindowProperties popupWindowProperties) Properties for rich media popup windows.
CreativeCustomEvent	setTargetType(String targetType) Target type used by the event.
CreativeCustomEvent	setVideoReportingId(String videoReportingId) Video reporting ID, used to differentiate multiple videos in a single creative.

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

CreativeCustomEvent

public CreativeCustomEvent()

Method Detail

getAdvertiserCustomEventId

public Long getAdvertiserCustomEventId()

Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.

Returns:

value or null for none

setAdvertiserCustomEventId

public CreativeCustomEvent setAdvertiserCustomEventId(Long advertiserCustomEventId)

Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.

Parameters:

advertiserCustomEventId - advertiserCustomEventId or null for none

getAdvertiserCustomEventName

public String getAdvertiserCustomEventName()

User-entered name for the event.

Returns:

value or null for none

setAdvertiserCustomEventName

public CreativeCustomEvent setAdvertiserCustomEventName(String advertiserCustomEventName)

User-entered name for the event.

Parameters:

advertiserCustomEventName - advertiserCustomEventName or null for none

getAdvertiserCustomEventType

public String getAdvertiserCustomEventType()

Type of the event. This is a read-only field.

Returns:

value or null for none

setAdvertiserCustomEventType

public CreativeCustomEvent setAdvertiserCustomEventType(String advertiserCustomEventType)

Type of the event. This is a read-only field.

Parameters:

advertiserCustomEventType - advertiserCustomEventType or null for none

getArtworkLabel

public String getArtworkLabel()

Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.

Returns:

value or null for none

setArtworkLabel

public CreativeCustomEvent setArtworkLabel(String artworkLabel)

Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.

Parameters:

artworkLabel - artworkLabel or null for none

getArtworkType

public String getArtworkType()

Artwork type used by the creative.This is a read-only field.

Returns:

value or null for none

setArtworkType

public CreativeCustomEvent setArtworkType(String artworkType)

Artwork type used by the creative.This is a read-only field.

Parameters:

artworkType - artworkType or null for none

getExitClickThroughUrl

public CreativeClickThroughUrl getExitClickThroughUrl()

Exit click-through URL for the event. This field is used only for exit events.

Returns:

value or null for none

setExitClickThroughUrl

public CreativeCustomEvent setExitClickThroughUrl(CreativeClickThroughUrl exitClickThroughUrl)

Exit click-through URL for the event. This field is used only for exit events.

Parameters:

exitClickThroughUrl - exitClickThroughUrl or null for none

getId

public Long getId()

ID of this event. This is a required field and should not be modified after insertion.

Returns:

value or null for none

setId

public CreativeCustomEvent setId(Long id)

ID of this event. This is a required field and should not be modified after insertion.

Parameters:

id - id or null for none

getPopupWindowProperties

public PopupWindowProperties getPopupWindowProperties()

Properties for rich media popup windows. This field is used only for exit events.

Returns:

value or null for none

setPopupWindowProperties

public CreativeCustomEvent setPopupWindowProperties(PopupWindowProperties popupWindowProperties)

Properties for rich media popup windows. This field is used only for exit events.

Parameters:

popupWindowProperties - popupWindowProperties or null for none

getTargetType

public String getTargetType()

Target type used by the event.

Returns:

value or null for none

setTargetType

public CreativeCustomEvent setTargetType(String targetType)

Target type used by the event.

Parameters:

targetType - targetType or null for none

getVideoReportingId

public String getVideoReportingId()

Video reporting ID, used to differentiate multiple videos in a single creative. This is a read- only field.

Returns:

value or null for none

setVideoReportingId

public CreativeCustomEvent setVideoReportingId(String videoReportingId)

Video reporting ID, used to differentiate multiple videos in a single creative. This is a read- only field.

Parameters:

videoReportingId - videoReportingId or null for none

set

public CreativeCustomEvent set(String fieldName,
                               Object value)

Overrides:

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

clone

public CreativeCustomEvent clone()

Overrides:

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