Class: Zernio::InstagramAccountInsightsResponseMetricsValue

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

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'values')
    if (value = attributes[:'values']).is_a?(Array)
      self.values = value
    end
  end

  if attributes.key?(:'breakdowns')
    if (value = attributes[:'breakdowns']).is_a?(Array)
      self.breakdowns = value
    end
  end

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

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

Instance Attribute Details

#breakdowns ⇒ Object

Breakdown values (only for total_value with breakdown)



25
26
27
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 25

def breakdowns
  @breakdowns
end

#currency ⇒ Object

ISO 4217 currency of a monetary metric, or null when the platform omitted it. Always null on monetization_approximate_earnings, which Meta returns as a bare number with no currency; always present on content_monetization_earnings.



31
32
33
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 31

def currency
  @currency
end

#total ⇒ Object

Sum or aggregate value for the metric



19
20
21
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 19

def total
  @total
end

#unit ⇒ Object

Present on monetary metrics only. The scale of "total" and of every "values.value", exactly as the platform returned them. "micro_amount": the platform returned an object shape carrying a micro amount, and the values are that integer, summed, unconverted. Zernio does not publish a divisor because Meta does not document one; divide by the scale you have verified against the Page's own Meta Business Suite export. On Facebook Page insights this is always content_monetization_earnings. "unspecified": the platform returned a bare number with no unit metadata. It is passed through as-is; the platform does not state whether it is major or minor currency units. On Facebook Page insights this is always monetization_approximate_earnings.



28
29
30
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 28

def unit
  @unit
end

#values ⇒ Object

Daily values (for time_series, and always on monetary metrics)



22
23
24
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 22

def values
  @values
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 56

def self.attribute_map
  {
    :'total' => :'total',
    :'values' => :'values',
    :'breakdowns' => :'breakdowns',
    :'unit' => :'unit',
    :'currency' => :'currency'
  }
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



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

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



88
89
90
91
92
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 88

def self.openapi_nullable
  Set.new([
    :'currency'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 77

def self.openapi_types
  {
    :'total' => :'Float',
    :'values' => :'Array<InstagramAccountInsightsResponseMetricsValueValuesInner>',
    :'breakdowns' => :'Array<InstagramAccountInsightsResponseMetricsValueBreakdownsInner>',
    :'unit' => :'String',
    :'currency' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      values == o.values &&
      breakdowns == o.breakdowns &&
      unit == o.unit &&
      currency == o.currency
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 182

def hash
  [total, values, breakdowns, unit, currency].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



137
138
139
140
141
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 137

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



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

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



145
146
147
148
149
150
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response_metrics_value.rb', line 145

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  unit_validator = EnumAttributeValidator.new('String', ["micro_amount", "unspecified"])
  return false unless unit_validator.valid?(@unit)
  true
end