Class: Zernio::InstagramAccountInsightsResponse

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

Overview

Shared account-insights response envelope used by every platform-level analytics endpoint (/v1/analytics/facebook|instagram|youtube|linkedin|tiktok/*). The name is historical - the shape was first shipped for Instagram and every new platform endpoint reuses it for response-shape consistency. The platform field echoes back which platform served the response.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 112

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The Zernio SocialAccount ID



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

def 
  @account_id
end

#breakdown ⇒ Object

Breakdown dimension used (only present when breakdown was requested)



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

def breakdown
  @breakdown
end

#data_delay ⇒ Object

Returns the value of attribute data_delay.



40
41
42
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 40

def data_delay
  @data_delay
end

#date_range ⇒ Object

Returns the value of attribute date_range.



27
28
29
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 27

def date_range
  @date_range
end

#metric_type ⇒ Object

Returns the value of attribute metric_type.



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

def metric_type
  @metric_type
end

#metrics ⇒ Object

Object keyed by metric name. For time_series: each metric has "total" (number) and "values" (array of value). For total_value: each metric has "total" (number) and optionally "breakdowns" (array of value). Monetary metrics additionally carry "unit" and "currency". Zernio never rescales money: "total" and every "values.value" are the platform's raw numbers in the stated unit. Monetary metrics also keep "values" on metricType=total_value, because their "total" is the sum of the daily buckets the platform returned over the range: keep the series so you can reconcile that sum against the platform's own reporting before invoicing on it. A metric that could not be served is absent from this object and listed in "unavailableMetrics" instead, so an unavailable metric is never reported as a zero.



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

def metrics
  @metrics
end

#platform ⇒ Object

Platform that served this response.



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

def platform
  @platform
end

#success ⇒ Object

Returns the value of attribute success.



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

def success
  @success
end

#unavailable_metrics ⇒ Object

Requested metrics that could not be served. Present only when at least one metric is unavailable, and absent otherwise. Each listed metric is OMITTED from "metrics" rather than reported as 0, which is how an unavailable metric is distinguished from a genuine zero. The request itself still succeeds with HTTP 200.



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

def unavailable_metrics
  @unavailable_metrics
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 65

def self.attribute_map
  {
    :'success' => :'success',
    :'account_id' => :'accountId',
    :'platform' => :'platform',
    :'date_range' => :'dateRange',
    :'metric_type' => :'metricType',
    :'breakdown' => :'breakdown',
    :'metrics' => :'metrics',
    :'unavailable_metrics' => :'unavailableMetrics',
    :'data_delay' => :'dataDelay'
  }
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 237

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



105
106
107
108
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'success' => :'Boolean',
    :'account_id' => :'String',
    :'platform' => :'String',
    :'date_range' => :'InstagramAccountInsightsResponseDateRange',
    :'metric_type' => :'String',
    :'breakdown' => :'String',
    :'metrics' => :'Hash<String, InstagramAccountInsightsResponseMetricsValue>',
    :'unavailable_metrics' => :'Array<InstagramAccountInsightsResponseUnavailableMetricsInner>',
    :'data_delay' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      success == o.success &&
       == o. &&
      platform == o.platform &&
      date_range == o.date_range &&
      metric_type == o.metric_type &&
      breakdown == o.breakdown &&
      metrics == o.metrics &&
      unavailable_metrics == o.unavailable_metrics &&
      data_delay == o.data_delay
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 230

def hash
  [success, , platform, date_range, metric_type, breakdown, metrics, unavailable_metrics, data_delay].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



169
170
171
172
173
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 169

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 259

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



177
178
179
180
181
182
183
184
 
# File 'lib/zernio-sdk/models/instagram_account_insights_response.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  platform_validator = EnumAttributeValidator.new('String', ["facebook", "instagram", "youtube", "linkedin", "tiktok"])
  return false unless platform_validator.valid?(@platform)
  metric_type_validator = EnumAttributeValidator.new('String', ["time_series", "total_value"])
  return false unless metric_type_validator.valid?(@metric_type)
  true
end