Class: FacebookAds::ServerSide::Event
- Inherits:
-
Object
- Object
- FacebookAds::ServerSide::Event
- Defined in:
- lib/facebook_ads/ad_objects/server_side/event.rb
Overview
Server Side Event object.
Instance Attribute Summary collapse
-
#action_source ⇒ Object
Where the conversion occurred.
-
#advanced_measurement_table ⇒ Object
Name of Advanced Measurement table.
-
#app_data ⇒ Object
An Object that contains app data.
-
#custom_data ⇒ Object
An Object that includes additional business data about the event.
-
#data_processing_options ⇒ Object
Processing options you would like to enable for a specific event.
-
#data_processing_options_country ⇒ Object
A country that you want to associate to this data processing option For more details see developers.facebook.com/docs/marketing-apis/data-processing-options.
-
#data_processing_options_state ⇒ Object
A state that you want to associate with this data processing option.
-
#event_id ⇒ Object
This ID can be any unique string chosen by the advertiser.
-
#event_name ⇒ Object
A Facebook pixel Standard Event or Custom Event name.
-
#event_source_url ⇒ Object
The browser URL where the event happened.
-
#event_time ⇒ Object
A Unix timestamp in seconds indicating when the actual event occurred.
-
#messaging_channel ⇒ Object
Messaging channel for the event.
-
#opt_out ⇒ Object
A flag that indicates we should not use this event for ads delivery optimization.
-
#user_data ⇒ Object
An Object that contains user data.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#build(attributes = {}) ⇒ Object
build the object using the input hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(event_name: nil, event_time: nil, event_source_url: nil, opt_out: nil, event_id: nil, user_data: nil, custom_data: nil, app_data: nil, data_processing_options: nil, data_processing_options_country: nil, data_processing_options_state: nil, action_source: nil, advanced_measurement_table: nil, messaging_channel: nil) ⇒ Event
constructor
A new instance of Event.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#normalize ⇒ Object
Normalize input fields to server request format.
- #to_s ⇒ Object
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(event_name: nil, event_time: nil, event_source_url: nil, opt_out: nil, event_id: nil, user_data: nil, custom_data: nil, app_data: nil, data_processing_options: nil, data_processing_options_country: nil, data_processing_options_state: nil, action_source: nil, advanced_measurement_table: nil, messaging_channel: nil) ⇒ Event
Returns a new instance of Event.
95 96 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 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 95 def initialize(event_name: nil, event_time: nil, event_source_url: nil, opt_out: nil, event_id: nil, user_data: nil, custom_data: nil, app_data: nil, data_processing_options: nil, data_processing_options_country: nil, data_processing_options_state: nil, action_source: nil, advanced_measurement_table: nil, messaging_channel: nil ) unless event_name.nil? self.event_name = event_name end unless event_time.nil? self.event_time = event_time end unless event_source_url.nil? self.event_source_url = event_source_url end unless opt_out.nil? self.opt_out = opt_out end unless event_id.nil? self.event_id = event_id end unless user_data.nil? self.user_data = user_data end unless custom_data.nil? self.custom_data = custom_data end unless app_data.nil? self.app_data = app_data end unless .nil? self. = end unless .nil? self. = end unless .nil? self. = end unless action_source.nil? self.action_source = action_source end unless advanced_measurement_table.nil? self.advanced_measurement_table = advanced_measurement_table end unless messaging_channel.nil? self.messaging_channel = messaging_channel end end |
Instance Attribute Details
#action_source ⇒ Object
Where the conversion occurred.
72 73 74 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 72 def action_source @action_source end |
#advanced_measurement_table ⇒ Object
Name of Advanced Measurement table. Only used for the Advanced Measurement API in the Advanced Analytics product
76 77 78 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 76 def advanced_measurement_table @advanced_measurement_table end |
#app_data ⇒ Object
An Object that contains app data.
57 58 59 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 57 def app_data @app_data end |
#custom_data ⇒ Object
An Object that includes additional business data about the event.
54 55 56 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 54 def custom_data @custom_data end |
#data_processing_options ⇒ Object
Processing options you would like to enable for a specific event. For more details see developers.facebook.com/docs/marketing-apis/data-processing-options
61 62 63 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 61 def @data_processing_options end |
#data_processing_options_country ⇒ Object
A country that you want to associate to this data processing option For more details see developers.facebook.com/docs/marketing-apis/data-processing-options
65 66 67 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 65 def @data_processing_options_country end |
#data_processing_options_state ⇒ Object
A state that you want to associate with this data processing option. For more details see developers.facebook.com/docs/marketing-apis/data-processing-options
69 70 71 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 69 def @data_processing_options_state end |
#event_id ⇒ Object
This ID can be any unique string chosen by the advertiser. event_id is used to deduplicate events sent by both Facebook Pixel and Server-Side API. event_name is also used in the deduplication process. For deduplication, the eventID from Facebook pixel must match the event_id in the corresponding Server-Side API event.
48 49 50 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 48 def event_id @event_id end |
#event_name ⇒ Object
A Facebook pixel Standard Event or Custom Event name. This is used with event_id to determine if events are identical.
31 32 33 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 31 def event_name @event_name end |
#event_source_url ⇒ Object
The browser URL where the event happened.
37 38 39 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 37 def event_source_url @event_source_url end |
#event_time ⇒ Object
A Unix timestamp in seconds indicating when the actual event occurred.
34 35 36 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 34 def event_time @event_time end |
#messaging_channel ⇒ Object
Messaging channel for the event
79 80 81 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 79 def messaging_channel @messaging_channel end |
#opt_out ⇒ Object
A flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution.
41 42 43 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 41 def opt_out @opt_out end |
#user_data ⇒ Object
An Object that contains user data.
51 52 53 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 51 def user_data @user_data end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 249 def ==(o) return true if self.equal?(o) self.class == o.class && event_name == o.event_name && event_time == o.event_time && event_source_url == o.event_source_url && opt_out == o.opt_out && event_id == o.event_id && user_data == o.user_data && custom_data == o.custom_data && app_data == o.app_data && == o. && == o. && == o. && action_source == o.action_source && advanced_measurement_table == o.advanced_measurement_table messaging_channel == o.messaging_channel end |
#build(attributes = {}) ⇒ Object
build the object using the input hash
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 214 215 216 217 218 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 157 def build(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'event_name') self.event_name = attributes[:'event_name'] end if attributes.has_key?(:'event_time') self.event_time = attributes[:'event_time'] end if attributes.has_key?(:'event_source_url') self.event_source_url = attributes[:'event_source_url'] end if attributes.has_key?(:'opt_out') self.opt_out = attributes[:'opt_out'] end if attributes.has_key?(:'event_id') self.event_id = attributes[:'event_id'] end if attributes.has_key?(:'user_data') self.user_data = attributes[:'user_data'] end if attributes.has_key?(:'custom_data') self.custom_data = attributes[:'custom_data'] end if attributes.has_key?(:'app_data') self.app_data = attributes[:'app_data'] end if attributes.has_key?(:'data_processing_options') self. = attributes[:'data_processing_options'] end if attributes.has_key?(:'data_processing_options_country') self. = attributes[:'data_processing_options_country'] end if attributes.has_key?(:'data_processing_options_state') self. = attributes[:'data_processing_options_state'] end if attributes.has_key?(:'action_source') self.action_source = attributes[:'action_source'] end if attributes.has_key?(:'advanced_measurement_table') self.advanced_measurement_table = attributes[:'advanced_measurement_table'] end if attributes.has_key?(:'messaging_channel') self.messaging_channel = attributes[:'messaging_channel'] end end |
#eql?(o) ⇒ Boolean
269 270 271 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 269 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
275 276 277 278 279 280 281 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 275 def hash [ event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data, app_data, , , , action_source, advanced_measurement_table, messaging_channel, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 222 def list_invalid_properties invalid_properties = Array.new if @event_name.nil? invalid_properties.push('invalid value for "event_name", event_name cannot be nil.') end if @event_time.nil? invalid_properties.push('invalid value for "event_time", event_time cannot be nil.') end if @user_data.nil? invalid_properties.push('invalid value for "user_data", user_data cannot be nil.') end invalid_properties end |
#normalize ⇒ Object
Normalize input fields to server request format.
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 332 def normalize hash = {} unless event_name.nil? hash['event_name'] = event_name end unless event_time.nil? hash['event_time'] = event_time end unless event_source_url.nil? hash['event_source_url'] = event_source_url end unless opt_out.nil? hash['opt_out'] = opt_out end unless event_id.nil? hash['event_id'] = event_id end unless user_data.nil? hash['user_data'] = user_data.normalize end unless custom_data.nil? hash['custom_data'] = custom_data.normalize end unless app_data.nil? hash['app_data'] = app_data.normalize end unless .nil? hash['data_processing_options'] = end unless .nil? hash['data_processing_options_country'] = end unless .nil? hash['data_processing_options_state'] = end unless action_source.nil? hash['action_source'] = FacebookAds::ServerSide::Util.normalize( action_source, 'action_source' ) end unless advanced_measurement_table.nil? hash['advanced_measurement_table'] = advanced_measurement_table end unless messaging_channel.nil? hash['messaging_channel'] = messaging_channel end hash end |
#to_s ⇒ Object
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 283 def to_s hash = {} unless event_name.nil? hash['event_name'] = event_name end unless event_time.nil? hash['event_time'] = event_time end unless event_source_url.nil? hash['event_source_url'] = event_source_url end unless opt_out.nil? hash['opt_out'] = opt_out end unless event_id.nil? hash['event_id'] = event_id end unless user_data.nil? hash['user_data'] = user_data.to_s end unless custom_data.nil? hash['custom_data'] = custom_data.to_s end unless app_data.nil? hash['app_data'] = app_data.to_s end unless .nil? hash['data_processing_options'] = .to_s end unless .nil? hash['data_processing_options_country'] = .to_s end unless .nil? hash['data_processing_options_state'] = .to_s end unless action_source.nil? hash['action_source'] = action_source end unless advanced_measurement_table.nil? hash['advanced_measurement_table'] = advanced_measurement_table end unless messaging_channel.nil? hash['messaging_channel'] = messaging_channel end hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
241 242 243 244 245 246 |
# File 'lib/facebook_ads/ad_objects/server_side/event.rb', line 241 def valid? return false if @event_name.nil? return false if @event_time.nil? return false if @user_data.nil? true end |