Class: Zernio::TargetingSpecExcludedLocations

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

Overview

Geo to exclude from the audience. Mirrors the inclusion geo shape: excluded cities can carry a radius catchment and excluded custom (lat/lng) pins are supported, both on Meta (excluded_geo_locations).

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cities ⇒ Object

Cities to exclude. Optional radius + distanceUnit exclude a catchment around the city (both must be set together or both omitted); Meta honours the radius on excluded cities.



27
28
29
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 27

def cities
  @cities
end

#countries ⇒ Object

Returns the value of attribute countries.



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

def countries
  @countries
end

#country_groups ⇒ Object

Meta only. Continents and trade blocs to exclude (excluded_geo_locations.country_groups).



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

def country_groups
  @country_groups
end

#custom_locations ⇒ Object

Point-radius (lat/lng) pins to exclude (Meta excluded_geo_locations.custom_locations). Mirrors the inclusion customLocations shape.



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

def custom_locations
  @custom_locations
end

#neighborhoods ⇒ Object

Named neighbourhood areas to exclude. key from /v1/ads/targeting/search.



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

def neighborhoods
  @neighborhoods
end

#places ⇒ Object

Named points of interest to exclude. key from /v1/ads/targeting/search.



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

def places
  @places
end

#regions ⇒ Object

Returns the value of attribute regions.



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

def regions
  @regions
end

#zips ⇒ Object

Returns the value of attribute zips.



29
30
31
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 29

def zips
  @zips
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.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/targeting_spec_excluded_locations.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/targeting_spec_excluded_locations.rb', line 63

def self.attribute_map
  {
    :'countries' => :'countries',
    :'country_groups' => :'countryGroups',
    :'regions' => :'regions',
    :'cities' => :'cities',
    :'zips' => :'zips',
    :'places' => :'places',
    :'neighborhoods' => :'neighborhoods',
    :'custom_locations' => :'customLocations'
  }
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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 216

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/targeting_spec_excluded_locations.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/targeting_spec_excluded_locations.rb', line 87

def self.openapi_types
  {
    :'countries' => :'Array<String>',
    :'country_groups' => :'Array<String>',
    :'regions' => :'Array<UpdateCampaignTargetingRequestTargetingLocationsOneOfRegionsInner>',
    :'cities' => :'Array<TargetingSpecExcludedLocationsCitiesInner>',
    :'zips' => :'Array<UpdateCampaignTargetingRequestTargetingLocationsOneOfRegionsInner>',
    :'places' => :'Array<TargetingSpecExcludedLocationsPlacesInner>',
    :'neighborhoods' => :'Array<TargetingSpecExcludedLocationsPlacesInner>',
    :'custom_locations' => :'Array<TargetingSpecCustomLocationsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      countries == o.countries &&
      country_groups == o.country_groups &&
      regions == o.regions &&
      cities == o.cities &&
      zips == o.zips &&
      places == o.places &&
      neighborhoods == o.neighborhoods &&
      custom_locations == o.custom_locations
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 209

def hash
  [countries, country_groups, regions, cities, zips, places, neighborhoods, custom_locations].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



173
174
175
176
177
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 173

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



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

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



181
182
183
184
 
# File 'lib/zernio-sdk/models/targeting_spec_excluded_locations.rb', line 181

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