Class: Google::Apis::YoutubeV3::PromotedItem
- Inherits:
-
Object
- Object
- Google::Apis::YoutubeV3::PromotedItem
- 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
-
#custom_message ⇒ String
A custom message to display for this promotion.
-
#id ⇒ Google::Apis::YoutubeV3::PromotedItemId
Describes a single promoted item id.
-
#promoted_by_content_owner ⇒ Boolean
(also: #promoted_by_content_owner?)
If true, the content owner's name will be used when displaying the promotion.
-
#timing ⇒ Google::Apis::YoutubeV3::InvideoTiming
Describes a temporal position of a visual widget inside a video.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PromotedItem
constructor
A new instance of PromotedItem.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PromotedItem
Returns a new instance of PromotedItem
6220 6221 6222 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 6220 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
6200 6201 6202 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 6200 def @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
6205 6206 6207 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 6205 def id @id end |
#promoted_by_content_owner ⇒ Boolean Also known as: promoted_by_content_owner?
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
6212 6213 6214 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 6212 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
6218 6219 6220 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 6218 def timing @timing end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6225 6226 6227 6228 6229 6230 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 6225 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 |