Event

Instance Constructors

new Event(app_id: Option[String], platform: Option[String], etl_tstamp: Option[Instant], collector_tstamp: Instant, dvce_created_tstamp: Option[Instant], event: Option[String], event_id: UUID, txn_id: Option[Int], name_tracker: Option[String], v_tracker: Option[String], v_collector: String, v_etl: String, user_id: Option[String], user_ipaddress: Option[String], user_fingerprint: Option[String], domain_userid: Option[String], domain_sessionidx: Option[Int], network_userid: Option[String], geo_country: Option[String], geo_region: Option[String], geo_city: Option[String], geo_zipcode: Option[String], geo_latitude: Option[Double], geo_longitude: Option[Double], geo_region_name: Option[String], ip_isp: Option[String], ip_organization: Option[String], ip_domain: Option[String], ip_netspeed: Option[String], page_url: Option[String], page_title: Option[String], page_referrer: Option[String], page_urlscheme: Option[String], page_urlhost: Option[String], page_urlport: Option[Int], page_urlpath: Option[String], page_urlquery: Option[String], page_urlfragment: Option[String], refr_urlscheme: Option[String], refr_urlhost: Option[String], refr_urlport: Option[Int], refr_urlpath: Option[String], refr_urlquery: Option[String], refr_urlfragment: Option[String], refr_medium: Option[String], refr_source: Option[String], refr_term: Option[String], mkt_medium: Option[String], mkt_source: Option[String], mkt_term: Option[String], mkt_content: Option[String], mkt_campaign: Option[String], contexts: Contexts, se_category: Option[String], se_action: Option[String], se_label: Option[String], se_property: Option[String], se_value: Option[Double], unstruct_event: UnstructEvent, tr_orderid: Option[String], tr_affiliation: Option[String], tr_total: Option[Double], tr_tax: Option[Double], tr_shipping: Option[Double], tr_city: Option[String], tr_state: Option[String], tr_country: Option[String], ti_orderid: Option[String], ti_sku: Option[String], ti_name: Option[String], ti_category: Option[String], ti_price: Option[Double], ti_quantity: Option[Int], pp_xoffset_min: Option[Int], pp_xoffset_max: Option[Int], pp_yoffset_min: Option[Int], pp_yoffset_max: Option[Int], useragent: Option[String], br_name: Option[String], br_family: Option[String], br_version: Option[String], br_type: Option[String], br_renderengine: Option[String], br_lang: Option[String], br_features_pdf: Option[Boolean], br_features_flash: Option[Boolean], br_features_java: Option[Boolean], br_features_director: Option[Boolean], br_features_quicktime: Option[Boolean], br_features_realplayer: Option[Boolean], br_features_windowsmedia: Option[Boolean], br_features_gears: Option[Boolean], br_features_silverlight: Option[Boolean], br_cookies: Option[Boolean], br_colordepth: Option[String], br_viewwidth: Option[Int], br_viewheight: Option[Int], os_name: Option[String], os_family: Option[String], os_manufacturer: Option[String], os_timezone: Option[String], dvce_type: Option[String], dvce_ismobile: Option[Boolean], dvce_screenwidth: Option[Int], dvce_screenheight: Option[Int], doc_charset: Option[String], doc_width: Option[Int], doc_height: Option[Int], tr_currency: Option[String], tr_total_base: Option[Double], tr_tax_base: Option[Double], tr_shipping_base: Option[Double], ti_currency: Option[String], ti_price_base: Option[Double], base_currency: Option[String], geo_timezone: Option[String], mkt_clickid: Option[String], mkt_network: Option[String], etl_tags: Option[String], dvce_sent_tstamp: Option[Instant], refr_domain_userid: Option[String], refr_device_tstamp: Option[Instant], derived_contexts: Contexts, domain_sessionid: Option[String], derived_tstamp: Option[Instant], event_vendor: Option[String], event_name: Option[String], event_format: Option[String], event_version: Option[String], event_fingerprint: Option[String], true_tstamp: Option[Instant])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val app_id: Option[String]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def atomic: Map[String, Json]

