Class: PinterestSdkClient::TargetingTemplateCommon

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
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
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 97

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

Instance Attribute Details

#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_common.rb', line 19

def auto_targeting_enabled
  @auto_targeting_enabled
end

#keywords ⇒ Object

Returns the value of attribute keywords.



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

def keywords
  @keywords
end

#name ⇒ Object

targeting template name



24
25
26
 
# File 'lib/pinterest_sdk/models/targeting_template_common.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_common.rb', line 26

def placement_group
  @placement_group
end

#targeting_attributes ⇒ Object

Returns the value of attribute targeting_attributes.



28
29
30
 
# File 'lib/pinterest_sdk/models/targeting_template_common.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_common.rb', line 30

def tracking_urls
  @tracking_urls
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 55

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'
  }
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 185

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



89
90
91
92
93
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 77

def self.openapi_types
  {
    :'auto_targeting_enabled' => :'Boolean',
    :'keywords' => :'Array<TargetingTemplateKeyword>',
    :'name' => :'String',
    :'placement_group' => :'PlacementGroupType',
    :'targeting_attributes' => :'TargetingSpec',
    :'tracking_urls' => :'TrackingUrls'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 159

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
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



178
179
180
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 178

def hash
  [auto_targeting_enabled, keywords, name, placement_group, targeting_attributes, tracking_urls].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



144
145
146
147
148
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 144

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



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 207

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



152
153
154
155
 
# File 'lib/pinterest_sdk/models/targeting_template_common.rb', line 152

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