com.google.api.services.youtube.model

Class PromotedItem

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.youtube.model.PromotedItem

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PromotedItem
extends GenericJson

Describes a single promoted item.

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

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

Method Summary

Modifier and Type	Method and Description
PromotedItem	clone()
String	getCustomMessage() A custom message to display for this promotion.
PromotedItemId	getId() Identifies the promoted item.
Boolean	getPromotedByContentOwner() If true, the content owner's name will be used when displaying the promotion.
InvideoTiming	getTiming() The temporal position within the video where the promoted item will be displayed.
PromotedItem	set(String fieldName, Object value)
PromotedItem	setCustomMessage(String customMessage) A custom message to display for this promotion.
PromotedItem	setId(PromotedItemId id) Identifies the promoted item.
PromotedItem	setPromotedByContentOwner(Boolean promotedByContentOwner) If true, the content owner's name will be used when displaying the promotion.
PromotedItem	setTiming(InvideoTiming timing) The temporal position within the video where the promoted item will be displayed.

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

PromotedItem

public PromotedItem()

Method Detail

getCustomMessage

public String getCustomMessage()

A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

Returns:

value or null for none

setCustomMessage

public PromotedItem setCustomMessage(String customMessage)

A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

Parameters:

customMessage - customMessage or null for none

getId

public PromotedItemId getId()

Identifies the promoted item.

Returns:

value or null for none

setId

public PromotedItem setId(PromotedItemId id)

Identifies the promoted item.

Parameters:

id - id or null for none

getPromotedByContentOwner

public Boolean getPromotedByContentOwner()

If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

Returns:

value or null for none

setPromotedByContentOwner

public PromotedItem setPromotedByContentOwner(Boolean promotedByContentOwner)

If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

Parameters:

promotedByContentOwner - promotedByContentOwner or null for none

getTiming

public InvideoTiming getTiming()

The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

Returns:

value or null for none

setTiming

public PromotedItem setTiming(InvideoTiming timing)

The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

Parameters:

timing - timing or null for none

set

public PromotedItem set(String fieldName,
                        Object value)

Overrides:

set in class GenericJson

clone

public PromotedItem clone()

Overrides:

clone in class GenericJson