Campaign Details Version 1

The documentation present on this page refers to the table that contains campaign configuration details. Each entry on this table refers to a campaign.

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.

`id`

Type: STRING

Description

ID of the campaign

Value Example

5fd0f23c6ab07d00015476a7

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

`name`

Type: STRING

Description

Name of the campaign. Does not follow a name template.

Value Example

21.12 LLAA_APP_Postpago

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

`campaigntype`

Type: STRING

Description

Type of the campaign

Value Example

PUSH_INAPP

Possible Values (if category)

PUSH_INAPP
INAPP
PUSH

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

`organizationid`

Type: STRING

Description

Partner ID for Siprocal. Internal purposes.

Value Example

6364r60eg28a70050364bd2

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

`status`

Type: STRING

Description

Status of the campaign

Value Example

COMPLETED

Possible Values (if category)

COMPLETED
READY
ARCHIVED
STOPPED
DRAFT
PENDING
APPROVED
CANCELLED
REJECTED
EXCEPTION_PENDING
EXCEPTION_READY
CAP_LIMIT_EXCEPTION_PENDING
DELETE_NOSHOW
CAP_LIMIT_EXCEPTION_REJECTED
EXCEPTION_REJECTED
CAP_LIMIT_EXCEPTION_READY
ARCHIEVED

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

`enablevas`

Type: BOOLEAN

Description

Identifies if the Ad is of type Value Added Service (VAS)

Value Example

true

Possible Values (if category)

true
false

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

`audienceclusters`

Type: STRING

Description

Stringfied JSON containing the audience conditions for the campaign

Value Example

"{"condition":"ANY","list":[{"operation":"INCLUDE","condition":"ALL","list":[{"id":"5d37cf66981baf000111188b"}]}]}"

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

`distribution`

Type: STRING

Description

Stringfied JSON Struct field containing campaign distribution information: if end date is specified, start date, end date, expiration date, times to send (week day, start time, end time)

Value Example

"{isenddatespecified=true, startdate=2021-12-21, enddate=2021-12-21, expirationdate=2021-12-21, times=[{dayofweek=2, starttime=720, endtime=721}]}"

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

`insertionorderid`

Type: STRING

Description

ID of the contract signed by the client who requested this campaign. Internal purposes.

Value Example

OC20117

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