キーと値のペア

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

余分なデータペイロードは、アラートの優先順位付け、ローカライズ、サウンドなどのプッシュ通知のプロパティをカスタマイズするだけでなく、内部メトリクスやアプリのコンテンツを更新するのに役立つ。

プッシュ通知

キー・バリュー・ペアは、Android、iOS、ウェブプッシュ通知にも追加できる。メッセージ・コンポーザーで、Settingsタブを選択し、Add New Pairをクリックし、キーと値のペアを指定する。

iOS

アップル・プッシュ・ノーティフィケーション・サービス（APNs）は、アラートのプリファレンスを設定し、キーと値のペアを使用してカスタムデータを送信することをサポートしている。APNsは、Appleが予約したaps ライブラリを使用する。このライブラリには、アラートのプロパティを管理する所定のキーと値が含まれている。

APSライブラリー

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

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

これらの値は、プッシュ・メッセージを作成する際にSettingsタブで入力することができる。アラート・オプションを選択し、新しいキー・バリュー項目に自動的に入力されるキーのアラート・ディクショナリー・キーを選択する。

BrazeがAPNにプッシュ通知を送信する際、ペイロードは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キー内のアプリケーションから、どのようにでも使用することができる。別のキーを使いたい場合は、アプリがこのカスタムキーを扱えることを確認すること。

アップル社は顧客に対し、顧客情報や機密データをカスタムペイロードデータに含めないよう助言している。さらにアップルは、アラートメッセージに関連するいかなるアクションも、デバイス上のデータを削除しないことを推奨している。

API トリガーキャンペーン

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

Android

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

データペイロード

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

カスタムKey-Valueペアの使用例としては、内部メトリクスの保持やユーザーインターフェイスのコンテキストの設定などがあるが、どのような目的にも使用することができる。

API トリガーキャンペーン

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

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

アンドロイドのプッシュ通知は、FCMメッセージオプションでさらにカスタマイズできる。これには、通知の優先順位、音、遅延、寿命、折りたたみ可能性などが含まれる。これらの値は、プッシュ・メッセージを作成する際にSettingsタブで指定することができる。Brazeメッセージコンポーザーでこれらのオプションを設定する方法については、プッシュ通知の詳細設定を参照のこと。

サイレントプッシュ通知

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

マーケティング担当者は、アプリのユーザーにプッシュ通知を送る前に、サイレント・プッシュ通知が期待される行動を引き起こすかどうかをテストすべきである。iOSまたはAndroidのサイレント・プッシュ通知を作成したら、外部ユーザーIDまたはメールアドレスでフィルタリングして、テスト・ユーザーのみをターゲットにすることを確認する。

キャンペーンを開始したら、テスト・デバイスにプッシュ通知が表示されていないことを確認する。

アプリ内メッセージ

アプリ内メッセージにKey-Valueペアを追加するには、メッセージ・コンポーザーのSettingsタブを選択し、Add New Pairをクリックし、Key-Valueペアを指定する。

API トリガーキャンペーン

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

メール

SparkPostとSendGridの両方が、電子メールのキーと値のペアをサポートしている。SendGridを使用すると、キーと値のペアがユニークな引数として送信される。SendGridでは、10,000バイトのデータまで、キーと値のペアを無制限に添付することができる。これらのキーと値のペアは、SendGridEvent Webhookからの投稿で見ることができる。

コンテンツカードによって促進された

コンテンツカードにキーと値のペアを追加するには、BrazeメッセージコンポーザーのSettingsタブに行き、Add New Pairをクリックする。