Class: Line::Bot::V2::Insight::GetStatisticsPerUnitResponseOverview

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb

Overview

Statistics related to messages.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(unique_impression: nil, unique_click: nil, unique_media_played: nil, unique_media_played100_percent: nil, **dynamic_attributes) ⇒ GetStatisticsPerUnitResponseOverview

Returns a new instance of GetStatisticsPerUnitResponseOverview.

Parameters:

  • unique_impression (Integer, nil) (defaults to: nil) —

    Number of users who opened the message, meaning they displayed at least 1 bubble.

  • unique_click (Integer, nil) (defaults to: nil) —

    Number of users who opened any URL in the message.

  • unique_media_played (Integer, nil) (defaults to: nil) —

    Number of users who started playing any video or audio in the message.

  • unique_media_played100_percent (Integer, nil) (defaults to: nil) —

    Number of users who played the entirety of any video or audio in the message.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 34

def initialize(
  unique_impression: nil,
  unique_click: nil,
  unique_media_played: nil,
  unique_media_played100_percent: nil,
  **dynamic_attributes
)
  
  @unique_impression = unique_impression
  @unique_click = unique_click
  @unique_media_played = unique_media_played
  @unique_media_played100_percent = unique_media_played100_percent

  dynamic_attributes.each do |key, value|
    self.class.attr_accessor key

    if value.is_a?(Hash)
      struct_klass = Struct.new(*value.keys.map(&:to_sym))
      struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
      instance_variable_set("@#{key}", struct_klass.new(*struct_values))
    else
      instance_variable_set("@#{key}", value)
    end
  end
end

Instance Attribute Details

#unique_click ⇒ Integer?

Returns Number of users who opened any URL in the message.

Returns:

  • (Integer, nil) —

    Number of users who opened any URL in the message.



22
23
24
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 22

def unique_click
  @unique_click
end

#unique_impression ⇒ Integer?

Returns Number of users who opened the message, meaning they displayed at least 1 bubble.

Returns:

  • (Integer, nil) —

    Number of users who opened the message, meaning they displayed at least 1 bubble.



19
20
21
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 19

def unique_impression
  @unique_impression
end

#unique_media_played ⇒ Integer?

Returns Number of users who started playing any video or audio in the message.

Returns:

  • (Integer, nil) —

    Number of users who started playing any video or audio in the message.



25
26
27
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 25

def unique_media_played
  @unique_media_played
end

#unique_media_played100_percent ⇒ Integer?

Returns Number of users who played the entirety of any video or audio in the message.

Returns:

  • (Integer, nil) —

    Number of users who played the entirety of any video or audio in the message.



28
29
30
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 28

def unique_media_played100_percent
  @unique_media_played100_percent
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Insight::GetStatisticsPerUnitResponseOverview

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



63
64
65
66
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 63

def self.create(args) # steep:ignore
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if the objects are equal, false otherwise.

Parameters:

  • other (Object) —

    Object to compare

Returns:

  • (Boolean) —

    true if the objects are equal, false otherwise



70
71
72
73
74
75
76
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 70

def ==(other)
  return false unless self.class == other.class

  instance_variables.all? do |var|
      instance_variable_get(var) == other.instance_variable_get(var)
  end
end

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



79
80
81
 
# File 'lib/line/bot/v2/insight/model/get_statistics_per_unit_response_overview.rb', line 79

def hash
  [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
end