com.google.api.services.youtube.model

Class InvideoPromotion

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class InvideoPromotion
extends GenericJson

Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id.

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

Method Summary

Modifier and Type	Method and Description
InvideoPromotion	clone()
InvideoTiming	getDefaultTiming() The default temporal position within the video where the promoted item will be displayed.
List<PromotedItem>	getItems() List of promoted items in decreasing priority.
InvideoPosition	getPosition() The spatial position within the video where the promoted item will be displayed.
Boolean	getUseSmartTiming() Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience.
InvideoPromotion	set(String fieldName, Object value)
InvideoPromotion	setDefaultTiming(InvideoTiming defaultTiming) The default temporal position within the video where the promoted item will be displayed.
InvideoPromotion	setItems(List<PromotedItem> items) List of promoted items in decreasing priority.
InvideoPromotion	setPosition(InvideoPosition position) The spatial position within the video where the promoted item will be displayed.
InvideoPromotion	setUseSmartTiming(Boolean useSmartTiming) Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience.

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

InvideoPromotion

public InvideoPromotion()

Method Detail

getDefaultTiming

public InvideoTiming getDefaultTiming()

The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.

Returns:

value or null for none

setDefaultTiming

public InvideoPromotion setDefaultTiming(InvideoTiming defaultTiming)

The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.

Parameters:

defaultTiming - defaultTiming or null for none

getItems

public List<PromotedItem> getItems()

List of promoted items in decreasing priority.

Returns:

value or null for none

setItems

public InvideoPromotion setItems(List<PromotedItem> items)

List of promoted items in decreasing priority.

Parameters:

items - items or null for none

getPosition

public InvideoPosition getPosition()

The spatial position within the video where the promoted item will be displayed.

Returns:

value or null for none

setPosition

public InvideoPromotion setPosition(InvideoPosition position)

The spatial position within the video where the promoted item will be displayed.

Parameters:

position - position or null for none

getUseSmartTiming

public Boolean getUseSmartTiming()

Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.

Returns:

value or null for none

setUseSmartTiming

public InvideoPromotion setUseSmartTiming(Boolean useSmartTiming)

Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.

Parameters:

useSmartTiming - useSmartTiming or null for none

set

public InvideoPromotion set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public InvideoPromotion clone()

Overrides:

clone in class GenericJson