TROCCO Web Activity Log Collection SDK - Technical Specifications

summary

This page describes the following

• operating environment
• Session Definition
• Channel Definition
• Information about logging and storage
• How to track page views when a page transitions in Single Page Application

operating environment

TROCCO Web Activity Log Collection SDK has confirmed that logs made in the following environments are collected.

OS

• Windows 10 or higher
• macOS 10 or higher
• Android 7 or higher
• iOS 12 or higher

Web Browser

• Microsoft Edge 42 or higher
• Google Chrome 72 or above
• Safari 12 or higher
• Mozilla Firefox 65 or higher

Session Definition

What is a session?

It is a concept that summarizes the sequence of events from the time a user visits a site until he or she leaves.
It is synonymous with sessions and visits in Google Analytics.

This section mainly describes session termination conditions.
There are two main conditions for session termination

• Termination by time
• Termination due to campaign switchover

Termination by time

For convenience, the session timeout period is described below with a default value of 30 minutes.
If you want to change the session timeout period, change session_expire_msec from Modify existing settings.

Termination by no-operation time

The session ends when there has been no activity for 30 minutes since the last PageView.
If a new PageView occurs after 30 minutes, the PageView is tied to the new session.

Continuation by event

If the event occurs before 30 minutes have elapsed since the last PageView, the previously counted timeout time is reset once.
That is, a session ends when it has not been operated for 30 minutes since the previous event.
Therefore, it is possible for any two PageViews that are more than 30 minutes apart in time between occurrences to be treated as the same session.

Termination due to campaign switchover

Sessions may switch due to inflows from different pages.

Determination by campaign parameters

If the campaign parameters specified below are set in the URL of the current page, a session switching decision will be made based on the campaign parameters.
For example, UTM parameters and ad parameters that you set independently fall under campaign parameters.
Note that if the current page has campaign parameters, the session will continue if all campaign parameters match those at the time of the inflow.

Judgment by Referrer

Each time a page view is generated, a session switching decision is made by referrer.

In this process, the referrer URL is first compared to the incoming URL at the start of the session.
If these URLs match, the transition is considered to be within the same site and the session continues.

If the above URLs are different, the host of****the referrer URL is compared to the host of the current page URL.
If these hosts are different, they are essentially considered to be coming from different sites and the session is switched.

The following is an example of session switching judgment by referrer.
Referrer URL host yahoo.co.jp and session start URL hostwww.google.comは異なるため、セッションが切り替えられます。

Channel Definition

What is a channel?

Label to identify the inflow path.
It is determined from the referrer and landing page URL at the start of the session, and the same value is retained by all PageViews in the session.
Channels are organized into the following five concepts and are hierarchically structured.

channel_group > medium > source > campaign > keyword

In addition, channels are divided into the following two types

• Channels by UTM parameters
• Channels automatically assigned

Channels by UTM parameters

If UTM parameters are given to the landing page, any channel can be set.
For example, see https://your-site.com?utm_medium=Foo&utm_source=Bar&utm_campaign=hogeというURLでランディングした場合,
The values for each channel will be as follows

• medium: Foo
• source: Bar
• campaign: hoge
• keyword: NULL

Channels automatically assigned

Channels are automatically identified on well-known social networking and search sites.
Only channels for which the assignment method in the definition list is "automatic" are covered.
Note that even for transitions subject to automatic assignment, if there is a UTM parameter, that parameter takes precedence.

List of channel definitions

Please refer to the following csv file.

n_analytics_channel_definition.csv

Information about logging and log files

Logs collected by TROCCO Web Activity Log Collection SDK will be stored on Amazon S3 managed by us when the following conditions are met

• When 5 minutes have elapsed since the last save
• When the collected file size reaches 256 MB

In addition, multiple API servers for TROCCO Web Activity Log Collection SDK are always in operation for load balancing and redundancy. (The number of servers is undisclosed.)
Therefore, at a single save timing, files are generated for the number of servers.
The number of lines in each file is not guaranteed, but will be divided approximately evenly.

If the total size of the log files to be retrieved at any given time exceeds the "number of servers x 256 MB," the log files for the "number of servers x 256 MB" will be saved first.
The remaining log files not saved at that timing will be saved at the next timing (5 minutes later).

How to track page views when a page transitions in Single Page Application

Please add processing to the JavaScript on the website side so that the following code section described in Embedding JavaScript Code is executed at the timing of page transitions.

Nanalytics('setup','<site_id>',(new Date).getTime());
Nanalytics('send','pageview');