youtube  v3
Public Member Functions | Static Public Member Functions | List of all members
google_youtube_api::ActivityContentDetailsPromotedItem Class Reference

#include <activity_content_details_promoted_item.h>

Inheritance diagram for google_youtube_api::ActivityContentDetailsPromotedItem:

Public Member Functions

 ActivityContentDetailsPromotedItem (const Json::Value &storage)
 
 ActivityContentDetailsPromotedItem (Json::Value *storage)
 
virtual ~ActivityContentDetailsPromotedItem ()
 
const StringPiece GetTypeName () const
 
bool has_ad_tag () const
 
void clear_ad_tag ()
 
const StringPiece get_ad_tag () const
 
void set_ad_tag (const StringPiece &value)
 
bool has_click_tracking_url () const
 
void clear_click_tracking_url ()
 
const StringPiece get_click_tracking_url () const
 
void set_click_tracking_url (const StringPiece &value)
 
bool has_creative_view_url () const
 
void clear_creative_view_url ()
 
const StringPiece get_creative_view_url () const
 
void set_creative_view_url (const StringPiece &value)
 
bool has_cta_type () const
 
void clear_cta_type ()
 
const StringPiece get_cta_type () const
 
void set_cta_type (const StringPiece &value)
 
bool has_custom_cta_button_text () const
 
void clear_custom_cta_button_text ()
 
const StringPiece get_custom_cta_button_text () const
 
void set_custom_cta_button_text (const StringPiece &value)
 
bool has_description_text () const
 
void clear_description_text ()
 
const StringPiece get_description_text () const
 
void set_description_text (const StringPiece &value)
 
bool has_destination_url () const
 
void clear_destination_url ()
 
const StringPiece get_destination_url () const
 
void set_destination_url (const StringPiece &value)
 
bool has_forecasting_url () const
 
void clear_forecasting_url ()
 
const client::JsonCppArray< string > get_forecasting_url () const
 
client::JsonCppArray< string > mutable_forecastingUrl ()
 
bool has_impression_url () const
 
void clear_impression_url ()
 
const client::JsonCppArray< string > get_impression_url () const
 
client::JsonCppArray< string > mutable_impressionUrl ()
 
bool has_video_id () const
 
void clear_video_id ()
 
const StringPiece get_video_id () const
 
void set_video_id (const StringPiece &value)
 

Static Public Member Functions

static ActivityContentDetailsPromotedItemNew ()
 

Detailed Description

Details about a resource which is being promoted.

Constructor & Destructor Documentation

◆ ActivityContentDetailsPromotedItem() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ ActivityContentDetailsPromotedItem() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~ActivityContentDetailsPromotedItem()

google_youtube_api::ActivityContentDetailsPromotedItem::~ActivityContentDetailsPromotedItem ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_ad_tag()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_ad_tag ( )
inline

Clears the 'adTag' attribute.

◆ clear_click_tracking_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_click_tracking_url ( )
inline

Clears the 'clickTrackingUrl' attribute.

◆ clear_creative_view_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_creative_view_url ( )
inline

Clears the 'creativeViewUrl' attribute.

◆ clear_cta_type()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_cta_type ( )
inline

Clears the 'ctaType' attribute.

◆ clear_custom_cta_button_text()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_custom_cta_button_text ( )
inline

Clears the 'customCtaButtonText' attribute.

◆ clear_description_text()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_description_text ( )
inline

Clears the 'descriptionText' attribute.

◆ clear_destination_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_destination_url ( )
inline

Clears the 'destinationUrl' attribute.

◆ clear_forecasting_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_forecasting_url ( )
inline

Clears the 'forecastingUrl' attribute.

◆ clear_impression_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_impression_url ( )
inline

Clears the 'impressionUrl' attribute.

◆ clear_video_id()

void google_youtube_api::ActivityContentDetailsPromotedItem::clear_video_id ( )
inline

Clears the 'videoId' attribute.

◆ get_ad_tag()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_ad_tag ( ) const
inline

Get the value of the 'adTag' attribute.

◆ get_click_tracking_url()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_click_tracking_url ( ) const
inline

Get the value of the 'clickTrackingUrl' attribute.

◆ get_creative_view_url()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_creative_view_url ( ) const
inline

Get the value of the 'creativeViewUrl' attribute.

◆ get_cta_type()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_cta_type ( ) const
inline

Get the value of the 'ctaType' attribute.

◆ get_custom_cta_button_text()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_custom_cta_button_text ( ) const
inline

Get the value of the 'customCtaButtonText' attribute.

