Class: Zernio::YouTubePlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/you_tube_platform_data.rb

Overview

Videos under 3 min auto-detected as Shorts. Custom thumbnails for regular videos only. Scheduled videos are uploaded immediately with the specified visibility.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ YouTubePlatformData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::YouTubePlatformData` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::YouTubePlatformData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'visibility')
    self.visibility = attributes[:'visibility']
  else
    self.visibility = 'public'
  end

  if attributes.key?(:'made_for_kids')
    self.made_for_kids = attributes[:'made_for_kids']
  else
    self.made_for_kids = false
  end

  if attributes.key?(:'first_comment')
    self.first_comment = attributes[:'first_comment']
  end

  if attributes.key?(:'contains_synthetic_media')
    self.contains_synthetic_media = attributes[:'contains_synthetic_media']
  else
    self.contains_synthetic_media = false
  end

  if attributes.key?(:'category_id')
    self.category_id = attributes[:'category_id']
  else
    self.category_id = '22'
  end

  if attributes.key?(:'playlist_id')
    self.playlist_id = attributes[:'playlist_id']
  end
end

Instance Attribute Details

#category_id ⇒ Object

YouTube video category ID. Defaults to 22 (People & Blogs). Common: 1 (Film), 2 (Autos), 10 (Music), 15 (Pets), 17 (Sports), 20 (Gaming), 23 (Comedy), 24 (Entertainment), 25 (News), 26 (Howto), 27 (Education), 28 (Science & Tech).



35
36
37
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 35

def category_id
  @category_id
end

#contains_synthetic_media ⇒ Object

AI-generated content disclosure. Set true if the video contains synthetic content that could be mistaken for real. YouTube may add a label.



32
33
34
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 32

def contains_synthetic_media
  @contains_synthetic_media
end

#first_comment ⇒ Object

Optional first comment to post immediately after video upload. Up to 10,000 characters (YouTube's comment limit).



29
30
31
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 29

def first_comment
  @first_comment
end

#made_for_kids ⇒ Object

COPPA compliance flag. Set true for child-directed content (restricts comments, notifications, ad targeting). Defaults to false. YouTube may block views if not explicitly set.



26
27
28
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 26

def made_for_kids
  @made_for_kids
end

#playlist_id ⇒ Object

Optional YouTube playlist ID to add the video to after upload (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/id/youtube-playlists to list available playlists. Works for both immediate and scheduled uploads. Quota cost: 50 YouTube API units per call.



38
39
40
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 38

def playlist_id
  @playlist_id
end

#title ⇒ Object

Video title. Defaults to first line of content or "Untitled Video". Must be ≤ 100 characters.



20
21
22
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 20

def title
  @title
end

#visibility ⇒ Object

Video visibility: public (default, anyone can watch), unlisted (link only), private (invite only)



23
24
25
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 23

def visibility
  @visibility
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 63

def self.attribute_map
  {
    :'title' => :'title',
    :'visibility' => :'visibility',
    :'made_for_kids' => :'madeForKids',
    :'first_comment' => :'firstComment',
    :'contains_synthetic_media' => :'containsSyntheticMedia',
    :'category_id' => :'categoryId',
    :'playlist_id' => :'playlistId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 251

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 99

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 86

def self.openapi_types
  {
    :'title' => :'String',
    :'visibility' => :'String',
    :'made_for_kids' => :'Boolean',
    :'first_comment' => :'String',
    :'contains_synthetic_media' => :'Boolean',
    :'category_id' => :'String',
    :'playlist_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      visibility == o.visibility &&
      made_for_kids == o.made_for_kids &&
      first_comment == o.first_comment &&
      contains_synthetic_media == o.contains_synthetic_media &&
      category_id == o.category_id &&
      playlist_id == o.playlist_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 244

def hash
  [title, visibility, made_for_kids, first_comment, contains_synthetic_media, category_id, playlist_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 100
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 100.')
  end

  if !@first_comment.nil? && @first_comment.to_s.length > 10000
    invalid_properties.push('invalid value for "first_comment", the character length must be smaller than or equal to 10000.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 273

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



175
176
177
178
179
180
181
182
 
# File 'lib/zernio-sdk/models/you_tube_platform_data.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 100
  visibility_validator = EnumAttributeValidator.new('String', ["public", "private", "unlisted"])
  return false unless visibility_validator.valid?(@visibility)
  return false if !@first_comment.nil? && @first_comment.to_s.length > 10000
  true
end