Class: Zernio::CreateStandaloneAdRequestTranslationsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb

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 = {}) ⇒ CreateStandaloneAdRequestTranslationsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CreateStandaloneAdRequestTranslationsInner` 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::CreateStandaloneAdRequestTranslationsInner`. 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?(:'locale')
    self.locale = attributes[:'locale']
  else
    self.locale = nil
  end

  if attributes.key?(:'headline')
    self.headline = attributes[:'headline']
  else
    self.headline = nil
  end

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  else
    self.body = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = nil
  end

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

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

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

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

Instance Attribute Details

#body ⇒ Object

Primary text for this language. REQUIRED, and must differ from every other locale and from the ad's top-level body.



25
26
27
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 25

def body
  @body
end

#description ⇒ Object

Link description for this language. REQUIRED, and must differ from every other locale and from the ad's top-level description.



28
29
30
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 28

def description
  @description
end

#headline ⇒ Object

Headline for this language. REQUIRED, and must differ from every other locale and from the ad's top-level headline.



22
23
24
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 22

def headline
  @headline
end

#image_url ⇒ Object

Image for this language. Inherits the ad's imageUrl when omitted. The feed is all-image OR all-video.



34
35
36
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 34

def image_url
  @image_url
end

#link_url ⇒ Object

Destination URL for this language. Inherits the ad's top-level linkUrl when omitted, and requires it to be present (400 otherwise): the top-level URL is the destination for every locale you did not override. Unlike text, identical URLs across locales are fine (they share one asset).



31
32
33
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 31

def link_url
  @link_url
end

#locale ⇒ Object

Language code, resolved to Meta's numeric locale id. Bare codes target the '(All)' umbrella (es = every Spanish variant); region-qualified codes target the variant (pt_BR, en_GB).



19
20
21
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 19

def locale
  @locale
end

#thumbnail_url ⇒ Object

Poster frame for this language's video.



40
41
42
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 40

def thumbnail_url
  @thumbnail_url
end

#video_url ⇒ Object

Video for this language. Inherits the ad's video.url when omitted. The feed is all-image OR all-video.



37
38
39
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 37

def video_url
  @video_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



57
58
59
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 57

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 62

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 43

def self.attribute_map
  {
    :'locale' => :'locale',
    :'headline' => :'headline',
    :'body' => :'body',
    :'description' => :'description',
    :'link_url' => :'linkUrl',
    :'image_url' => :'imageUrl',
    :'video_url' => :'videoUrl',
    :'thumbnail_url' => :'thumbnailUrl'
  }
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 266

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 67

def self.openapi_types
  {
    :'locale' => :'String',
    :'headline' => :'String',
    :'body' => :'String',
    :'description' => :'String',
    :'link_url' => :'String',
    :'image_url' => :'String',
    :'video_url' => :'String',
    :'thumbnail_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      locale == o.locale &&
      headline == o.headline &&
      body == o.body &&
      description == o.description &&
      link_url == o.link_url &&
      image_url == o.image_url &&
      video_url == o.video_url &&
      thumbnail_url == o.thumbnail_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 259

def hash
  [locale, headline, body, description, link_url, image_url, video_url, thumbnail_url].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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 145

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @locale.nil?
    invalid_properties.push('invalid value for "locale", locale cannot be nil.')
  end

  if @headline.nil?
    invalid_properties.push('invalid value for "headline", headline cannot be nil.')
  end

  if @headline.to_s.length > 255
    invalid_properties.push('invalid value for "headline", the character length must be smaller than or equal to 255.')
  end

  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @description.to_s.length > 255
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
  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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 288

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



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_translations_inner.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @locale.nil?
  return false if @headline.nil?
  return false if @headline.to_s.length > 255
  return false if @body.nil?
  return false if @description.nil?
  return false if @description.to_s.length > 255
  true
end