Returns the event as a map of keys to Circe JSON values, while dropping inventory fields
val base_currency: Option[String]
val br_colordepth: Option[String]
val br_cookies: Option[Boolean]
val br_family: Option[String]
val br_features_director: Option[Boolean]
val br_features_flash: Option[Boolean]
val br_features_gears: Option[Boolean]
val br_features_java: Option[Boolean]
val br_features_pdf: Option[Boolean]
val br_features_quicktime: Option[Boolean]
val br_features_realplayer: Option[Boolean]
val br_features_silverlight: Option[Boolean]
val br_features_windowsmedia: Option[Boolean]
val br_lang: Option[String]
val br_name: Option[String]
val br_renderengine: Option[String]
val br_type: Option[String]
val br_version: Option[String]
val br_viewheight: Option[Int]
val br_viewwidth: Option[Int]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val collector_tstamp: Instant
val contexts: Contexts
val derived_contexts: Contexts
val derived_tstamp: Option[Instant]
val doc_charset: Option[String]
val doc_height: Option[Int]
val doc_width: Option[Int]
val domain_sessionid: Option[String]
val domain_sessionidx: Option[Int]
val domain_userid: Option[String]
val dvce_created_tstamp: Option[Instant]
val dvce_ismobile: Option[Boolean]
val dvce_screenheight: Option[Int]
val dvce_screenwidth: Option[Int]
val dvce_sent_tstamp: Option[Instant]
val dvce_type: Option[String]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val etl_tags: Option[String]
val etl_tstamp: Option[Instant]
val event: Option[String]
val event_fingerprint: Option[String]
val event_format: Option[String]
val event_id: UUID
val event_name: Option[String]
val event_vendor: Option[String]
val event_version: Option[String]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def geoLocation: Option[(String, Json)]

Returns a compound JSON field containing information about an event's latitude and longitude, or None if one of these fields doesn't exist
val geo_city: Option[String]
val geo_country: Option[String]
val geo_latitude: Option[Double]
val geo_longitude: Option[Double]
val geo_region: Option[String]
val geo_region_name: Option[String]
val geo_timezone: Option[String]
val geo_zipcode: Option[String]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def inventory: Set[ShreddedType]

Extracts metadata from the event containing information about the types and Iglu URIs of its shred properties
val ip_domain: Option[String]
val ip_isp: Option[String]
val ip_netspeed: Option[String]
val ip_organization: Option[String]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val mkt_campaign: Option[String]
val mkt_clickid: Option[String]
val mkt_content: Option[String]
val mkt_medium: Option[String]
val mkt_network: Option[String]
val mkt_source: Option[String]
val mkt_term: Option[String]
val name_tracker: Option[String]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val network_userid: Option[String]
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def ordered: List[(String, Option[Json])]

Returns the event as a list of key/Circe JSON value pairs.
Returns the event as a list of key/Circe JSON value pairs. Unlike toJsonMap and atomic, these keys use the ordering of the canonical event model
val os_family: Option[String]
val os_manufacturer: Option[String]
val os_name: Option[String]
val os_timezone: Option[String]
val page_referrer: Option[String]
val page_title: Option[String]
val page_url: Option[String]
val page_urlfragment: Option[String]
val page_urlhost: Option[String]
val page_urlpath: Option[String]
val page_urlport: Option[Int]
val page_urlquery: Option[String]
val page_urlscheme: Option[String]
val platform: Option[String]
val pp_xoffset_max: Option[Int]
val pp_xoffset_min: Option[Int]
val pp_yoffset_max: Option[Int]
val pp_yoffset_min: Option[Int]
val refr_device_tstamp: Option[Instant]
val refr_domain_userid: Option[String]
val refr_medium: Option[String]
val refr_source: Option[String]
val refr_term: Option[String]
val refr_urlfragment: Option[String]
val refr_urlhost: Option[String]
val refr_urlpath: Option[String]
val refr_urlport: Option[Int]
val refr_urlquery: Option[String]
val refr_urlscheme: Option[String]
val se_action: Option[String]
val se_category: Option[String]
val se_label: Option[String]
val se_property: Option[String]
val se_value: Option[Double]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val ti_category: Option[String]
val ti_currency: Option[String]
val ti_name: Option[String]
val ti_orderid: Option[String]
val ti_price: Option[Double]
val ti_price_base: Option[Double]
val ti_quantity: Option[Int]
val ti_sku: Option[String]
def toJson(lossy: Boolean): Json

Transforms the event to a validated JSON whose keys are the field names corresponding to the EnrichedEvent POJO of the Scala Common Enrich project.
Transforms the event to a validated JSON whose keys are the field names corresponding to the EnrichedEvent POJO of the Scala Common Enrich project. If the lossy argument is true, any self-describing events in the fields (unstruct_event, contexts and derived_contexts) are returned in a "shredded" format (e.g. "unstruct_event_com_acme_1_myField": "value"), otherwise a standard self-describing format is used.
lossy
Whether unstruct_event, contexts and derived_contexts should be flattened
val tr_affiliation: Option[String]
val tr_city: Option[String]
val tr_country: Option[String]
val tr_currency: Option[String]
val tr_orderid: Option[String]
val tr_shipping: Option[Double]
val tr_shipping_base: Option[Double]
val tr_state: Option[String]
val tr_tax: Option[Double]
val tr_tax_base: Option[Double]
val tr_total: Option[Double]
val tr_total_base: Option[Double]
val true_tstamp: Option[Instant]
val txn_id: Option[Int]
val unstruct_event: UnstructEvent
val user_fingerprint: Option[String]
val user_id: Option[String]
val user_ipaddress: Option[String]
val useragent: Option[String]
val v_collector: String
val v_etl: String
val v_tracker: Option[String]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Event | package scalasdk

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val app_id: Option[String]

final def asInstanceOf[T0]: T0

def atomic: Map[String, Json]

val base_currency: Option[String]

val br_colordepth: Option[String]

val br_cookies: Option[Boolean]

val br_family: Option[String]

val br_features_director: Option[Boolean]

val br_features_flash: Option[Boolean]

val br_features_gears: Option[Boolean]

val br_features_java: Option[Boolean]

val br_features_pdf: Option[Boolean]

val br_features_quicktime: Option[Boolean]

val br_features_realplayer: Option[Boolean]

val br_features_silverlight: Option[Boolean]

val br_features_windowsmedia: Option[Boolean]

val br_lang: Option[String]

val br_name: Option[String]

val br_renderengine: Option[String]

val br_type: Option[String]

val br_version: Option[String]

val br_viewheight: Option[Int]

val br_viewwidth: Option[Int]

def clone(): AnyRef

val collector_tstamp: Instant

val contexts: Contexts

val derived_contexts: Contexts

val derived_tstamp: Option[Instant]

val doc_charset: Option[String]

val doc_height: Option[Int]

val doc_width: Option[Int]

val domain_sessionid: Option[String]

val domain_sessionidx: Option[Int]

val domain_userid: Option[String]

val dvce_created_tstamp: Option[Instant]

val dvce_ismobile: Option[Boolean]

val dvce_screenheight: Option[Int]

val dvce_screenwidth: Option[Int]

val dvce_sent_tstamp: Option[Instant]

val dvce_type: Option[String]

final def eq(arg0: AnyRef): Boolean

val etl_tags: Option[String]

val etl_tstamp: Option[Instant]

val event: Option[String]

val event_fingerprint: Option[String]

val event_format: Option[String]

val event_id: UUID

val event_name: Option[String]

val event_vendor: Option[String]

val event_version: Option[String]

def finalize(): Unit

def geoLocation: Option[(String, Json)]

val geo_city: Option[String]

val geo_country: Option[String]

val geo_latitude: Option[Double]

val geo_longitude: Option[Double]

val geo_region: Option[String]

val geo_region_name: Option[String]

val geo_timezone: Option[String]

val geo_zipcode: Option[String]

final def getClass(): Class[_]

def inventory: Set[ShreddedType]

val ip_domain: Option[String]

val ip_isp: Option[String]

val ip_netspeed: Option[String]

val ip_organization: Option[String]

final def isInstanceOf[T0]: Boolean

val mkt_campaign: Option[String]

val mkt_clickid: Option[String]

val mkt_content: Option[String]

val mkt_medium: Option[String]

val mkt_network: Option[String]

val mkt_source: Option[String]