Opt-ins Version 1

This table contains logs of changes in the Opt-in (monetization (1st and 3rd party) and engagement) status for devices with the Siprocal SDK installed. The table shows the status of Opt-in both before and after an event which changed this status occurred.

IMPORTANT:

Please note that there are some [DEPRECATED] fields, you can safely ignore them, even though they will be present in the data exchange. Deprecated fields refer to fields that were collected in the past, and are either not available anymore or cannot be captured for any reason. They are still kept on the database for backwards compatibility reasons;
[EXPERIMENTAL] features are undergoing active development and their definition or collection method may change at any moment without prior notice. We ask not to rely on them for decision making and reporting
Field data collection is made on a best effort basis. Since there are many permisson and device configuration scenarios, it is not possible to guarantee full data collection.

`clientid`

Type: STRING

Description

ID that identifies the users' device (deviceId, idfv or google_gaid). Devices may have the string "DR-" added as a prefix to them. This should be removed if willing to match to external sources.

Value Example

6e3c68ee-9003-4710-9caf-35e742cfab66

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`srcpkg`

Type: STRING

Description

Name of the app package

Value Example

br.com.timbrasil.meutim

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`meta`

Type: STRING

Description

[DEPRECATED]

Value Example

na

Possible Values (if category)

na

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`sourceofrequest`

Type: STRING

Description

Event from which the change in optin status originated. Explanation for each value is in the "sourceofrequest Meanings" tab of this document.

Value Example

registration

Possible Values (if category)

HANDLE_PERMISSION_CHANGES
IDFA_NOT_GRANTED
ENG_OPT_OUT / ENG_OPT_IN
MON_OPT_IN / MON_OPT_OUT
OPT_IN_DENY
HOST_APP
OPT_IN_ACCEPT
IDFA_GRANTED
DB_FAILURE
IMPLICIT_OPT_IN
OPT_OUT_DIALOG
registration
unknown
na

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

Possible Value Descriptions

HANDLE_PERMISSION_CHANGES - When user switches the permissions to opt in to out or vice versa (mainly on iOS devices)
IDFA_NOT_GRANTED - User has not granted access to tracking / showing ads on iOS device
ENG_OPT_OUT / ENG_OPT_IN - User has opted in or out for engagement toggle button (mainly in test app)
MON_OPT_IN / MON_OPT_OUT - User has opted in or out for engagement toggle button (mainly in test app)
OPT_IN_DENY - Android optin dialog Deny button clicked
HOST_APP - Source of Opt in / out is from host application.
OPT_IN_ACCEPT - Android optin dialog Accept button clicked
IDFA_GRANTED - User has granted access to tracking / showing ads on iOS device
DB_FAILURE - SDK Database has been corrupted and moved to a state of irrecoverable. So devices are going to be made inactive.
IMPLICIT_OPT_IN - Opt In is granted with out users explicit approval
OPT_OUT_DIALOG - User opted out through opt out dialog shown
registration - Auto opted in if the registration happened (This is for older sdks)
unknown - Not sure of the source of request.
na - No value set

`actiondateepoch`

Type: BIGINT

Description

Time when the event that generated the optin. Unix timestamp in miliseconds

Value Example

1666633986704

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`oldoptin`

Type: STRING

Description

Opt-in state before the opt-in change request happened. Same format as newoptin

Value Example

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`newoptin`

Type: STRING

Description

Opt-in information from each device. Source of newmonetizationoptin (1st and 3rd party) and newengagementoptin opt-in fields. Collection format is app specific. System behaviour defined in "Possible Values (if category)" dictionary column.

Value Example

Possible Values (if category)

0: complete opt-out from both monetization and engagement 
1: monetization (1st and 3rd party) opt-in, engagement opted-out 
2: first party opted-in (monetization), engagement opted-out 
10: engagement opt-in, monetization opt-out (1st and 3rd party) 
11: engagement opt-in, monetization opt-in (1st and 3rd party) 
12: engagement opt-in, monetization opt-in (1st party, only)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`oldmonetizationoptin`

Type: STRING

Description

Derived from "oldoptin" field: if the user agrees to receive monetization campaigns and ads

Value Example

Possible Values (if category)

0
1
2

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`newmonetizationoptin`

Type: STRING

Description

Derived from "newoptin" field: if the user agrees to receive monetization campaigns and ads

Value Example

Possible Values (if category)

0
1
2

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`oldengagementoptin`

Type: STRING

Description

Derived from "oldoptin" field: if the user agrees to receive engagemente campaigns and ads

Value Example

Possible Values (if category)

0
1

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`newengagementoptin`

Type: STRING

Description

Derived from "newoptin" field: if the user agrees to receive engagemente campaigns and ads

Value Example

Possible Values (if category)

0
1

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`org`

Type: STRING

Description

Human readable partner ID for Siprocal. Internal purposes.

Value Example

tim brasil

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`timestamp`

Type: BIGINT

Description

Date when the data was received in the Siprocal servers. Formatted as an integer with the date values ass YYYYMMDD

Value Example

20230720

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None