class AmplitudeAPI::Config

AmplitudeAPI::Config

Attributes

api_key[RW]
event_properties_formatter[RW]
options[RW]
secret_key[RW]
time_formatter[RW]
user_properties_formatter[RW]
whitelist[RW]

Public Class Methods

base_properties() click to toggle source
# File lib/amplitude_api/config.rb, line 19
def base_properties
  %i[event_type event_properties user_properties user_id device_id]
end
defaults() click to toggle source
# File lib/amplitude_api/config.rb, line 40
def defaults
  {
    api_key: nil,
    secret_key: nil,
    whitelist: base_properties + revenue_properties + optional_properties,
    time_formatter: ->(time) { time ? time.to_i * 1_000 : nil },
    event_properties_formatter: ->(props) { props || {} },
    user_properties_formatter: ->(props) { props || {} }
  }
end
new() click to toggle source
# File lib/amplitude_api/config.rb, line 14
def initialize
  self.class.defaults.each { |k, v| send("#{k}=", v) }
end
optional_properties() click to toggle source
# File lib/amplitude_api/config.rb, line 27
def optional_properties
  %i[
    time
    ip platform country insert_id
    groups app_version os_name os_version
    device_brand device_manufacturer device_model
    carrier region city dma language
    location_lat location_lng
    idfa idfv adid android_id
    event_id session_id
  ]
end
revenue_properties() click to toggle source
# File lib/amplitude_api/config.rb, line 23
def revenue_properties
  %i[revenue_type product_id revenue price quantity]
end