youtube  v3
Public Member Functions | Static Public Member Functions | List of all members
google_youtube_api::InvideoPromotion Class Reference
YouTube Data API Data Objects

#include <invideo_promotion.h>

Inheritance diagram for google_youtube_api::InvideoPromotion:

Public Member Functions

 InvideoPromotion (const Json::Value &storage)
 
 InvideoPromotion (Json::Value *storage)
 
virtual ~InvideoPromotion ()
 
const StringPiece GetTypeName () const
 
bool has_default_timing () const
 
void clear_default_timing ()
 
const InvideoTiming get_default_timing () const
 
InvideoTiming mutable_defaultTiming ()
 
bool has_items () const
 
void clear_items ()
 
const client::JsonCppArray< PromotedItem > get_items () const
 
client::JsonCppArray< PromotedItem > mutable_items ()
 
bool has_position () const
 
void clear_position ()
 
const InvideoPosition get_position () const
 
InvideoPosition mutable_position ()
 
bool has_use_smart_timing () const
 
void clear_use_smart_timing ()
 
bool get_use_smart_timing () const
 
void set_use_smart_timing (bool value)
 

Static Public Member Functions

static InvideoPromotion * New ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ InvideoPromotion() [1/2]

google_youtube_api::InvideoPromotion::InvideoPromotion ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ InvideoPromotion() [2/2]

google_youtube_api::InvideoPromotion::InvideoPromotion ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~InvideoPromotion()

google_youtube_api::InvideoPromotion::~InvideoPromotion ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_default_timing()

void google_youtube_api::InvideoPromotion::clear_default_timing ( )
inline

Clears the 'defaultTiming' attribute.

◆ clear_items()

void google_youtube_api::InvideoPromotion::clear_items ( )
inline

Clears the 'items' attribute.

◆ clear_position()

void google_youtube_api::InvideoPromotion::clear_position ( )
inline

Clears the 'position' attribute.

◆ clear_use_smart_timing()

void google_youtube_api::InvideoPromotion::clear_use_smart_timing ( )
inline

Clears the 'useSmartTiming' attribute.

◆ get_default_timing()

const InvideoTiming google_youtube_api::InvideoPromotion::get_default_timing ( ) const

Get a reference to the value of the 'defaultTiming' attribute.

◆ get_items()

const client::JsonCppArray<PromotedItem > google_youtube_api::InvideoPromotion::get_items ( ) const

Get a reference to the value of the 'items' attribute.

◆ get_position()

const InvideoPosition google_youtube_api::InvideoPromotion::get_position ( ) const

Get a reference to the value of the 'position' attribute.

◆ get_use_smart_timing()

bool google_youtube_api::InvideoPromotion::get_use_smart_timing ( ) const
inline

Get the value of the 'useSmartTiming' attribute.

◆ GetTypeName()

const StringPiece google_youtube_api::InvideoPromotion::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_youtube_api::InvideoPromotion

◆ has_default_timing()

bool google_youtube_api::InvideoPromotion::has_default_timing ( ) const
inline

Determine if the 'defaultTiming' attribute was set.

Returns
true if the 'defaultTiming' attribute was set.

◆ has_items()

bool google_youtube_api::InvideoPromotion::has_items ( ) const
inline

Determine if the 'items' attribute was set.

Returns
true if the 'items' attribute was set.

◆ has_position()

bool google_youtube_api::InvideoPromotion::has_position ( ) const
inline

Determine if the 'position' attribute was set.

Returns
true if the 'position' attribute was set.

◆ has_use_smart_timing()

bool google_youtube_api::InvideoPromotion::has_use_smart_timing ( ) const
inline

Determine if the 'useSmartTiming' attribute was set.

Returns
true if the 'useSmartTiming' attribute was set.

◆ mutable_defaultTiming()

InvideoTiming google_youtube_api::InvideoPromotion::mutable_defaultTiming ( )

Gets a reference to a mutable value of the 'defaultTiming' property.

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
The result can be modified to change the attribute value.

◆ mutable_items()

client::JsonCppArray<PromotedItem > google_youtube_api::InvideoPromotion::mutable_items ( )

Gets a reference to a mutable value of the 'items' property.

List of promoted items in decreasing priority.

Returns
The result can be modified to change the attribute value.

◆ mutable_position()

InvideoPosition google_youtube_api::InvideoPromotion::mutable_position ( )

Gets a reference to a mutable value of the 'position' property.

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

Returns
The result can be modified to change the attribute value.

◆ New()

InvideoPromotion * google_youtube_api::InvideoPromotion::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_use_smart_timing()

void google_youtube_api::InvideoPromotion::set_use_smart_timing ( bool  value)
inline

Change the 'useSmartTiming' attribute.

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
[in]valueThe new value.
The documentation for this class was generated from the following files: