Class: Line::Bot::V2::ManageAudience::CreateClickBasedAudienceGroupRequest

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

Overview

Create audience for click-based retargeting

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, request_id: nil, click_url: nil, **dynamic_attributes) ⇒ CreateClickBasedAudienceGroupRequest

Returns a new instance of CreateClickBasedAudienceGroupRequest.

Parameters:

  • description (String, nil) (defaults to: nil) —

    The audience’s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120

  • request_id (String, nil) (defaults to: nil) —

    The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.

  • click_url (String, nil) (defaults to: nil) —

    The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 30

def initialize(
  description: nil,
  request_id: nil,
  click_url: nil,
  **dynamic_attributes
)
  
  @description = description
  @request_id = request_id
  @click_url = click_url

  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

#click_url ⇒ String?

Returns The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000.

Returns:

  • (String, nil) —

    The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000



25
26
27
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 25

def click_url
  @click_url
end

#description ⇒ String?

Returns The audience’s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120.

Returns:

  • (String, nil) —

    The audience’s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120



19
20
21
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 19

def description
  @description
end

#request_id ⇒ String?

Returns The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.

Returns:

  • (String, nil) —

    The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.



22
23
24
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 22

def request_id
  @request_id
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::ManageAudience::CreateClickBasedAudienceGroupRequest

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



57
58
59
60
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 57

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



64
65
66
67
68
69
70
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 64

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



73
74
75
 
# File 'lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_request.rb', line 73

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