Skip to content

キーと値のペア

このページでは、キーと値のペアを使用してユーザーデバイスに追加のデータペイロードを送信する方法について説明します。この機能は、プッシュ通知、アプリ内メッセージ、メール、Content Cardのメッセージングチャネルで利用できます。

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

キーと値のペアはメタデータであるため、このデータは必ずしも受信者に表示されるわけではありませんが、接続されたシステムやプロセスがメッセージ処理をカスタマイズするために使用できます。

各ペアは以下で構成されます:

  • キー: 識別子（例: utm_source）
  • 値: 関連データ（例: newsletter）

ユースケース

キーと値のペアでメタデータを追加するユースケースの例を以下に示します:

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

プッシュ通知

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

メッセージ作成画面で、Settingsタブを選択し、Add New Pairを選択して、キーと値のペアを指定します。

iOS

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

APSライブラリー
キー 値の型 値の説明
alert 文字列またはディクショナリオブジェクト 文字列入力の場合、文字列をメッセージとして「閉じる」ボタンと「表示」ボタン付きのアラートを表示します。文字列以外の入力の場合、入力の子プロパティに応じてアラートまたはバナーを表示します
badge 数値 アプリアイコンのバッジとして表示される数値を制御します
sound 文字列 アラートとして再生するサウンドファイルの名前。アプリのバンドルまたはLibrary/Soundsフォルダーに存在する必要があります
content-available 数値 値1を入力すると、起動時またはセッション再開時に新しい情報が利用可能であることをアプリに通知します
アラートプロパティライブラリー
キー 値の型 値の説明
title 文字列 Apple Watchが通知の一部として短時間表示する短い文字列
body 文字列 プッシュ通知のコンテンツ
title-loc-key 文字列またはnull Localizable.stringsファイルから現在のローカライゼーションのタイトル文字列を設定するキー
title-loc-args 文字列の配列またはnull title-loc-keyのタイトルローカライゼーションフォーマット指定子の代わりに表示できる文字列値
action-loc-key 文字列の配列またはnull 指定された場合、指定された文字列が「閉じる」ボタンと「表示」ボタンのローカライゼーションを設定します
loc-key 文字列またはnull Localizable.stringsファイルから現在のローカライゼーションの通知メッセージを設定するキー
loc-args 文字列の配列 loc-keyのローカライゼーションフォーマット指定子の代わりに表示できる文字列値
launch-image 文字列 ユーザーがアクションボタンをタップするかアクションスライドを移動したときに起動画像として使用するアプリバンドル内の画像ファイルの名前

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

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

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トリガーCampaigns

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

Android

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

データペイロード

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

カスタムキーと値のペアのユースケースには、内部指標の管理やユーザーインターフェイスのコンテキスト設定などがありますが、任意の目的に使用できます。

APIトリガーCampaigns

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

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

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

サイレントプッシュ通知

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

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

Campaignの起動時に、テストデバイスで目に見えるプッシュ通知を受信していないことを確認してください。

アプリ内メッセージ

従来のエディターで、Settingsタブを選択し、Add New Pairを選択してから、キーと値のペアを指定することで、アプリ内メッセージにキーと値のペアを追加できます。

APIトリガーCampaigns

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

メール

SparkPostとSendGridの両方がメールでのキーと値のペアをサポートしています。SendGridを使用している場合、キーと値のペアはunique argumentsとして送信されます。SendGridでは、最大10,000バイトのデータまで無制限の数のキーと値のペアを添付できます。これらのキーと値のペアは、SendGridのEvent Webhookからの投稿で確認できます。

Brazeのメールメッセージ作成画面の送信情報タブ

Content Cards

Content Cardsにキーと値のペアを追加するには、Brazeのメッセージ作成画面のSettingsタブに移動し、Add New Pairを選択します。

Content Cardsにキーと値のペアを追加
New Stuff!