◆ get_description_text()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_description_text ( ) const
inline

Get the value of the 'descriptionText' attribute.

◆ get_destination_url()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_destination_url ( ) const
inline

Get the value of the 'destinationUrl' attribute.

◆ get_forecasting_url()

const client::JsonCppArray<string > google_youtube_api::ActivityContentDetailsPromotedItem::get_forecasting_url ( ) const
inline

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

◆ get_impression_url()

const client::JsonCppArray<string > google_youtube_api::ActivityContentDetailsPromotedItem::get_impression_url ( ) const
inline

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

◆ get_video_id()

const StringPiece google_youtube_api::ActivityContentDetailsPromotedItem::get_video_id ( ) const
inline

Get the value of the 'videoId' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::ActivityContentDetailsPromotedItem

◆ has_ad_tag()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_ad_tag ( ) const
inline

Determine if the 'adTag' attribute was set.

Returns
true if the 'adTag' attribute was set.

◆ has_click_tracking_url()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_click_tracking_url ( ) const
inline

Determine if the 'clickTrackingUrl' attribute was set.

Returns
true if the 'clickTrackingUrl' attribute was set.

◆ has_creative_view_url()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_creative_view_url ( ) const
inline

Determine if the 'creativeViewUrl' attribute was set.

Returns
true if the 'creativeViewUrl' attribute was set.

◆ has_cta_type()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_cta_type ( ) const
inline

Determine if the 'ctaType' attribute was set.

Returns
true if the 'ctaType' attribute was set.

◆ has_custom_cta_button_text()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_custom_cta_button_text ( ) const
inline

Determine if the 'customCtaButtonText' attribute was set.

Returns
true if the 'customCtaButtonText' attribute was set.

◆ has_description_text()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_description_text ( ) const
inline

Determine if the 'descriptionText' attribute was set.

Returns
true if the 'descriptionText' attribute was set.

◆ has_destination_url()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_destination_url ( ) const
inline

Determine if the 'destinationUrl' attribute was set.

Returns
true if the 'destinationUrl' attribute was set.

◆ has_forecasting_url()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_forecasting_url ( ) const
inline

Determine if the 'forecastingUrl' attribute was set.

Returns
true if the 'forecastingUrl' attribute was set.

◆ has_impression_url()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_impression_url ( ) const
inline

Determine if the 'impressionUrl' attribute was set.

Returns
true if the 'impressionUrl' attribute was set.

◆ has_video_id()

bool google_youtube_api::ActivityContentDetailsPromotedItem::has_video_id ( ) const
inline

Determine if the 'videoId' attribute was set.

Returns
true if the 'videoId' attribute was set.

◆ mutable_forecastingUrl()

client::JsonCppArray<string > google_youtube_api::ActivityContentDetailsPromotedItem::mutable_forecastingUrl ( )
inline

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

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

◆ mutable_impressionUrl()

client::JsonCppArray<string > google_youtube_api::ActivityContentDetailsPromotedItem::mutable_impressionUrl ( )
inline

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

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

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

◆ New()

ActivityContentDetailsPromotedItem * google_youtube_api::ActivityContentDetailsPromotedItem::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_ad_tag()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_ad_tag ( const StringPiece &  value)
inline

Change the 'adTag' attribute.

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

Parameters
[in]valueThe new value.

◆ set_click_tracking_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_click_tracking_url ( const StringPiece &  value)
inline

Change the 'clickTrackingUrl' attribute.

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

Parameters
[in]valueThe new value.

◆ set_creative_view_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_creative_view_url ( const StringPiece &  value)
inline

Change the 'creativeViewUrl' attribute.

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

Parameters
[in]valueThe new value.

◆ set_cta_type()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_cta_type ( const StringPiece &  value)
inline

Change the 'ctaType' attribute.

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

Parameters
[in]valueThe new value.

◆ set_custom_cta_button_text()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_custom_cta_button_text ( const StringPiece &  value)
inline

Change the 'customCtaButtonText' attribute.

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

Parameters
[in]valueThe new value.

◆ set_description_text()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_description_text ( const StringPiece &  value)
inline

Change the 'descriptionText' attribute.

The text description to accompany the promoted item.

Parameters
[in]valueThe new value.

◆ set_destination_url()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_destination_url ( const StringPiece &  value)
inline

Change the 'destinationUrl' attribute.

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

Parameters
[in]valueThe new value.

◆ set_video_id()

void google_youtube_api::ActivityContentDetailsPromotedItem::set_video_id ( const StringPiece &  value)
inline

Change the 'videoId' attribute.

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

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: