Analytics · Android / iOS Reference

Onesecondbefore's Analytics native mobile libraries for iOS and Android let you collect information about visitors in your apps. It consists of a set of commands (e.g. send or set) and a set of (configuration) options that set certain values or change the library's behaviour.

Commands
Data Options

Commands

config
profile
send

Convenience methods:

sendPageView
sendEvent
sendAggregate
sendScreenView

Convenience methods:

setAdditionalConsent
setConsent
setIds

remove

They are described in more detail below.

osb.config(...)

Creates an instance of a tracker. When you create a tracker you should also specify configuration parameters like the URL of the tracker and the account ID. An instance of a tracker should be created as part of the start-up code of the mobile app.

import OSB

let osb = OSB.instance
osb.config(accountId: String, trackerUrl: String)
osb.config(accountId: String, trackerUrl: String, siteId: String)
osb.config(accountId: String, trackerUrl: String, siteId: String, consentCallback: (([String:String]) -> Void)?)

import com.onesecondbefore.tracker.OSB;

// Add this code to your app's initialization code
OSB osb = OSB.getInstance();
osb.config(Context context, String accountId, String trackerUrl);
osb.config(Context context, String accountId, String trackerUrl, String siteId);

Parameters

parameter name	type	required	description
`context`	Context	Android only	Context / Activity.
`accountId`	string	yes	Account id which specifies where your hits will be stored.
`trackerUrl`	string	yes	URL of the tracker used by the app
`siteId`	string	no	Optional identifier used to group hits together
`consentCallback`	function	no	Optional callback function that needs to be called when consent is known. Please also refer to the installation documentation of iOS and Android on this topic.

Examples

iOS
Android

// Minimal configuration for account "account". The siteId will be "development"
let osb = OSB.instance
osb.config(accountId: "account", trackerUrl: "https://myconsent.mydomain.com")

// Creates a tracker for "account" with siteId "mysite.app":
let osb = OSB.instance
osb.config(accountId: "account", trackerUrl: "https://myconsent.mydomain.com",
    siteId: "mysite.app")

// Add a callback function when consent is known and Google Consent Mode has to
//      be updated
func googleConsentCallback(consent: [String: String]) -> Void {
    Analytics.setConsent(Dictionary(
                            uniqueKeysWithValues: consent.map { 
                                t, s in (ConsentType(rawValue: t), 
                                ConsentStatus(rawValue: s)) 
                            })
                        )
}
let osb = OSB.instance
osb.config(accountId: "account", 
           trackerUrl: "https://myconsent.mydomain.com",
           siteId: "mysite.app",
           consentCallback: googleConsentCallback
          )

// Minimal configuration for account "account".
import com.onesecondbefore.tracker.OSB;

// this is Context / Activity
OSB osb = OSB.getInstance();
osb.config(this, "development", "https://myconsent.mydomain.com");

// Creates a tracker with site-id specified:
OSB osb = OSB.getInstance();
osb.config(this, "account", "https://myconsent.mydomain.com", "mysite.app");

parameter name	type	required	description
`type`	enum	yes	Specifies the type to send. The type will be written in column `hit_type`, except for `'action'`, where `sub_type` will be used. See below for the supported types
`subtype`	string	yes if `type == "action"`	You can choose an action from the `ga()` command queue (`detail`, `add`, `remove`, `checkout`, `checkout_option`, `purchase`, `refund` or `promo_click`), or use your own action as long as they only contain letters, numbers and/or underscores. The given `subtype` will be stored in the `hit_type` column.
`data`	Map or Dictionary	no	Contains additional type specific data. Is saved depending on the hit type. Read all about it in the Data Options

iOS type	Android type	description
`OSBHitType.aggregate`	`OSB.HitType.AGGREGATE`	tracks an aggregate event. All hits will be aggregated during sessionization and by pushed to the trash table.
`OSBHitType.event`	`OSB.HitType.EVENT`	tracks an event. Table column `hit_type` will contain `'event'`.
`OSBHitType.ids`	`OSB.HitType.IDS`	tracks identifiers.
`OSBHitType.pageview`	`OSB.HitType.PAGEVIEW`	tracks a pageview, column `hit_type` will contain `'pageview'`. To be used if your app's navigation structure is similar to the website, e.g. a news app.
`OSBHitType.screenview`	`OSB.HitType.SCREENVIEW`	tracks a screenview, column `hit_type` will contain `'screenview'`.
`OSBHitType.viewable_impression`	`OSB.HitType.VIEWABLE_IMPRESSION`	tracks a viewable_impression, column `hit_type` will contain `'viewable_impression'`.

parameter name	type	required	description
`screenName`	string	yes	Screen name.
`className`	string	no	Class name.
`data`	Map or Dictionary	no	Contains additional type specific data. Accepts the data options for screen.

name	type	required	description
`name`	string	no	Name of object used to group additional data under in the JSON payload. See Data Options for more info.
`data`	Map or Dictionary	yes	A Map (Android) or Dictionary (iOS) with additional data to store.

key	type	description
`IABTCF_CmpSdkID`	`Number`	The unsigned integer ID of CMP SDK
`IABTCF_CmpSdkVersion`	`Number`	The unsigned integer version number of CMP SDK
`IABTCF_PolicyVersion`	`Number`	The unsigned integer representing the version of the TCF that these consents adhere to.
`IABTCF_gdprApplies`	`Number`	1 GDPR applies in current context. 0 - GDPR does not apply in current context. Unset - undetermined (default before initialization). See the section "What does the gdprApplies value mean?" for more information.
`IABTCF_PublisherCC`	`String`	Two-letter ISO 3166-1 alpha-2 code – Default: `AA` (unknown)
`IABTCF_PurposeOneTreatment`	`Number`	`0` - no special treatment of purpose one `1` - purpose one not disclosed Unset default - `0`. Vendors can use this value to determine whether consent for purpose one is required.
`IABTCF_UseNonStandardTexts`	`Number`	`1` - CMP uses customized stack descriptions and/or modified or supplemented standard Illustrations `0` - CMP did not use a non-standard stack desc. and/or modified or supplemented Illustrations
`IABTCF_TCString`	`String`	Full encoded TC string
`IABTCF_VendorConsents`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the consent status for Vendor ID n+1; `false` and `true` respectively. eg. `'1'` at index `0` is consent `true` for vendor ID `1`
`IABTCF_VendorLegitimateInterests`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the legitimate interest status for Vendor ID n+1; `false` and `true` respectively. eg. `'1'` at index `0` is legitimate interest established `true` for vendor ID `1`
`IABTCF_PurposeConsents`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the consent status for purpose ID n+1; `false` and `true` respectively. eg. `'1'` at index `0` is consent `true` for purpose ID `1`
`IABTCF_PurposeLegitimateInterests`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the legitimate interest status for purpose ID n+1; `false` and `true` respectively. eg. `'1'` at index `0` is legitimate interest established `true` for purpose ID `1`
`IABTCF_SpecialFeaturesOptIns`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the opt-in status for special feature ID n+1; `false` and `true` respectively. eg. `'1'` at index `0` is opt-in `true` for special feature ID `1`
`IABTCF_PublisherRestrictions{ID}`	`String ['0','1', or '2']`	The value at position n – where n's indexing begins at `0` – indicates the publisher restriction type (0-2) for vendor n+1; (see Publisher Restrictions Types). eg. `'2'` at index `0` is restrictionType `2` for vendor ID `1`. `{ID}` refers to the purpose ID.
`IABTCF_PublisherConsent`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the purpose consent status for purpose ID n+1 for the publisher as they correspond to the Global Vendor List Purposes; `false` and `true` respectively. eg. `'1'` at index `0` is consent `true` for purpose ID `1`
`IABTCF_PublisherLegitimateInterests`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the purpose legitimate interest status for purpose ID n+1 for the publisher as they correspond to the Global Vendor List Purposes; `false` and `true` respectively. eg. `'1'` at index `0` is legitimate interest established `true` for purpose ID `1`
`IABTCF_PublisherCustomPurposesConsents`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the purpose consent status for the publisher's custom purpose ID n+1 for the publisher; `false` and `true` respectively. eg. `'1'` at index `0` is consent `true` for custom purpose ID `1`
`IABTCF_PublisherCustomPurposesLegitimateInterests`	`Binary String`	The `'0'` or `'1'` at position n – where n's indexing begins at `0` – indicates the purpose legitimate interest status for the publisher's custom purpose ID n+1 for the publisher; `false` and `true` respectively. eg. `'1'` at index `0` is legitimate interest established `true` for custom purpose ID `1`

