Class: Zernio::UpdateAdRequestCreative

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

Overview

Replace the ad's creative. Meta + TikTok only. - Meta: requires headline, body, callToAction, linkUrl, imageUrl. The ad's existing creative is replaced via a new /act_X/adcreatives upload + ad update. The old creative is retained on the ad account for historical reporting. - TikTok: patch-style. Pass any subset; headline is ignored (TikTok creatives have no headline slot). body becomes the in-feed ad_text; linkUrl becomes landing_page_url; videoUrl triggers a fresh upload.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 74

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

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

  if attributes.key?(:'call_to_action')
    self.call_to_action = attributes[:'call_to_action']
  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
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#call_to_action ⇒ Object

Returns the value of attribute call_to_action.



24
25
26
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 24

def call_to_action
  @call_to_action
end

#headline ⇒ Object

Meta only



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

def headline
  @headline
end

#image_url ⇒ Object

Returns the value of attribute image_url.



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

def image_url
  @image_url
end

#link_url ⇒ Object

Returns the value of attribute link_url.



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

def link_url
  @link_url
end

#video_url ⇒ Object

Returns the value of attribute video_url.



30
31
32
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 30

def video_url
  @video_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 33

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 156

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



67
68
69
70
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 55

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 130

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 149

def hash
  [headline, body, call_to_action, link_url, image_url, video_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



115
116
117
118
119
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 115

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 178

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



123
124
125
126
 
# File 'lib/zernio-sdk/models/update_ad_request_creative.rb', line 123

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end