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



8438
8439
8440
# File 'generated/google/apis/youtube_v3/classes.rb', line 8438

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)


8392
8393
8394
# File 'generated/google/apis/youtube_v3/classes.rb', line 8392

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)


8399
8400
8401
# File 'generated/google/apis/youtube_v3/classes.rb', line 8399

def failure_reason
  @failure_reason
end

#licenseString

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

Returns:

  • (String)


8404
8405
8406
# File 'generated/google/apis/youtube_v3/classes.rb', line 8404

def license
  @license
end

#privacy_statusString

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

Returns:

  • (String)


8409
8410
8411
# File 'generated/google/apis/youtube_v3/classes.rb', line 8409

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)


8416
8417
8418
# File 'generated/google/apis/youtube_v3/classes.rb', line 8416

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)


8424
8425
8426
# File 'generated/google/apis/youtube_v3/classes.rb', line 8424

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)


8431
8432
8433
# File 'generated/google/apis/youtube_v3/classes.rb', line 8431

def rejection_reason
  @rejection_reason
end

#upload_statusString

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

Returns:

  • (String)


8436
8437
8438
# File 'generated/google/apis/youtube_v3/classes.rb', line 8436

def upload_status
  @upload_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
# File 'generated/google/apis/youtube_v3/classes.rb', line 8443

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