com.google.api.services.youtube.model

Class ActivityContentDetailsPromotedItem

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.youtube.model.ActivityContentDetailsPromotedItem

All Implemented Interfaces:

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

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

Details about a resource which is being promoted.

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 YouTube Data 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
ActivityContentDetailsPromotedItem()

Method Summary

Modifier and Type	Method and Description
ActivityContentDetailsPromotedItem	clone()
java.lang.String	getAdTag() The URL the client should fetch to request a promoted item.
java.lang.String	getClickTrackingUrl() The URL the client should ping to indicate that the user clicked through on this promoted item.
java.lang.String	getCreativeViewUrl() The URL the client should ping to indicate that the user was shown this promoted item.
java.lang.String	getCtaType() The type of call-to-action, a message to the user indicating action that can be taken.
java.lang.String	getCustomCtaButtonText() The custom call-to-action button text.
java.lang.String	getDescriptionText() The text description to accompany the promoted item.
java.lang.String	getDestinationUrl() The URL the client should direct the user to, if the user chooses to visit the advertiser's website.
java.util.List<java.lang.String>	getForecastingUrl() The list of forecasting URLs.
java.util.List<java.lang.String>	getImpressionUrl() The list of impression URLs.
java.lang.String	getVideoId() The ID that YouTube uses to uniquely identify the promoted video.
ActivityContentDetailsPromotedItem	set(java.lang.String fieldName, java.lang.Object value)
ActivityContentDetailsPromotedItem	setAdTag(java.lang.String adTag) The URL the client should fetch to request a promoted item.
ActivityContentDetailsPromotedItem	setClickTrackingUrl(java.lang.String clickTrackingUrl) The URL the client should ping to indicate that the user clicked through on this promoted item.
ActivityContentDetailsPromotedItem	setCreativeViewUrl(java.lang.String creativeViewUrl) The URL the client should ping to indicate that the user was shown this promoted item.
ActivityContentDetailsPromotedItem	setCtaType(java.lang.String ctaType) The type of call-to-action, a message to the user indicating action that can be taken.
ActivityContentDetailsPromotedItem	setCustomCtaButtonText(java.lang.String customCtaButtonText) The custom call-to-action button text.
ActivityContentDetailsPromotedItem	setDescriptionText(java.lang.String descriptionText) The text description to accompany the promoted item.
ActivityContentDetailsPromotedItem	setDestinationUrl(java.lang.String destinationUrl) The URL the client should direct the user to, if the user chooses to visit the advertiser's website.
ActivityContentDetailsPromotedItem	setForecastingUrl(java.util.List<java.lang.String> forecastingUrl) The list of forecasting URLs.
ActivityContentDetailsPromotedItem	setImpressionUrl(java.util.List<java.lang.String> impressionUrl) The list of impression URLs.
ActivityContentDetailsPromotedItem	setVideoId(java.lang.String videoId) The ID that YouTube uses to uniquely identify the promoted video.

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ActivityContentDetailsPromotedItem

public ActivityContentDetailsPromotedItem()

Method Detail

getAdTag

public java.lang.String getAdTag()

The URL the client should fetch to request a promoted item.

Returns:

value or null for none

setAdTag

public ActivityContentDetailsPromotedItem setAdTag(java.lang.String adTag)

The URL the client should fetch to request a promoted item.

Parameters:

adTag - adTag or null for none

getClickTrackingUrl

public java.lang.String getClickTrackingUrl()

The URL the client should ping to indicate that the user clicked through on this promoted item.

Returns:

value or null for none

setClickTrackingUrl

public ActivityContentDetailsPromotedItem setClickTrackingUrl(java.lang.String clickTrackingUrl)

The URL the client should ping to indicate that the user clicked through on this promoted item.

Parameters:

clickTrackingUrl - clickTrackingUrl or null for none

getCreativeViewUrl

public java.lang.String getCreativeViewUrl()

The URL the client should ping to indicate that the user was shown this promoted item.

Returns:

value or null for none

setCreativeViewUrl

public ActivityContentDetailsPromotedItem setCreativeViewUrl(java.lang.String creativeViewUrl)

The URL the client should ping to indicate that the user was shown this promoted item.

Parameters:

creativeViewUrl - creativeViewUrl or null for none

getCtaType

public java.lang.String getCtaType()

The type of call-to-action, a message to the user indicating action that can be taken.

Returns:

value or null for none

setCtaType

public ActivityContentDetailsPromotedItem setCtaType(java.lang.String ctaType)

The type of call-to-action, a message to the user indicating action that can be taken.

Parameters:

ctaType - ctaType or null for none

getCustomCtaButtonText

public java.lang.String getCustomCtaButtonText()

The custom call-to-action button text. If specified, it will override the default button text for the cta_type.

Returns:

value or null for none

setCustomCtaButtonText

public ActivityContentDetailsPromotedItem setCustomCtaButtonText(java.lang.String customCtaButtonText)

The custom call-to-action button text. If specified, it will override the default button text for the cta_type.

Parameters:

customCtaButtonText - customCtaButtonText or null for none

getDescriptionText

public java.lang.String getDescriptionText()

The text description to accompany the promoted item.

Returns:

value or null for none

setDescriptionText

public ActivityContentDetailsPromotedItem setDescriptionText(java.lang.String descriptionText)

The text description to accompany the promoted item.

Parameters:

descriptionText - descriptionText or null for none

getDestinationUrl

public java.lang.String getDestinationUrl()

The URL the client should direct the user to, if the user chooses to visit the advertiser's website.

Returns:

value or null for none

setDestinationUrl

public ActivityContentDetailsPromotedItem setDestinationUrl(java.lang.String destinationUrl)

The URL the client should direct the user to, if the user chooses to visit the advertiser's website.

Parameters:

destinationUrl - destinationUrl or null for none

getForecastingUrl

public java.util.List<java.lang.String> getForecastingUrl()

The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.

Returns:

value or null for none

setForecastingUrl

public ActivityContentDetailsPromotedItem setForecastingUrl(java.util.List<java.lang.String> forecastingUrl)

The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.

Parameters:

forecastingUrl - forecastingUrl or null for none

getImpressionUrl

public java.util.List<java.lang.String> getImpressionUrl()

The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.

Returns:

value or null for none

setImpressionUrl

public ActivityContentDetailsPromotedItem setImpressionUrl(java.util.List<java.lang.String> impressionUrl)

The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.

Parameters:

impressionUrl - impressionUrl or null for none

getVideoId

public java.lang.String getVideoId()

The ID that YouTube uses to uniquely identify the promoted video.

Returns:

value or null for none

setVideoId

public ActivityContentDetailsPromotedItem setVideoId(java.lang.String videoId)

The ID that YouTube uses to uniquely identify the promoted video.

Parameters:

videoId - videoId or null for none

set

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

Overrides:

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

clone

public ActivityContentDetailsPromotedItem clone()

Overrides:

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