Class: Zernio::BoostPostRequestPromotedObject

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

Overview

Meta and TikTok. What the conversion ad set optimizes toward, so a boost of an existing organic post can run for a conversion instead of only engagement or traffic. Required when goal is conversions (Meta also lead_conversion); ignored on goals that do not optimize for a conversion. Meta: pixelId + customEventType (a commerce event such as PURCHASE under conversions, a leads-class event such as LEAD under lead_conversion), or customConversionId to optimize against a Custom Conversion, or customEventType: OTHER + customEventStr for a pixel custom event. Becomes the ad set promoted_object; without it Meta rejects the ad set ("Please select a promoted object", subcode 1815430). With adSetId the existing ad set already carries it. TikTok: BOTH pixelId and customEventType are required. TikTok refuses a conversion ad group with no pixel ("Please select a pixel") and one with a pixel but no event ("Select a pixel event."). Combine freely with platformPostId + sparkAuthCode: the pixel lives on the ad group and the Spark item on the creative.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 69

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

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

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

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

Instance Attribute Details

#custom_conversion_id ⇒ Object

Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.



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

def custom_conversion_id
  @custom_conversion_id
end

#custom_event_str ⇒ Object

Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.



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

def custom_event_str
  @custom_event_str
end

#custom_event_type ⇒ Object

Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.



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

def custom_event_type
  @custom_event_type
end

#pixel_id ⇒ Object

Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).



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

def pixel_id
  @pixel_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 32

def self.attribute_map
  {
    :'pixel_id' => :'pixelId',
    :'custom_event_type' => :'customEventType',
    :'custom_event_str' => :'customEventStr',
    :'custom_conversion_id' => :'customConversionId'
  }
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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 141

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



62
63
64
65
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 52

def self.openapi_types
  {
    :'pixel_id' => :'String',
    :'custom_event_type' => :'String',
    :'custom_event_str' => :'String',
    :'custom_conversion_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pixel_id == o.pixel_id &&
      custom_event_type == o.custom_event_type &&
      custom_event_str == o.custom_event_str &&
      custom_conversion_id == o.custom_conversion_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



134
135
136
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 134

def hash
  [pixel_id, custom_event_type, custom_event_str, custom_conversion_id].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



102
103
104
105
106
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 102

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



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/zernio-sdk/models/boost_post_request_promoted_object.rb', line 163

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



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

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