Class: PinterestSdkClient::OptimizationGoalMetadataConversionTagV3GoalMetadata

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 103

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

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

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

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

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

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

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

Instance Attribute Details

#attribution_windows ⇒ Object

Returns the value of attribute attribution_windows.



18
19
20
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 18

def attribution_windows
  @attribution_windows
end

#conversion_event ⇒ Object

Returns the value of attribute conversion_event.



20
21
22
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 20

def conversion_event
  @conversion_event
end

#conversion_tag_id ⇒ Object

Returns the value of attribute conversion_tag_id.



22
23
24
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 22

def conversion_tag_id
  @conversion_tag_id
end

#cpa_goal_value_in_micro_currency ⇒ Object

Returns the value of attribute cpa_goal_value_in_micro_currency.



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

def cpa_goal_value_in_micro_currency
  @cpa_goal_value_in_micro_currency
end

#is_roas_optimized ⇒ Object

Pinterest Performance+ ROAS bidding. When enabled, Pinterest will optimize for conversion value instead of conversion volume. Only supported when conversion_event is set to ‘"CHECKOUT"` and bid_strategy_type is set to `"AUTOMATIC_BID"`.
This parameter is not enabled for all advertisers. <a href="developers.pinterest.com/docs/getting-started/using-beta-and-restricted-features/">Learn more</a>.



27
28
29
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 27

def is_roas_optimized
  @is_roas_optimized
end

#learning_mode_type ⇒ Object

Conversion learning model type



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

def learning_mode_type
  @learning_mode_type
end

#reporting_event ⇒ Object

Event name for custom or standard events mapped to an oCPM model



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

def reporting_event
  @reporting_event
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 76

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 58

def self.attribute_map
  {
    :'attribution_windows' => :'attribution_windows',
    :'conversion_event' => :'conversion_event',
    :'conversion_tag_id' => :'conversion_tag_id',
    :'cpa_goal_value_in_micro_currency' => :'cpa_goal_value_in_micro_currency',
    :'is_roas_optimized' => :'is_roas_optimized',
    :'learning_mode_type' => :'learning_mode_type',
    :'reporting_event' => :'reporting_event'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 256

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



94
95
96
97
98
99
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 94

def self.openapi_nullable
  Set.new([
    :'is_roas_optimized',
    :'learning_mode_type',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 81

def self.openapi_types
  {
    :'attribution_windows' => :'OptimizationGoalMetadataConversionTagV3GoalMetadataAttributionWindows',
    :'conversion_event' => :'String',
    :'conversion_tag_id' => :'String',
    :'cpa_goal_value_in_micro_currency' => :'String',
    :'is_roas_optimized' => :'Boolean',
    :'learning_mode_type' => :'String',
    :'reporting_event' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attribution_windows == o.attribution_windows &&
      conversion_event == o.conversion_event &&
      conversion_tag_id == o.conversion_tag_id &&
      cpa_goal_value_in_micro_currency == o.cpa_goal_value_in_micro_currency &&
      is_roas_optimized == o.is_roas_optimized &&
      learning_mode_type == o.learning_mode_type &&
      reporting_event == o.reporting_event
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 249

def hash
  [attribution_windows, conversion_event, conversion_tag_id, cpa_goal_value_in_micro_currency, is_roas_optimized, learning_mode_type, reporting_event].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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 148

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

  pattern = Regexp.new(/^[0-9]+$/)
  if !@cpa_goal_value_in_micro_currency.nil? && @cpa_goal_value_in_micro_currency !~ pattern
    invalid_properties.push("invalid value for \"cpa_goal_value_in_micro_currency\", 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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 278

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



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/pinterest_sdk/models/optimization_goal_metadata_conversion_tag_v3_goal_metadata.rb', line 166

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  conversion_event_validator = EnumAttributeValidator.new('String', ["PAGE_VISIT", "SIGNUP", "CHECKOUT", "CUSTOM", "VIEW_CATEGORY", "SEARCH", "ADD_TO_CART", "WATCH_VIDEO", "LEAD", "APP_INSTALL"])
  return false unless conversion_event_validator.valid?(@conversion_event)
  return false if !@conversion_tag_id.nil? && @conversion_tag_id !~ Regexp.new(/^[0-9]+$/)
  return false if !@cpa_goal_value_in_micro_currency.nil? && @cpa_goal_value_in_micro_currency !~ Regexp.new(/^[0-9]+$/)
  learning_mode_type_validator = EnumAttributeValidator.new('String', ["NOT_ACTIVE", "ACTIVE"])
  return false unless learning_mode_type_validator.valid?(@learning_mode_type)
  true
end