Class: Zernio::CreateStandaloneAdRequestPromotedObject

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

Overview

What the ad optimises against. Behaviour depends on the platform. Meta: forwarded to the ad set's promoted_object (snake-cased). Required for goals whose ad-set optimization_goal points at a specific event/page/app (without it Meta rejects the ad-set create with error_subcode: 1815430 "Please select a promoted object for your ad set"): - goal: conversions (OFFSITE_CONVERSIONS): requires pixelId + customEventType - goal: app_promotion (APP_INSTALLS): requires applicationId + objectStoreUrl - goal: lead_generation (LEAD_GENERATION): pageId is auto-filled from the connected Page when omitted Other Meta goals (engagement, traffic, awareness, video_views) ignore this field. TikTok: only goal: conversions uses it. - pixelId maps to the ad group's pixel_id. Required: a TikTok website-conversion ad group without a pixel is rejected with 40002: Please select a pixel. - customEventType maps to the ad group's optimization_event (the pixel event to optimise for). Optional: TikTok accepts a pixel-only auto-bid conversion ad group. See the customEventType field below for the valid TikTok codes. The remaining promotedObject.* fields are Meta-only. Platforms other than Meta and TikTok ignore promotedObject entirely.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 99

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

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

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

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

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

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

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

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

Instance Attribute Details

#application_id ⇒ Object

App ID. Required for goal: app_promotion.



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

def application_id
  @application_id
end

#custom_conversion_id ⇒ Object

Custom Conversion ID, when optimising against one instead of a standard event.



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

def custom_conversion_id
  @custom_conversion_id
end

#custom_event_type ⇒ Object

The event the campaign/ad group optimises against. Meta: standard event like PURCHASE, LEAD, COMPLETE_REGISTRATION, ADD_TO_CART. Uppercased internally so callers can pass any case. Required for goal: conversions. TikTok: an optimization_event code (UPPER_SNAKE, not Meta's vocabulary and not PascalCase), OR the exact event name shown in TikTok Events Manager (auto-resolved to its code). Must be one of the event types your TikTok Pixel tracks; custom events are not optimizable. Current taxonomy: SHOPPING (Purchase), ON_WEB_CART (Add to Cart), INITIATE_ORDER (Initiate Checkout), FORM (Lead), ON_WEB_REGISTER (Complete Registration), ON_WEB_DETAIL (View Content). ON_WEB_ORDER is deprecated. On rejection the error lists the event types your pixel actually tracks. Optional for goal: conversions.



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

def custom_event_type
  @custom_event_type
end

#object_store_url ⇒ Object

App Store / Play Store listing URL. Required for goal: app_promotion.



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

def object_store_url
  @object_store_url
end

#offline_conversion_data_set_id ⇒ Object

Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).



44
45
46
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 44

def offline_conversion_data_set_id
  @offline_conversion_data_set_id
end

#page_id ⇒ Object

Facebook Page ID. Used by goal: lead_generation. Auto-filled from the connected Page when omitted.



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

def page_id
  @page_id
end

#pixel_id ⇒ Object

Pixel ID. Meta: Facebook Pixel ID, required for goal: conversions. TikTok: TikTok Pixel ID, required for goal: conversions.



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

def pixel_id
  @pixel_id
end

#product_catalog_id ⇒ Object

Catalog ID for catalog/Advantage+ Shopping campaigns.



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

def product_catalog_id
  @product_catalog_id
end

#product_set_id ⇒ Object

Product Set ID inside the catalog.



41
42
43
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 41

def product_set_id
  @product_set_id
end

#whatsapp_phone_number ⇒ Object

Meta only. WhatsApp number on messaging-destination ad sets.



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

def whatsapp_phone_number
  @whatsapp_phone_number
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 50

def self.attribute_map
  {
    :'pixel_id' => :'pixelId',
    :'custom_event_type' => :'customEventType',
    :'page_id' => :'pageId',
    :'application_id' => :'applicationId',
    :'object_store_url' => :'objectStoreUrl',
    :'custom_conversion_id' => :'customConversionId',
    :'product_catalog_id' => :'productCatalogId',
    :'product_set_id' => :'productSetId',
    :'offline_conversion_data_set_id' => :'offlineConversionDataSetId',
    :'whatsapp_phone_number' => :'whatsappPhoneNumber'
  }
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 201

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



92
93
94
95
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 76

def self.openapi_types
  {
    :'pixel_id' => :'String',
    :'custom_event_type' => :'String',
    :'page_id' => :'String',
    :'application_id' => :'String',
    :'object_store_url' => :'String',
    :'custom_conversion_id' => :'String',
    :'product_catalog_id' => :'String',
    :'product_set_id' => :'String',
    :'offline_conversion_data_set_id' => :'String',
    :'whatsapp_phone_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pixel_id == o.pixel_id &&
      custom_event_type == o.custom_event_type &&
      page_id == o.page_id &&
      application_id == o.application_id &&
      object_store_url == o.object_store_url &&
      custom_conversion_id == o.custom_conversion_id &&
      product_catalog_id == o.product_catalog_id &&
      product_set_id == o.product_set_id &&
      offline_conversion_data_set_id == o.offline_conversion_data_set_id &&
      whatsapp_phone_number == o.whatsapp_phone_number
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 194

def hash
  [pixel_id, custom_event_type, page_id, application_id, object_store_url, custom_conversion_id, product_catalog_id, product_set_id, offline_conversion_data_set_id, whatsapp_phone_number].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



156
157
158
159
160
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 156

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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 223

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



164
165
166
167
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb', line 164

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