Class: PinterestSdkClient::TargetingTemplateGetResponseData

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/targeting_template_get_response_data.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 = {}) ⇒ TargetingTemplateGetResponseData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 140

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

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

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

  if attributes.key?(:'placement_group')
    self.placement_group = attributes[:'placement_group']
  else
    self.placement_group = 'ALL'
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_account_id ⇒ Object

The ID of the advertiser that this targeting template belongs to.



33
34
35
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 33

def 
  
end

#auto_targeting_enabled ⇒ Object

Enable auto-targeting for ad group. Also known as <a href="help.pinterest.com/en/business/article/expanded-targeting" target="_blank">"expanded targeting"</a>.



19
20
21
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 19

def auto_targeting_enabled
  @auto_targeting_enabled
end

#created_time ⇒ Object

Targeting template created time. Unix timestamp in seconds.



36
37
38
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 36

def created_time
  @created_time
end

#id ⇒ Object

Targeting template ID.



39
40
41
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 39

def id
  @id
end

#keywords ⇒ Object

Returns the value of attribute keywords.



21
22
23
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 21

def keywords
  @keywords
end

#name ⇒ Object

targeting template name



24
25
26
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 24

def name
  @name
end

#placement_group ⇒ Object

Returns the value of attribute placement_group.



26
27
28
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 26

def placement_group
  @placement_group
end

#sizing ⇒ Object

Returns the value of attribute sizing.



41
42
43
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 41

def sizing
  @sizing
end

#status ⇒ Object

Indicate targeting template is active or Deleted



44
45
46
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 44

def status
  @status
end

#targeting_attributes ⇒ Object

Returns the value of attribute targeting_attributes.



28
29
30
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 28

def targeting_attributes
  @targeting_attributes
end

#tracking_urls ⇒ Object

Returns the value of attribute tracking_urls.



30
31
32
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 30

def tracking_urls
  @tracking_urls
end

#updated_time ⇒ Object

Targeting template updated time.Unix timestamp in seconds.



47
48
49
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 47

def updated_time
  @updated_time
end

#valid ⇒ Object

Inform if the targeting template is valid (ex. would be false if has revoked audience)



50
51
52
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 50

def valid
  @valid
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



94
95
96
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 94

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 99

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 75

def self.attribute_map
  {
    :'auto_targeting_enabled' => :'auto_targeting_enabled',
    :'keywords' => :'keywords',
    :'name' => :'name',
    :'placement_group' => :'placement_group',
    :'targeting_attributes' => :'targeting_attributes',
    :'tracking_urls' => :'tracking_urls',
    :'ad_account_id' => :'ad_account_id',
    :'created_time' => :'created_time',
    :'id' => :'id',
    :'sizing' => :'sizing',
    :'status' => :'status',
    :'updated_time' => :'updated_time',
    :'valid' => :'valid'
  }
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 319

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



132
133
134
135
136
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 132

def self.openapi_all_of
  [
  :'TargetingTemplateResponseData'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
127
128
129
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 123

def self.openapi_nullable
  Set.new([
    :'tracking_urls',
    :'sizing',
    :'valid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 104

def self.openapi_types
  {
    :'auto_targeting_enabled' => :'Boolean',
    :'keywords' => :'Array<TargetingTemplateKeyword>',
    :'name' => :'String',
    :'placement_group' => :'PlacementGroupType',
    :'targeting_attributes' => :'TargetingSpec',
    :'tracking_urls' => :'TrackingUrls',
    :'ad_account_id' => :'String',
    :'created_time' => :'Integer',
    :'id' => :'String',
    :'sizing' => :'TargetingTemplateAudienceSizing',
    :'status' => :'String',
    :'updated_time' => :'Integer',
    :'valid' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_targeting_enabled == o.auto_targeting_enabled &&
      keywords == o.keywords &&
      name == o.name &&
      placement_group == o.placement_group &&
      targeting_attributes == o.targeting_attributes &&
      tracking_urls == o.tracking_urls &&
       == o. &&
      created_time == o.created_time &&
      id == o.id &&
      sizing == o.sizing &&
      status == o.status &&
      updated_time == o.updated_time &&
      valid == o.valid
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 312

def hash
  [auto_targeting_enabled, keywords, name, placement_group, targeting_attributes, tracking_urls, , created_time, id, sizing, status, updated_time, valid].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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 217

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !.nil? &&  !~ pattern
    invalid_properties.push("invalid value for \"ad_account_id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 341

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



235
236
237
238
239
240
241
242
 
# File 'lib/pinterest_sdk/models/targeting_template_get_response_data.rb', line 235

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !.nil? &&  !~ Regexp.new(/^\d+$/)
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "DELETED"])
  return false unless status_validator.valid?(@status)
  true
end