name	type	default value	description
`id`	string	null	Order or transaction id.
`revenue`	float	null	Total revenue amount.
`shipping`	float	null	Shipping amount.
`tax`	float	null	Tax amount.
`currency_code`	string	null	Contains the currency code. We recommend using the ISO-4217 ISO codes.
any other	string	null	Custom data key/value pairs (up to 50 per hit). Will be stored in the data array of the Analytics hits table.

name	type	default value	description
`category`	string	null	Contains the event category, e.g. `'video'`.
`action`	string	null	Contains the event action, e.g. `'play'`.
`label`	string	null	Contains the event label, e.g `'funny_cat_12345.mov'`.
`value`	number	null	Contains the event value, e.g. `0`.
`interaction`	boolean	null (or true)	Contains whether the event should be considered an interaction. Only if `true`, will the hit be sessionized.
any other	string	null	Custom data key/value pairs (up to 50 per hit). Will be stored in the data array of the Analytics hits table.

name	type	default value	description
`key`	string	null	Contains the key of the id, e.g. `_ga`.
`value`	string	null	Contains the id, e.g. `123456789.987654321`.
`label`	string	null	Use this if you want to use the same key in different situations. E.g. a _ga cookie value for different accounts on the same web page.
`hash`	boolean	null	Use this if you want Analytics to hash your value in-memory before storing it in the database, e.g. for email addresses or phone numbers. Hashing is done with `SHA256(salt + ':' + value)` where salt is account specific and can be retrieved from the Onesecondbefore Console (with proper permissions). So if the salt is OSB and the email address is test@onesecondbefore.com, use this statement in BigQuery to calculate the hash: `SELECT TO_HEX(SHA256('OSB:test@onesecondbefore.com'))` (which would be `'c2ddd2d48ea0889b95b6e2750624b9690deb4feacdc6ef81195b17138c989496'`).

name	type	default value	description
`title`	string	JS: `document.title`	Title of the page.
`id`	string	null	Unique id of the page in the Content Management System.
`url`	string	JS: `location.href`	URL of the page, in case you want to override the default. If the value starts with the protocol (e.g. http), it is considered a full URL. If the value starts with a slash (/), everything from the path (including query string and fragment) will be overwritten. If the value starts with a question mark (?), everything after the query string (including the fragment) will be overwritten. If the value starts with a hash (#), everything after the fragment will be overwritten.
`referrer`	string	JS: `document.referrer`	URL of the referrer, in case you want to override the default. If the value starts with the protocol (e.g. http), it is considered a full URL. If the value starts with a slash (/), everything from the path (including query string and fragment) will be overwritten. If the value starts with a question mark (?), everything after the query string (including the fragment) will be overwritten. If the value starts with a hash (#), everything after the fragment will be overwritten.
`osc_id`	string	null	On-site campaign identifier.
`osc_label`	string	null	An extra label in case the on-site campaign identifier alone is not enough.
`oss_keyword`	string	null	On-site search query / keyword.
`oss_category`	string	null	On-site search category.
`oss_total_results`	integer	null	On-site search total number of search results.
`oss_results_per_page`	integer	null	On-site search number of search results per result page.
`oss_current_page`	integer	null	On-site search result current page number.
any other	string	null	Custom data key/value pairs (up to 50 per hit). Will be stored in the data array of the Analytics hits table.

name	type	default value	description
`sn`	string	null	Screen name.
`cn`	string	null	Class name.
data	string	null	Custom data key/value pairs (up to 50 per hit). Will be stored in the data array of the Analytics hits table.

Analytics · Android / iOS Reference

Commands

osb.config(...)

Usage

Parameters

Examples

osb.profile(...)

Usage

osb.send(...)

Usage

Parameters

Type overview

Examples

osb.sendPageView(...)

Parameters

Usage

Examples

osb.sendEvent(...)

Parameters

Usage

Examples

osb.sendScreenView(...)

Usage

Parameters

Examples

osb.set(...)

Usage

Parameters

Examples

osb.setAdditionalConsent(...)

Parameters

Storage and Lookup Keys Set

Usage

Examples

osb.setConsent(...)

Parameters

Storage and Lookup Keys Set

Usage

Examples

osb.setIds(...)

Parameters

Usage

Examples

osb.remove(...)

Usage

Parameters

Examples

Data options

Data options: action

Supported commands

Parameters

Examples

Data options: consent

Supported commands

Parameter

Data options: event

Supported commands

Parameters

Data options: ids

Supported commands

Parameters

Data options: items

Supported commands

Parameters

Data options: page

Supported commands

Parameters

Data options: screen

Supported commands

Parameters