Class: Google::Apis::YoutubeV3::PromotedItem

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_v3/classes.rb,
generated/google/apis/youtube_v3/representations.rb,
generated/google/apis/youtube_v3/representations.rb

Overview

Describes a single promoted item.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PromotedItem

Returns a new instance of PromotedItem



5972
5973
5974
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5972

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#custom_message ⇒ String

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

Returns:

  • (String) 


5952
5953
5954
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5952

def custom_message
  @custom_message
end

#id ⇒ Google::Apis::YoutubeV3::PromotedItemId

Describes a single promoted item id. It is a union of various possible types. Corresponds to the JSON property id

Returns:



5957
5958
5959
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5957

def id
  @id
end

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. Corresponds to the JSON property promotedByContentOwner

Returns:

  • (Boolean) 


5964
5965
5966
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5964

def promoted_by_content_owner
  @promoted_by_content_owner
end

#timing ⇒ Google::Apis::YoutubeV3::InvideoTiming

Describes a temporal position of a visual widget inside a video. Corresponds to the JSON property timing

Returns:



5970
5971
5972
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5970

def timing
  @timing
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5977
5978
5979
5980
5981
5982
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5977

def update!(**args)
  @custom_message = args[:custom_message] if args.key?(:custom_message)
  @id = args[:id] if args.key?(:id)
  @promoted_by_content_owner = args[:promoted_by_content_owner] if args.key?(:promoted_by_content_owner)
  @timing = args[:timing] if args.key?(:timing)
end