Class: Zernio::AdEngagementCounts

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

Overview

The single engagement total split into the interactions behind it. Note that engagement is not the sum of these: Meta's own post_engagement and page_engagement totals already contain the individual interactions, and all of them are counted into engagement. Use these fields when you need a specific interaction, and engagement only as the coarse total it has always been. Meta-only; other platforms leave these at 0.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
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
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 94

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

Comments on the ad's post.



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

def comments
  @comments
end

#link_clicks ⇒ Object

Attributed link clicks (link_click). This is the attribution-window count, which differs from the in-session inline_link_clicks reported by GET /v1/ads/{adId}/analytics.



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

def link_clicks
  @link_clicks
end

#page_engagement ⇒ Object

Meta's own page-engagement total (page_engagement).



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

def page_engagement
  @page_engagement
end

#page_likes ⇒ Object

New Page likes attributed to the ad (like).



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

def page_likes
  @page_likes
end

#post_engagement ⇒ Object

Meta's own post-engagement total (post_engagement).



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

def post_engagement
  @post_engagement
end

#reactions ⇒ Object

Reactions on the ad's post (post_reaction).



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

def reactions
  @reactions
end

#saves ⇒ Object

Saves of the ad's post (onsite_conversion.post_save).



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

def saves
  @saves
end

#shares ⇒ Object

Shares of the ad's post. Meta reports these under the action type literally named post.



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

def shares
  @shares
end

#video_views ⇒ Object

3-second video views (video_view). For completion-based counts use videoThruplayWatchedActions.



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

def video_views
  @video_views
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 47

def self.attribute_map
  {
    :'post_engagement' => :'postEngagement',
    :'page_engagement' => :'pageEngagement',
    :'reactions' => :'reactions',
    :'comments' => :'comments',
    :'shares' => :'shares',
    :'saves' => :'saves',
    :'page_likes' => :'pageLikes',
    :'video_views' => :'videoViews',
    :'link_clicks' => :'linkClicks'
  }
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 191

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



87
88
89
90
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 72

def self.openapi_types
  {
    :'post_engagement' => :'Integer',
    :'page_engagement' => :'Integer',
    :'reactions' => :'Integer',
    :'comments' => :'Integer',
    :'shares' => :'Integer',
    :'saves' => :'Integer',
    :'page_likes' => :'Integer',
    :'video_views' => :'Integer',
    :'link_clicks' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      post_engagement == o.post_engagement &&
      page_engagement == o.page_engagement &&
      reactions == o.reactions &&
      comments == o.comments &&
      shares == o.shares &&
      saves == o.saves &&
      page_likes == o.page_likes &&
      video_views == o.video_views &&
      link_clicks == o.link_clicks
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [post_engagement, page_engagement, reactions, comments, shares, saves, page_likes, video_views, link_clicks].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



147
148
149
150
151
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 147

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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 213

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



155
156
157
158
 
# File 'lib/zernio-sdk/models/ad_engagement_counts.rb', line 155

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