Adobe Campaign Standard event reference

Events handled

Campaign Request Content

This event is dispatched from the Event Hub for the following scenarios:

  • Dispatch the event data that contains the loaded consequences for the latest registered Campaign rules.

  • This event is dispatched immediately after a Campaign rule is found to be true. For example, if the rule is User has launched the app, after the user launches the app, this rule is found to be true. This event also contains the data of the displayed local, alert, or full-screen message.

Data payload definition

Here are the key-value pairs in this event:

Key

Value Type

Optional

Description

triggeredconsequence

Array

loadedconsequences

Array

Event data example

{
"loadedconsequences": [
{
"assetsPath":"assets/path/",
"detail":"details",
"id":"123",
"type":"iam"
},
{
"assetsPath":"assets/path/",
"detail":"details",
"id":"456",
"type":"csp"
}]
}

Configuration Response Content

The data property in this event is used by each extension to modify its current settings. Each extension is responsible for reading out the part of the data property for which it is concerned.

Data payload definition

The Adobe Campaign Standard extension reads the following key from the configuration event:

Key

Value Type

Optional

Description

__dev__campaign.server

String

Yes

This contains the endpoint URL for the development environment in the Adobe Campaign Standard instance.

__dev__campaign.pkey

String

Yes

This contains the identifier for a mobile app that was configured in development environment in Adobe Campaign Standard.

__stage__campaign.server

String

Yes

This contains the endpoint URL for the stage environment in the Adobe Campaign Standard instance.

__stage__campaign.pkey

String

Yes

This contains the identifier for a mobile app that was configured in the stage environment in Adobe Campaign Standard.

campaign.server

String

Yes

This contains the endpoint URL for the production environment in the Adobe Campaign Standard instance.

campaign.pkey

String

Yes

This contains the identifier for a mobile app that was configured in in the production environment in Adobe Campaign Standard.

campaign.mcias

String

Yes

This contains the in-app messaging service URL endpoint

campaign.timeout

Integer

Yes

This contains the amount of time to wait for a response from in-app messaging service

global.privacy

Boolean

Yes

This contains the mobile privacy status settings

After global.privacy is changed to optout, the linkage fields are reset. All downloaded messages and rules are erased, and no tracking request can leave the device.

Event data example

{
"global.privacy":"optedin",
"campaign.timeout":1,
"campaign.mcias":"mcias-va7.cloud.adobe.io/mcias",
"__dev__campaign.pkey":"",
"__stage__campaign.pkey":"",
"campaign.pkey":"",
"__dev__campaign.server":"mcias.campaign-demo.adobe.com",
"__stage__campaign.server":"mcias.campaign-demo.adobe.com",
"campaign.server":"mcias.campaign-demo.adobe.com"
}

Request Identity

This event is dispatched by the API to setLinkageFields, which sets the linkage fields. It is used to download personalized in-app messages.

Data payload definition

Here are the key-value pairs in this event:

Key

Value Type

Optional

Description

linkage_fields

Map

No

This map contains at least one of the linkage fields that are used to personally identify the logged in user.

Event data example

{
"linkagefields":
{
"firstName":"john",
"lastName":"doe",
"age":30
}
}

Request Reset

This event is dispatched when users no longer want to use personalized in-app messages. After this event is received, Campaign deletes all personalized messages and downloads only generic messages again.

Data payload definition

This event has no event data.

Lifecycle Response Content

This event is a response from the Lifecycle extension to notify a client/extension about lifecycle context data in which the extension/client might be interested. The event is generated by the Lifecycle extension, and the API is called after a lifecycle start, stop, or pause.

Data payload definition

Here are the key-value pairs in this event:

Key

Value Type

Optional

Description

lifecyclecontextdata

Map

No

Event data example

{ "lifecyclecontextdata":
{
"installdate":"22/05/2014",
"hourofday":6,
"dayofweek":2,
"osversion":"iOS 12.3",
"appID":"contextDataValue",
"resolution":"600x1345",
"devicename":"iPhoneX",
"launchevent":"LaunchEvent",
"prevsessionlength":345,
"locale":"en-US",
"runmode":"Application",
"launches":42
},
"starttimestampmillis" :44,
"maxsessionlength":22
}

Events dispatched

Campaign Response Content

This event is a response from the Adobe Campaign Standard extension and contains the message interaction details (Viewed, Triggered or Clicked).

Event details

Event Type

Event Source

Paired

com.adobe.eventType.campaign

com.adobe.eventSource.responseContent

Yes

Data payload definition

Here is the definition of the key-value pairs in this event:

Key

Value Type

Optional

Description

a.message.id

String

No

Message ID of the message that was triggered.

a.message.triggered

String ("1")

No

Flag that specifies a message triggered event. Only one type of message interaction exists in each Campaign response content event.

a.message.viewed

String ("1")

No

Flag that specifies a message viewed event.

a.message.clicked

String ("1")

No

Flag that specifies a message clicked event.

Event data example

{ "a.message.id": "12345678", "a.message.triggered": "1" }
{ "a.message.id": "12345678", "a.message.viewed": "1" }
{ "a.message.id": "12345678", "a.message.clicked": "1" }