プッシュ通知のペイロード構造について push-payload
Adobe Campaignを使用すると、iOSおよびAndroidのモバイルデバイスで、パーソナライズされたセグメント化されたプッシュ通知をモバイルアプリケーション（モバイルアプリ）に送信できます。
モバイルアプリで受信されるすべてのプッシュ通知には、アプリが使用する一部の情報が含まれます。プッシュ通知が送信された場合にプッシュ通知を表示し、特にサイレントプッシュ通知が送信された場合に、さらに何らかの処理を行う可能性が最も高くなります。
この情報は、プッシュ通知を受信したことを示すイベントハンドラーで、モバイルアプリコードによって受信されます。 Adobe Campaign Standardからプッシュ通知を送信する場合、モバイルアプリで受信した情報には、Campaign Standardが提供する一部の機能を活用するために使用できるCampaign Standard固有の情報も含まれている場合があります。 さらに、ペイロードには、モバイルアプリで使用できるカスタムデータを含めることができます。
このドキュメントでは、Adobe Campaign Standardからアプリにプッシュ通知が正常に送信されたときに、モバイルアプリで受信されるペイロードの構造について説明します。
プッシュペイロード構造 push-payload-structure
この節では、様々なモバイルプラットフォームのサンプルペイロードの構造を詳しく説明し、その中に含まれる主な属性について説明します。 これは、イベントハンドラーでモバイルアプリコードで受信したペイロードの構造で、プッシュ通知を受信したことを示します。
ペイロード属性とその値は、プッシュ通知の詳細オプションで提供される設定によって異なります。 この節では、Campaign Standard UIでのこれらの設定とペイロード内の属性のマッピングも提供して、Campaign Standardでオプションを設定する際にペイロードがどのように変化するかを明確にします。
IOS モバイルアプリの場合 payload-structure-ios
サンプル ペイロードが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 Testerで使用する 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定義のキーを含み、通知を受け取るシステムがユーザーに警告する方法を判断するために使用されます。 このセクションには、プッシュ通知の動作を作成するためにモバイルアプリで使用される定義済みキーが含まれています。
Apps内の属性について詳しくは、Apple開発者ドキュメントを参照してください。 リモート通知ペイロードの作成。
Android アプリの場合 payload-structure-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） を参照してください。
Campaign Standard設定とペイロード属性のマッピング mapping-payload
メッセージ本文
→アラート→本文
body
タイトル キーと本文キーは、アラートの内容を提供します。
カテゴリーキーを使用すると、そのカテゴリのアクションを警告インターフェイスのボタンとしてシステムに表示できます。
（iOS 10以降にのみ適用）
このURLに値を指定すると、可変コンテンツフラグが自動的にペイロードに送信されます。
（iOS 10以降にのみ適用）
（iOS 10以降にのみ適用）
（iOS 10以降にのみ適用）
（Androidにのみ適用）
_dId
_dId
プッシュ通知がクリック/開かれたときにトラッキング ポストバックをトラッキングに呼び出してトラッキングを実行する場合は、これらの属性が必要です。 この情報は、ユーザーの介入なしにアプリサーバーによって内部的に計算および送信されます。
ポストバックに関する情報は、この ページ にあります。
モバイルアプリコードでペイロード情報を取得する方法 payload-information
アプリサーバーが送信したペイロード情報は、プッシュ通知を受信したことを示すイベントハンドラー内のモバイルアプリコードによって受信されます。 このイベントは、作業中のモバイルプラットフォームと、アプリが前景または背景で実行されているかどうかに応じて異なります。 次のドキュメントは、ユースケースに基づいて、処理するイベントハンドラーを特定するのに役立ちます。
- iOS アプリケーション： リモート通知のリモート通知の処理 セクション。
- Android アプリケーション：Android クライアントアプリでメッセージを受信
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");
}