Class: Google::Apis::YoutubeV3::VideoStatus

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

Basic details about a video category, such as its localized title.

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) ⇒ VideoStatus

Returns a new instance of VideoStatus



8377
8378
8379
# File 'generated/google/apis/youtube_v3/classes.rb', line 8377

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

Instance Attribute Details

#embeddableBoolean Also known as: embeddable?

This value indicates if the video can be embedded on another website. Corresponds to the JSON property embeddable

Returns:

  • (Boolean)


8331
8332
8333
# File 'generated/google/apis/youtube_v3/classes.rb', line 8331

def embeddable
  @embeddable
end

#failure_reasonString

This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. Corresponds to the JSON property failureReason

Returns:

  • (String)


8338
8339
8340
# File 'generated/google/apis/youtube_v3/classes.rb', line 8338

def failure_reason
  @failure_reason
end

#licenseString

The video's license. Corresponds to the JSON property license

Returns:

  • (String)


8343
8344
8345
# File 'generated/google/apis/youtube_v3/classes.rb', line 8343

def license
  @license
end

#privacy_statusString

The video's privacy status. Corresponds to the JSON property privacyStatus

Returns:

  • (String)


8348
8349
8350
# File 'generated/google/apis/youtube_v3/classes.rb', line 8348

def privacy_status
  @privacy_status
end

#public_stats_viewableBoolean Also known as: public_stats_viewable?

This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. Corresponds to the JSON property publicStatsViewable

Returns:

  • (Boolean)


8355
8356
8357
# File 'generated/google/apis/youtube_v3/classes.rb', line 8355

def public_stats_viewable
  @public_stats_viewable
end

#publish_atDateTime

The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property publishAt

Returns:

  • (DateTime)


8363
8364
8365
# File 'generated/google/apis/youtube_v3/classes.rb', line 8363

def publish_at
  @publish_at
end

#rejection_reasonString

This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. Corresponds to the JSON property rejectionReason

Returns:

  • (String)


8370
8371
8372
# File 'generated/google/apis/youtube_v3/classes.rb', line 8370

def rejection_reason
  @rejection_reason
end

#upload_statusString

The status of the uploaded video. Corresponds to the JSON property uploadStatus

Returns:

  • (String)


8375
8376
8377
# File 'generated/google/apis/youtube_v3/classes.rb', line 8375

def upload_status
  @upload_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
# File 'generated/google/apis/youtube_v3/classes.rb', line 8382

def update!(**args)
  @embeddable = args[:embeddable] if args.key?(:embeddable)
  @failure_reason = args[:failure_reason] if args.key?(:failure_reason)
  @license = args[:license] if args.key?(:license)
  @privacy_status = args[:privacy_status] if args.key?(:privacy_status)
  @public_stats_viewable = args[:public_stats_viewable] if args.key?(:public_stats_viewable)
  @publish_at = args[:publish_at] if args.key?(:publish_at)
  @rejection_reason = args[:rejection_reason] if args.key?(:rejection_reason)
  @upload_status = args[:upload_status] if args.key?(:upload_status)
end