キーと値のペア

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

キーと値のペアを使って、メッセージに構造化メタデータを追加する。これらの追加のデータペイロードは、メッセージのレンダリング方法や処理方法に影響を与えることができる追加の文脈に応じた情報で、メッセージを充実させることができます。

キーと値のペアはメタデータであるため、このデータは必ずしも受信者に見えるわけではないが、接続されたシステムやプロセスによって、メッセージ・ハンドリングをカスタマイズするために使用することができる。

各ペアは以下のように構成されている：

• キー:識別子 (例:utm_source)
• 値:関連データ (例:newsletter)

ユースケース

キーと値のペアでメタデータを追加するユースケースをいくつか紹介しよう：

1. トラッキングパラメータ：分析のためにUTMパラメータを付加する
   • キー: utm_campaign
   • 値: spring_sale
2. カスタムタグ:内部ルーティングや分類のためにタグを追加する。
   • キー: priority
   • 値: high
3. 行動トリガー:アプリ内行動のトリガーやカスタマイズに使用されるメタデータ
   • キー: deep_link
   • 値: app://promo-page

プッシュ通知

キーと値のペアは、Android、iOS、および Web のプッシュ通知に追加できます。キーと値のペアを使用して、内部メトリクスやアプリのコンテンツを更新したり、アラートの優先順位、ローカライゼーション、サウンドなどのプッシュ通知のプロパティをカスタマイズしたりすることができる。

メッセージ作成画面で [設定] タブを選択し、[新しいペアを追加] をクリックして、キーと値のペアを指定します。

iOS

Apple のプッシュ通知サービス (APN) は、アラートの設定、およびキーと値のペアを使用するカスタムデータの送信をサポートしています。APN は、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 キー内の追加のキーと値のペアを送信できます。別のキーを使いたい場合は、アプリがこのカスタムキーを扱えることを確認すること。

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

API トリガーキャンペーン

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

Android

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

データペイロード

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

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

API トリガーキャンペーン

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

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

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

サイレントプッシュ通知

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

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

キャンペーンの開始時に、表示されるプッシュ通知がテストデバイスで受信していないことを確認する必要があります。

アプリ内メッセージ

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

API トリガーキャンペーン

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

メール

SparkPostとSendGridの両方が、電子メールのキーと値のペアをサポートしている。SendGrid を使用する場合、キーと値のペアは一意の引数として送信されます。SendGrid では、データが 10,000 バイトに達するまでキーと値のペアを無制限にアタッチできます。これらのキーと値のペアについては、SendGrid の Event Webhook の投稿を参照してください。

コンテンツカード

コンテンツカードにキーと値のペアを追加するには、Braze のメッセージ作成画面の [設定] タブに移動し、[新しいペアを追加] をクリックします。