Class: Zernio::AdFunnelCounts

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/ad_funnel_counts.rb

Overview

Named conversion-funnel steps, resolved from the same data as actions so you never have to parse action-type strings yourself. Meta reports one event under several action types at once (offsite_conversion.fb_pixel_purchase, omni_purchase, purchase, …). Each field below takes the FIRST family member present rather than summing them, which is what makes these counts safe to add up — summing the raw actions keys yourself double or triple counts. The same priority order backs conversions, so a purchase-optimised campaign reports the identical number in conversions and funnel.purchases. Every field is 0 when that step never fired. Populated for Meta ads; other platforms report a different action taxonomy and generally leave these at 0 (read actions for those). At ad-set and campaign level each step is summed from its per-ad values.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 114

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_installs ⇒ Object

Mobile app installs attributed to the ad.



50
51
52
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 50

def app_installs
  @app_installs
end

#cart_adds ⇒ Object

Adds to cart (Meta AddToCart pixel event).



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

def cart_adds
  @cart_adds
end

#checkouts_initiated ⇒ Object

Checkouts started (Meta InitiateCheckout pixel event).



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

def checkouts_initiated
  @checkouts_initiated
end

#content_views ⇒ Object

Content views (Meta ViewContent pixel event).



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

def content_views
  @content_views
end

#landing_page_views ⇒ Object

Landing page views — the visitor actually loaded the destination, unlike a link click. Meta landing_page_view.



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

def landing_page_views
  @landing_page_views
end

#leads ⇒ Object

Leads, from either the website pixel or an instant form — whichever the ad uses.



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

def leads
  @leads
end

#messaging_conversations_started ⇒ Object

Messaging conversations started within 7 days — the headline metric for click-to-WhatsApp and click-to-Messenger ads.



53
54
55
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 53

def messaging_conversations_started
  @messaging_conversations_started
end

#messaging_first_replies ⇒ Object

Messaging threads where the person sent a first reply.



56
57
58
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 56

def messaging_first_replies
  @messaging_first_replies
end

#payment_info_adds ⇒ Object

Payment details added at checkout (Meta AddPaymentInfo pixel event).



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

def payment_info_adds
  @payment_info_adds
end

#purchases ⇒ Object

Purchases (Meta Purchase pixel event). Pair with purchaseValue for revenue.



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

def purchases
  @purchases
end

#registrations_completed ⇒ Object

Completed registrations (Meta CompleteRegistration pixel event).



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

def registrations_completed
  @registrations_completed
end

#searches ⇒ Object

On-site searches (Meta Search pixel event).



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

def searches
  @searches
end

#wishlist_adds ⇒ Object

Adds to wishlist (Meta AddToWishlist pixel event).



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

def wishlist_adds
  @wishlist_adds
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 59

def self.attribute_map
  {
    :'landing_page_views' => :'landingPageViews',
    :'content_views' => :'contentViews',
    :'searches' => :'searches',
    :'wishlist_adds' => :'wishlistAdds',
    :'cart_adds' => :'cartAdds',
    :'checkouts_initiated' => :'checkoutsInitiated',
    :'payment_info_adds' => :'paymentInfoAdds',
    :'purchases' => :'purchases',
    :'leads' => :'leads',
    :'registrations_completed' => :'registrationsCompleted',
    :'app_installs' => :'appInstalls',
    :'messaging_conversations_started' => :'messagingConversationsStarted',
    :'messaging_first_replies' => :'messagingFirstReplies'
  }
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 231

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



107
108
109
110
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 88

def self.openapi_types
  {
    :'landing_page_views' => :'Integer',
    :'content_views' => :'Integer',
    :'searches' => :'Integer',
    :'wishlist_adds' => :'Integer',
    :'cart_adds' => :'Integer',
    :'checkouts_initiated' => :'Integer',
    :'payment_info_adds' => :'Integer',
    :'purchases' => :'Integer',
    :'leads' => :'Integer',
    :'registrations_completed' => :'Integer',
    :'app_installs' => :'Integer',
    :'messaging_conversations_started' => :'Integer',
    :'messaging_first_replies' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      landing_page_views == o.landing_page_views &&
      content_views == o.content_views &&
      searches == o.searches &&
      wishlist_adds == o.wishlist_adds &&
      cart_adds == o.cart_adds &&
      checkouts_initiated == o.checkouts_initiated &&
      payment_info_adds == o.payment_info_adds &&
      purchases == o.purchases &&
      leads == o.leads &&
      registrations_completed == o.registrations_completed &&
      app_installs == o.app_installs &&
      messaging_conversations_started == o.messaging_conversations_started &&
      messaging_first_replies == o.messaging_first_replies
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 224

def hash
  [landing_page_views, content_views, searches, wishlist_adds, cart_adds, checkouts_initiated, payment_info_adds, purchases, leads, registrations_completed, app_installs, messaging_conversations_started, messaging_first_replies].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



183
184
185
186
187
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 183

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 253

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



191
192
193
194
 
# File 'lib/zernio-sdk/models/ad_funnel_counts.rb', line 191

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