了解 推送通知有效载荷结构

Adobe Campaign允许您将iOS和Android移动设备上的个性化和分段推送通知发送到移动应用程序(移动应用程序)。

在移动应用程序上收到的每个推送通知都包含一些信息,在发送警报推送通知时,应用程序会使用这些信息显示推送通知,并且极有可能还会进行进一步计算,尤其是在发送无提示推送通知时。

此信息由移动应用程序代码在指示已接收推送通知的事件处理程序中接收。 从Adobe Campaign Standard发送推送通知时,移动应用程序中收到的信息也可能包含Campaign Standard特定信息,这些信息可用于利用Campaign Standard提供的某些功能。 此外,有效负荷可包含可由移动应用程序使用的自定义数据。

此文档描述从Adobe Campaign Standard成功将推送通知发送到应用程序时在移动应用程序中接收的有效负荷的结构。

注意

有效负荷结构因移动应用程序(即,iOS应用程序、支持FCM的Android应用程序)的类型而异。

推送有效负荷结构

本节详细描述了不同移动平台的示例有效负荷的结构,并描述了其中包含的主要属性。 这是事件处理函数中移动应用程序代码中收到的有效负荷的结构,指示已接收推送通知。

有效负荷属性及其值将因推送通知高级选项中提供的配置而有所不同。 本节还提供Campaign Standard UI中这些配置与有效负荷中属性之间的映射,以便阐明在Campaign Standard中配置选项时有效负荷将如何更改。

对于iOS Mobile App

从Adobe Campaign发送到iOS应用程序的负载示例:

{

    "aps":{

            "alert":{

                    "body":"This is the content of my push notification",

                    "title":"Push Notification Title"

            },

            "content-available":1,

            "category":"NEW_MESSAGE_CATEGORY",

            "badge":2,

            "mutable-content":1,

            "sound":"default"

        },

    "custom_field1":"custom_value1",

    "custom_field2":"custom_value2",

    "media-attachment-url":"https://2.img-dpreview.com/files/p/articles/9440145363/Creative_Cloud.jpeg",

    "uri":"https://mydeeplinkurl.com",

    "_dId":"56c4",

    "_mId":"h138a"} 

要与iOS APNS测试程序一起使 用的JSON示例负载

{

  "aps": {

    "alert": {

      "title": "Push Notification Title",

      "body": "body of push"

    },

    "badge": 33,

    "sound": "default"

  },

  "custom_field1": "custom_value1",

  "uri": "https://mydeeplinkurl.com"

}

有效负荷最重要的部分是aps词典,它包含Apple定义的键,用于确定接收通知的系统应如何提醒用户(如果有的话)。 本节包含预定义的键,这些键由移动应用程序用来制定推送通知的行为。

有关应用程序内属性的详细信息,请参阅Apple开发人员文档:创建远程通知有效负荷

对于Android应用程序

从Adobe Campaign到Android应用程序的有效负荷发送示例

{

  "collapseKey": "1476005",

  "priority": "high",

  "data": {

    "_dId": "d57fd6",

    "_mId": "h1685a5",

    "body": "adobe body 123",

    "category": "adobe category 123",

    "custom key 1": "value 1",

    "custom key 2": "test value 2",

    "custom key 3": "foo bar android",

    "media-attachment-url": "http://adobegiphy.com?test=123",

    "sound": "http://testcampaign.instance.com/r/?id=s1685a5,d57fd6,d57ff5",

    "title": "adobe title 123",

    "uri": "http://testcampaign.instance.com/r/?id=d1685a5,d57fd6,d57ff6",

    "badge": 1817

  }

}

使用Google FCM测试程序的JSON 示例负载

{

  "to": "<==========ENTER your device token==============>",

  "collapseKey": "1476005",

  "priority": "high",

  "data": {

    "_dId": "d57fd6",

    "_mId": "h1685a5",

    "title": "adobe title 123",

    "body": "adobe body 123",

    "category": "adobe category 123",

    "custom key 1": "value 1",

    "custom key 2": "test value 2",

    "custom key 3": "foo bar android",

    "media-attachment-url": "http://adobegiphy.com?test=123",

    "sound": "http://testcampaign.instance.com/r/?id=s1685a5,d57fd6,d57ff5",

    "uri": "http://testcampaign.instance.com/r/?id=d1685a5,d57fd6,d57ff6",

    "badge": 1817

  }

}

负载包含包含所有推送通知投放内容(包括自定义键/值对)的数据消息,如果需要,客户端应用程序必须处理该消息来构建和显示推送通知,否则必须添加任何其他业务逻辑。

