Skip to content

Latest commit

 

History

History
173 lines (101 loc) · 3.95 KB

experienceevent-pushtracking.schema.md

File metadata and controls

173 lines (101 loc) · 3.95 KB
Raw

Push notification tracking Schema

https://ns.adobe.com/xdm/context/experienceevent-pushtracking

push notification tracking details

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/experience-event/experienceevent-pushtracking.schema.json

Schema Hierarchy

  • Push notification tracking https://ns.adobe.com/xdm/context/experienceevent-pushtracking

Push notification tracking Example

{
  "xdm:pushProviderMessageID": "unique msgID from ios/android",
  "xdm:pushProvider": "apns",
  "xdm:customAction": {
    "xdm:actionID": "GAME_INVITATION",
    "xdm:value": 500
  },
  "xdm:isLaunch": true
}

Push notification tracking Properties

Property Type Required Defined by
xdm:pushNotificationTracking object Optional Push notification tracking (this schema)
* any Additional this schema allows additional properties

xdm:pushNotificationTracking

push notification tracking details

Describes interaction with a push notification.

xdm:pushNotificationTracking

  • is optional
  • type: object
  • defined in this schema

xdm:pushNotificationTracking Type

object with following properties:

Property Type Required
xdm:customAction object Optional
xdm:isLaunch boolean Optional
xdm:pushProvider string Optional
xdm:pushProviderMessageID string Optional

xdm:customAction

custom action

End user clicked custom action in the push notification

xdm:customAction

  • is optional
  • type: object
xdm:customAction Type

Unknown type object.

{
  "title": "custom action",
  "type": "object",
  "description": "End user clicked custom action in the push notification",
  "properties": {
    "xdm:actionID": {
      "title": "action ID",
      "type": "string",
      "description": "user clicked custom action identifier",
      "meta:titleId": "experienceevent-pushtracking##xdm:actionID##title##36211",
      "meta:descriptionId": "experienceevent-pushtracking##xdm:actionID##description##39371"
    },
    "xdm:value": {
      "title": "value",
      "type": "number",
      "description": "value associated with the custom action, if any",
      "meta:titleId": "experienceevent-pushtracking##xdm:value##title##83911",
      "meta:descriptionId": "experienceevent-pushtracking##xdm:value##description##93721"
    }
  },
  "meta:titleId": "experienceevent-pushtracking##xdm:customAction##title##33441",
  "meta:descriptionId": "experienceevent-pushtracking##xdm:customAction##description##96791",
  "simpletype": "`object`"
}

xdm:isLaunch

Is Launch

Indicates whether this push notification interaction launched the application.

xdm:isLaunch

  • is optional
  • type: boolean
xdm:isLaunch Type

boolean

xdm:pushProvider

Push Provider

Push provider, e.g. apns or fcm

xdm:pushProvider

  • is optional
  • type: string
xdm:pushProvider Type

string

xdm:pushProviderMessageID

Push Provider message ID

ID assigned to this notification as assigned by the push provider

xdm:pushProviderMessageID

  • is optional
  • type: string
xdm:pushProviderMessageID Type

string