Class: Zernio::CtwaAdRequestBodyCreativesInner

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

Overview

Supply headline, body, and image/video, or exactly one existing post reference. References cannot be combined with fresh creative fields.

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

Initializes the object



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/ctwa_ad_request_body_creatives_inner.rb', line 108

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

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

  if attributes.key?(:'creative_features')
    if (value = attributes[:'creative_features']).is_a?(Hash)
      self.creative_features = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

Primary text shown above the image / video.



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

def body
  @body
end

#creative_features ⇒ Object

Replaces the top-level creativeFeatures map for this item. Omit to inherit; an empty object clears inherited enrollment choices.



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

def creative_features
  @creative_features
end

#existing_post_id ⇒ Object

Messaging and CTWA only. Platform post or reel ID, resolved like boost platformPostId. Facebook IDs become object_story_id; Instagram IDs become source_instagram_media_id using the connected Instagram identity. Mutually exclusive with objectStoryId and fresh creative fields.



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

def existing_post_id
  @existing_post_id
end

#headline ⇒ Object

Returns the value of attribute headline.



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

def headline
  @headline
end

#image_url ⇒ Object

Image asset. Mutually exclusive with this entry's video. Required if neither video nor an existing post reference is supplied.



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

def image_url
  @image_url
end

#object_story_id ⇒ Object

Messaging and CTWA only. Raw Facebook pageId_postId reference, used as object_story_id even with an Instagram account. Mutually exclusive with existingPostId and fresh creative fields.



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

def object_story_id
  @object_story_id
end

#video ⇒ Object

Returns the value of attribute video.



36
37
38
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 36

def video
  @video
end

#welcome_message ⇒ Object

Returns the value of attribute welcome_message.



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

def welcome_message
  @welcome_message
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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
74
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 63

def self.attribute_map
  {
    :'existing_post_id' => :'existingPostId',
    :'object_story_id' => :'objectStoryId',
    :'creative_features' => :'creativeFeatures',
    :'headline' => :'headline',
    :'body' => :'body',
    :'image_url' => :'imageUrl',
    :'video' => :'video',
    :'welcome_message' => :'welcomeMessage'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 289

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



101
102
103
104
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'existing_post_id' => :'String',
    :'object_story_id' => :'String',
    :'creative_features' => :'Hash<String, String>',
    :'headline' => :'String',
    :'body' => :'String',
    :'image_url' => :'String',
    :'video' => :'CtwaAdRequestBodyCreativesInnerVideo',
    :'welcome_message' => :'CtwaAdRequestBodyCreativesInnerWelcomeMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      existing_post_id == o.existing_post_id &&
      object_story_id == o.object_story_id &&
      creative_features == o.creative_features &&
      headline == o.headline &&
      body == o.body &&
      image_url == o.image_url &&
      video == o.video &&
      welcome_message == o.welcome_message
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


276
277
278
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



282
283
284
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 282

def hash
  [existing_post_id, object_story_id, creative_features, headline, body, image_url, video, welcome_message].hash
end

#list_invalid_properties ⇒ Object

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 159

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

  pattern = Regexp.new(/^\d+_\d+$/)
  if !@object_story_id.nil? && @object_story_id !~ pattern
    invalid_properties.push("invalid value for \"object_story_id\", must conform to the pattern #{pattern}.")
  end

  if !@headline.nil? && @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 !@headline.nil? && @headline.to_s.length < 1
    invalid_properties.push('invalid value for "headline", the character length must be greater than or equal to 1.')
  end

  if !@body.nil? && @body.to_s.length < 1
    invalid_properties.push('invalid value for "body", the character length must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 311

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



188
189
190
191
192
193
194
195
196
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb', line 188

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@existing_post_id.nil? && @existing_post_id.to_s.length < 1
  return false if !@object_story_id.nil? && @object_story_id !~ Regexp.new(/^\d+_\d+$/)
  return false if !@headline.nil? && @headline.to_s.length > 255
  return false if !@headline.nil? && @headline.to_s.length < 1
  return false if !@body.nil? && @body.to_s.length < 1
  true
end