Class: Zernio::UpdateAdRequestTargeting

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

Overview

Meta + TikTok (demographics/interests), Google (keyword and device bid adjustment edits only), and LinkedIn (countries or regions required). Pinterest / X return 501.

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 118

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#advantage_audience ⇒ Object

Meta only. Omit to preserve the existing setting on update. 0 = disabled, 1 = enabled.



44
45
46
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 44

def advantage_audience
  @advantage_audience
end

#age_max ⇒ Object

Returns the value of attribute age_max.



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

def age_max
  @age_max
end

#age_min ⇒ Object

Returns the value of attribute age_min.



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

def age_min
  @age_min
end

#countries ⇒ Object

ISO 3166-1 alpha-2 codes. On Google this is the FULL new country set for the campaign (same contract as locations); on LinkedIn it replaces the campaign's geo criteria.



33
34
35
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 33

def countries
  @countries
end

#devices ⇒ Object

Google only. The FULL new set of device bid modifiers for the campaign. Entries are a device name alone (targeted, bid modifier reset to 1) or { device, bidModifier }. A supported device you leave out is switched off, written as a bid modifier of 0. Google never removes a device criterion, so an excluded device reads back as bidModifier 0 rather than disappearing, and a set that switches every device off returns 422. Which devices a campaign carries depends on its channel: Search campaigns have MOBILE, DESKTOP and TABLET, Display campaigns also have CONNECTED_TV, and sending a device the campaign does not carry returns 422.



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

def devices
  @devices
end

#interests ⇒ Object

Interest objects from /v1/ads/interests. Each must include id and name.



41
42
43
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 41

def interests
  @interests
end

#keywords ⇒ Object

Google only. The FULL desired set of positive keywords for the entire ad group. Omit to leave positives unchanged; [] removes all positives. Negatives are independent. Entries are strings (BROAD) or { text, matchType } with matchType exact | phrase | broad; an omitted matchType also defaults to BROAD. Matching case-insensitive text AND match type retains the existing criterion ID, status, bid overrides, labels and history without a mutation. A changed text or match type uses remove/create, without transferring the old criterion's attributes or history. See Google keyword replacement above for an EXACT-to-BROAD example. Mirrored to GET /v1/ads/keywords immediately.



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

def keywords
  @keywords
end

#languages ⇒ Object

Google only. The FULL new language set for the campaign, as Google language codes (ISO 639-1, plus variants such as zh_CN). An unknown code returns 400.



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

def languages
  @languages
end

#locations ⇒ Object

Returns the value of attribute locations.



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

def locations
  @locations
end

#negative_keywords ⇒ Object

Google only. The FULL desired set of negative keywords for the entire ad group, independent of positives. Omit to leave negatives unchanged; [] removes all negatives. Uses the same text/match-type identity and preservation contract as keywords above. Strings and objects without matchType default to BROAD, so resending an EXACT or PHRASE negative as a bare string requests a different criterion. Campaign negatives are separate: use /v1/ads/campaigns/campaignId/negative-keywords to manage those.



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

def negative_keywords
  @negative_keywords
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 69

def self.attribute_map
  {
    :'keywords' => :'keywords',
    :'negative_keywords' => :'negativeKeywords',
    :'devices' => :'devices',
    :'age_min' => :'ageMin',
    :'age_max' => :'ageMax',
    :'countries' => :'countries',
    :'locations' => :'locations',
    :'languages' => :'languages',
    :'interests' => :'interests',
    :'advantage_audience' => :'advantage_audience'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 300

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



111
112
113
114
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 95

def self.openapi_types
  {
    :'keywords' => :'Array<UpdateAdRequestTargetingKeywordsInner>',
    :'negative_keywords' => :'Array<UpdateAdRequestTargetingKeywordsInner>',
    :'devices' => :'Array<UpdateAdRequestTargetingDevicesInner>',
    :'age_min' => :'Integer',
    :'age_max' => :'Integer',
    :'countries' => :'Array<String>',
    :'locations' => :'UpdateAdRequestTargetingLocations',
    :'languages' => :'Array<String>',
    :'interests' => :'Array<UpdateAdRequestTargetingInterestsInner>',
    :'advantage_audience' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      keywords == o.keywords &&
      negative_keywords == o.negative_keywords &&
      devices == o.devices &&
      age_min == o.age_min &&
      age_max == o.age_max &&
      countries == o.countries &&
      locations == o.locations &&
      languages == o.languages &&
      interests == o.interests &&
      advantage_audience == o.advantage_audience
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


287
288
289
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



293
294
295
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 293

def hash
  [keywords, negative_keywords, devices, age_min, age_max, countries, locations, languages, interests, advantage_audience].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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 187

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

  if !@age_min.nil? && @age_min < 13
    invalid_properties.push('invalid value for "age_min", must be greater than or equal to 13.')
  end

  if !@age_max.nil? && @age_max > 65
    invalid_properties.push('invalid value for "age_max", must be smaller than or equal to 65.')
  end

  if !@age_max.nil? && @age_max < 13
    invalid_properties.push('invalid value for "age_max", must be greater than or equal to 13.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 322

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:

  • true if the model is valid



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/update_ad_request_targeting.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@age_min.nil? && @age_min > 65
  return false if !@age_min.nil? && @age_min < 13
  return false if !@age_max.nil? && @age_max > 65
  return false if !@age_max.nil? && @age_max < 13
  advantage_audience_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless advantage_audience_validator.valid?(@advantage_audience)
  true
end