キーと値のペア

Brazeでは、キーと値のペアを介して追加のデータペイロードをユーザーデバイスに送信できます。この機能は、プッシュ、アプリ内、メール、コンテンツカードのメッセージングチャネルで利用できます。

追加のデータペイロードは、内部メトリックとアプリコンテンツを更新したり、アラートの優先順位付け、ローカリゼーション、サウンドなどのプッシュ通知プロパティをカスタマイズしたりするのに役立ちます。

プッシュ通知

キーと値のペアは、Android、iOS、および Web プッシュ通知に追加することもできます。メッセージコンポーザーで、「 設定 」タブを選択し、「 新しいペアを追加」をクリックして、キーと値のペアを指定します。

iOS

Apple Push Notification Service (APNs) は、キーと値のペアを使用したアラート設定とカスタムデータの送信をサポートしています。APNs は、アラートのプロパティを制御する事前定義されたキーと値を含む、Apple が予約した aps ライブラリを利用します。

APS ライブラリ

アラート・プロパティ・ライブラリ

Braze メッセージコンポーザーは、 alert とその プロパティ、 content-available、 sound、 category の各キーの作成を自動的に処理します。

これらの値は、プッシュメッセージ作成時に 「設定 」タブで入力できます。[ アラート オプション ] を選択し、新しいキーと値のエントリに自動的に入力されるキーのアラート ディクショナリ キーを選択します。

BrazeがAPNsにプッシュ通知を送信すると、ペイロードはJSONとしてフォーマットされます。

単純なペイロード

1
2
3
{
    "aps" : { "alert" : "Message received from Spencer" },
}

複雑なペイロード

1
2
3
4
5
6
7
8
9
10
11
12
{
    "aps" : {
        "alert" : {
            "body" : "Hi, welcome to our app!",
            "loc-key" : "France",
            "loc-args" : ["Bonjour", "bienvenue"],
            "action-loc-key" : "Button_Type_1",
            "launch-image" : "Paris"
      },
        "content-available" : 1
    },
}

カスタムのキーと値のペア

ライブラリのペイロード値に加えて aps 、カスタムのキーと値のペアをユーザーのデバイスに送信できます。これらのペアの値は、ディクショナリ (オブジェクト)、配列、文字列、数値、ブール値などのプリミティブ型に制限されます。

カスタムキーと値のペアのユースケースには、ユーザーインターフェースのコンテキストを保持および設定する内部指標が含まれますが、これらに限定されません。Brazeでは、追加のキーと値のペアをプッシュ通知とともに送信して、 アプリケーションを介してextrasキー内で使用できます。別のキーを使用する場合は、アプリがこのカスタム キーを処理できることを確認してください。

Appleは、顧客情報や機密データをカスタムペイロードデータとして含めないようにクライアントにアドバイスしています。さらに、Appleは、アラートメッセージに関連するアクションでデバイス上のデータを削除しないことをお勧めします。

APIトリガーキャンペーン

Braze では、カスタム定義の文字列のキーと値のペア ( ) extrasを送信できます。APIトリガーキャンペーンおよびスケジュールされたAPIトリガーキャンペーンのエクストラにアクセスするには、ダッシュボードでキーを「example_key」、値を "$json:{"foo": 1, "bar": 1}"「」に設定します。これにより、開発者コンソールの出力は "extras": { "test": { "foo": 1, "bar": 1 }

Android

Brazeでは、キーと値のペアを使用して、プッシュ通知で追加のデータペイロードを送信送信できます。

データペイロード

iOS プッシュと同様に、カスタムのキーと値のペアをユーザーのデバイスに送信できます。

カスタムキーと値のペアのユースケースには、ユーザーインターフェースのコンテキストの保持と設定を行う内部メトリクスが含まれますが、これらは任意の目的で使用できます。

APIトリガーキャンペーン

Braze では、カスタム定義の文字列のキーと値のペア ( ) extrasを送信できます。APIトリガーキャンペーンおよびスケジュールされたAPIトリガーキャンペーンのエクストラにアクセスするには、ダッシュボードでキーを「example_key」、値を "$json:{"foo": 1, "bar": 1}"「」に設定します。これにより、開発者コンソールの出力 "extras": { "test": { "foo": 1, "bar": 1 }は になります。

FCM メッセージング・オプション

Android プッシュ通知は、FCM メッセージ オプションを使用してさらにカスタマイズできます。これらには、 通知の優先度、 サウンド、遅延、有効期間、折りたたみ可能性が含まれます。これらの値は、プッシュメッセージ作成時に「 設定 」タブで指定できます。Braze メッセージコンポーザーでこれらのオプションを設定する方法の詳細については、 高度なプッシュ通知設定 を参照してください。

サイレントプッシュ通知

サイレントプッシュ通知は、アラートメッセージやサウンドを含まないプッシュ通知で、アプリのインターフェースやコンテンツをバックグラウンドで更新するために使用されます。これらの通知では、キーと値のペアを使用して、これらのバックグラウンド アプリ アクションをトリガーします。サイレントプッシュ通知は、 アンインストールの追跡にも役立ちます。

マーケターは、サイレントプッシュ通知がアプリのユーザーに送信する前に、予期される動作をトリガーすることをテストする必要があります。iOS または Android のサイレントプッシュ通知を作成したら、外部ユーザー ID またはメールアドレスでフィルタリングして、テストユーザーのみをターゲットにします。

キャンペーンの開始時に、テストデバイスで目に見えるプッシュ通知を受け取っていないことを確認する必要があります。

アプリ内メッセージ数

アプリ内メッセージにキーと値のペアを追加するには、メッセージ作成ツールで「 設定 」タブを選択し、「 新しいペアを追加」をクリックして、キーと値のペアを指定します。

APIトリガーキャンペーン

Braze では、カスタム定義の文字列のキーと値のペア ( ) extrasを送信できます。APIトリガーキャンペーンおよびスケジュールされたAPIトリガーキャンペーンのエクストラにアクセスするには、ダッシュボードでキーを「example_key」、値を "$json:{"foo": 1, "bar": 1}"「」に設定します。これにより、開発者コンソールの出力 "extras": { "test": { "foo": 1, "bar": 1 }は になります。

メール

SparkPost と SendGrid はどちらも、メール内のキーと値のペアをサポートしています。SendGrid を使用する場合、キーと値のペアは 一意の引数として送信されます。SendGrid では、最大 10,000 バイトのデータまで、キーと値のペアを無制限にアタッチできます。これらのキーと値のペアは、SendGrid Event Webhook からの投稿で確認できます。

コンテンツカード

コンテンツカードにキーと値のペアを追加するには、Brazeメッセージコンポーザーの「 設定 」タブに移動し、「 新しいペアを追加」をクリックします。