Class: Zernio::UpdateAdRequest

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 111

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_group ⇒ Object

Google Performance Max only. Replaces whole asset roles on the ad's asset group. Returns 422 on any other platform or channel.



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

def asset_group
  @asset_group
end

#budget ⇒ Object

Returns the value of attribute budget.



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

def budget
  @budget
end

#creative ⇒ Object

Returns the value of attribute creative.



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

def creative
  @creative
end

#descriptions ⇒ Object

Google Search and Display only. Replaces the complete description list. Search takes 2-4, Display 1-5 and rejects pinnedField. No padding or truncation on update.



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

def descriptions
  @descriptions
end

#final_urls ⇒ Object

Google Search and Display only. Replaces final URLs. Omitted lists stay unchanged. For Performance Max use assetGroup.finalUrl.



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

def final_urls
  @final_urls
end

#headlines ⇒ Object

Google Search and Display only. Replaces the complete headline list. Search takes 3-15, Display 1-5 and rejects pinnedField; the count is checked once the ad's channel is known. No padding or truncation on update.



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

def headlines
  @headlines
end

#name ⇒ Object

Rename the ad. Now propagated to Meta (POST /ad-id); non-Meta platforms return 501.



39
40
41
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 39

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#targeting ⇒ Object

Returns the value of attribute targeting.



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

def targeting
  @targeting
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



79
80
81
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 64

def self.attribute_map
  {
    :'headlines' => :'headlines',
    :'descriptions' => :'descriptions',
    :'final_urls' => :'finalUrls',
    :'asset_group' => :'assetGroup',
    :'status' => :'status',
    :'budget' => :'budget',
    :'targeting' => :'targeting',
    :'creative' => :'creative',
    :'name' => :'name'
  }
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 320

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



104
105
106
107
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 89

def self.openapi_types
  {
    :'headlines' => :'Array<GoogleRsaHeadline>',
    :'descriptions' => :'Array<GoogleRsaDescription>',
    :'final_urls' => :'Array<String>',
    :'asset_group' => :'GooglePmaxAssetGroupUpdate',
    :'status' => :'String',
    :'budget' => :'UpdateAdRequestBudget',
    :'targeting' => :'UpdateAdRequestTargeting',
    :'creative' => :'UpdateAdRequestCreative',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      headlines == o.headlines &&
      descriptions == o.descriptions &&
      final_urls == o.final_urls &&
      asset_group == o.asset_group &&
      status == o.status &&
      budget == o.budget &&
      targeting == o.targeting &&
      creative == o.creative &&
      name == o.name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 307

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



313
314
315
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 313

def hash
  [headlines, descriptions, final_urls, asset_group, status, budget, targeting, creative, name].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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 170

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@headlines.nil? && @headlines.length > 15
    invalid_properties.push('invalid value for "headlines", number of items must be less than or equal to 15.')
  end

  if !@headlines.nil? && @headlines.length < 1
    invalid_properties.push('invalid value for "headlines", number of items must be greater than or equal to 1.')
  end

  if !@descriptions.nil? && @descriptions.length > 5
    invalid_properties.push('invalid value for "descriptions", number of items must be less than or equal to 5.')
  end

  if !@descriptions.nil? && @descriptions.length < 1
    invalid_properties.push('invalid value for "descriptions", number of items must be greater than or equal to 1.')
  end

  if !@final_urls.nil? && @final_urls.length < 1
    invalid_properties.push('invalid value for "final_urls", number of items must be greater than or equal to 1.')
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", 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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 342

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



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/zernio-sdk/models/update_ad_request.rb', line 202

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@headlines.nil? && @headlines.length > 15
  return false if !@headlines.nil? && @headlines.length < 1
  return false if !@descriptions.nil? && @descriptions.length > 5
  return false if !@descriptions.nil? && @descriptions.length < 1
  return false if !@final_urls.nil? && @final_urls.length < 1
  status_validator = EnumAttributeValidator.new('String', ["active", "paused"])
  return false unless status_validator.valid?(@status)
  return false if !@name.nil? && @name.to_s.length > 255
  true
end