要了解android负载的方面,请参阅消息传递概念和选项(fcm)

注意

自2018年1月起,已删除对Android负载中通知消息的支持,以便能够唤醒应用程序并将控制权传递到移动应用程序,而无需用户与应用程序交互。

Campaign Standard配置和有效负荷属性之间的映射

活动配置 iOS中受影响的属性 Android中受影响的属性 说明
消息标题
消息正文
警报→标题
警报→正文
标题
此数据包含警报消息的特定信息。
标题和正文键提供警报的内容。
播放提示音 声音 声音 要播放警报的自定义声音。
徽章的值 徽章 徽章 用于标记应用程序图标的整数值。
添加深层链接 uri NA 利用深层链接,您可以直接将用户导向应用程序内的内容(而不是打开 Web 浏览器页面)。
类别 类别 类别 使用远程通知显示自定义操作。
类别键帮助系统将该类别的操作显示为警报界面中的按钮。
自定义字段 custom_field1、custom_field2… custom_field1、custom_field2… 要发送到应用程序的任何自定义数据。
富媒体内容URL(图像、gif、音频和视频文件)
(仅适用于iOS 10或更高版本)
media-attachment-url NA 用于向通知添加丰富内容的媒体文件的URL。
为此URL提供值时,可变内容标志会自动发送到有效负荷中。
(仅适用于iOS 10或更高版本)
可变内容
(仅适用于iOS 10或更高版本)
可变内容 NA 应用程序中的Notification Service Extension将使用可变内容密钥“截取”所有远程通知,并允许您处理/处理请求有效负荷的内容,然后该内容可用于自定义通知。 此功能的用例包括下载和显示多个媒体、解密推送有效负荷中存在的任何加密数据。 有关详细信息,请参阅修改远程通知的有效负荷
(仅适用于iOS 10或更高版本)
可用内容 内容可用 NA 选择此选项可启用iOS应用程序处于后台/挂起状态时的唤醒。 唤醒意味着应用程序在后台运行,负责接收推送通知数据有效负荷的适当事件处理程序将获得一个控件,并可以使用数据进行任何计算,包括但不限于构建自定义推送通知并显示相同内容。 有关详细信息,请参阅唤醒具有通知投放的应用程序
富媒体内容URL(图像文件)
(仅适用于Android)
NA media-attachment-url 用于向通知添加丰富内容的图像文件的URL。
NA _mId
_dId
_mId
_dId
broadlogId和deliveryId的值。
如果您的应用程序希望调用跟踪回发以跟踪单击/打开推送通知的时间,则需要这些属性。此信息由应用程序服务器在内部计算并发送,无需用户干预。
有关回发的信息可在此页 中找到

如何在移动应用程序代码中检索负载信息

应用程序服务器发送的有效负荷信息由移动应用程序代码在指示已接收推送通知的事件处理程序中接收。 此事件将因正在使用的移动平台而异,也因应用程序在前景还是背景中运行而异。 以下文档将帮助您根据您的用例确定要处理的事件处理程序。

iOS移动应用程序示例

 - (void)application:(UIApplication *)application

didReceiveRemoteNotification:(NSDictionary *)userInfo {

    

    NSDictionary *apsDict = [userInfo objectForKey:@"aps"];

    NSDictionary *alertDict = [apsDict objectForKey:@"alert"];

    NSString *title = [alertDict objectForKey:@"title"];

    NSString *body = [alertDict objectForKey:@"body"];

    NSString *category = [apsDict objectForKey:@"category"];

    NSString *deliveryId = userInfo[@"_dId"];

    NSString *broadlogId = userInfo[@"_mId"];

    NSString *mediaAttachmentURL = userInfo[@"media-attachment-url"];

    NSString *deeplinkURL = userInfo[@"uri"];

    NSString *customValue1 = userInfo[@"custom_field1"];   

}

Android Mobile FCM应用程序示例

public void onMessageReceived(RemoteMessage message) {

    Map<String, String> dataMap = message.getData();

     

    String title = dataMap.get("title");

    String body = dataMap.get("body");

    String category = dataMap.get("category");

    String deliveryId = dataMap.get("_dId");

    String broadlogId = dataMap.get("_mId");

    String mediaAttachmentURL = dataMap.get("media-attachment-url");

    String deeplinkURL = dataMap.get("uri");

    String customValue1 = dataMap.get("custom_field1");

}

在此页面上