コンテンツにスキップ

PassKit

PassKitは、Apple ウォレットとGoogle Payのパスをカスタマーエクスペリエンスに統合することで、モバイルリーチの拡大を支援します。デジタルクーポン、ロイヤルティカード、会員カード、チケットなどの作成、管理、配布、パフォーマンス分析を簡単に行うことができ、顧客は他のアプリを必要としません。

この統合はPassKitによって管理されています。

統合について

BrazeとPassKitの統合により、カスタムのApple ウォレットパスやGoogle Payパスを即座に配信して、オンラインキャンペーンのエンゲージメントを高め、測定できます。さらに、利用状況を分析し、位置情報に基づくメッセージや、顧客のモバイルウォレットへのパーソナライズされたダイナミックな更新をトリガーすることで、リアルタイムに調整を行い、店舗への来店を増やすことができます。

前提条件

要件 説明
PassKit アカウント PassKit アカウントと PassKit アカウントマネージャーが必要です。
userDefinedID PassKit と Braze の間でユーザーのカスタムイベントとカスタム属性を適切に更新するには、Braze の external ID を userDefinedID として設定する必要があります。この userDefinedID は、PassKit エンドポイントへの API 呼び出しで使用されます。
Braze REST APIキー users.track 権限を持つ Braze REST APIキー。

Braze ダッシュボードの 設定 > API キー から作成できます。
Braze REST エンドポイント REST エンドポイントの URL。エンドポイントは、インスタンスの Braze URL によって異なります。

統合

顧客のモバイルウォレット体験をさらに充実させるために、PassKit ダッシュボードから Braze の /users/track エンドポイントを介して Braze にデータを渡すことができます。

PassKit から共有できるデータの例は次のとおりです。

  • パスの作成:顧客がパスのリンクをクリックし、初めてパスが表示されたとき。
  • パスのインストール:顧客がパスをウォレットアプリに追加して保存したとき。
  • パスの更新:パスが更新されたとき。
  • パスの削除:顧客がウォレットアプリからパスを削除したとき。

データが Braze に渡されると、オーディエンスを構築したり、Liquid を使ってコンテンツをパーソナライズしたり、これらのアクションが実行された後にキャンペーンやキャンバスをトリガーしたりできます。

PassKitをBrazeに接続する

PassKitからデータを渡すには、Brazeの external ID をPassKitのexternalIdとして設定していることを確認してください。

  1. PassKitのパスプロジェクトまたはプログラムで、設定の連携にあるBrazeタブの下の接続をクリックします。
    PassKitプラットフォームのBraze連携タイル。

  2. Braze API キー、エンドポイントURLを入力し、コネクターの名前を指定します。

  3. 連携を有効にするをオンにし、Brazeでメッセージのトリガーやパーソナライズに使用したいイベントをオンにします。
    API キー、エンドポイントURL、連携名、有効化設定、メンバーシップ設定、パス設定を入力できるように展開されたPassKitのBraze連携タイル。

Brazeでは、SmartPassリンクを設定して、顧客がAndroidまたはiOSでパスをインストールするための一意のURLを生成できます。そのためには、Brazeのコンテンツブロックから呼び出せる暗号化されたSmartPassデータペイロードを定義する必要があります。このコンテンツブロックは、今後のパスやクーポンで再利用できます。統合では次の情報を使用します。

  • PassKit URL: PassKit URLは、PassKitプログラム固有のURLです。
    各プログラムには一意のURLがあり、PassKitプログラムまたはプロジェクトの配布タブで確認できます。(例: https://pub1.pskt.io/c/ww0jir)

  • PassKitシークレット: URLとあわせて、このプログラムのPassKitキーを用意しておく必要があります。
    これはPassKit URLと同じページで確認できます。

  • プログラム (またはプロジェクト) ID: SmartPass URLを作成するには、PassKitプログラムIDが必要です。
    プロジェクトまたはプログラムの設定タブで確認できます。

暗号化されたSmartPassリンクの作成について詳しくは、PassKitのWebサイトにあるPassKit SmartPass linksを参照してください。

ステップ1: パスデータペイロードを定義する

まず、クーポンまたはメンバーのペイロードを定義する必要があります。

ペイロードにはさまざまなコンポーネントを含めることができますが、ここでは特に重要な2つを紹介します。

コンポーネント 必須 タイプ 説明
person.externalId 必須 文字列 Brazeのexternal IDとして設定します。PassKitからBrazeへのコールバックを機能させるために不可欠で、企業のユーザーが1つのキャンペーンで複数のオファーのクーポンを保持できるようになります。一意性は強制されません。
members.member.externalId オプション 文字列 Brazeのexternal IDとして設定します。external IDを使用してメンバーシップパスを更新できます。このフィールドを設定すると、メンバーシッププログラム内でユーザーの一意性が強制されます。

使用可能なフィールドの完全なリスト、そのタイプ、および説明については、PassKitのGitHubドキュメントを参照してください。

ペイロードの例

{
  "members.member.externalId": "{{${user_id}}}",
  "members.member.points": "100",
  "members.tier.name": "current_customer",
  "person.displayName": "{{${first_name}}} {{${last_name}}}",
  "person.externalId": "{{${user_id}}}",
  "universal.expiryDate": "{{ "now" | date: "%s" | plus: 31622400 | date: "%FT%TZ" }}"
}

ステップ2: 未定義のペイロード変数を作成してエンコードする

Brazeダッシュボードでコンテンツ > コンテンツブロックに移動し、新しいコンテンツブロックを作成して名前を付けます。

コンテンツブロックを作成を選択して開始します。

次に、コンテンツブロックのLiquidタグを定義する必要があります。このコンテンツブロックを保存すると、メッセージ作成時にこのLiquidタグを参照できるようになります。この例では、Liquidタグを{{content_blocks.${passKit_SmartPass_url}}}として割り当てています。

このコンテンツブロックには、ペイロードを直接含めるのではなく、{{passData}}変数で参照します。コンテンツブロックに追加する最初のコードスニペットは、{{passData}}変数をBase64エンコードしたものをキャプチャします。

{% capture base64JsonPayload %}{{passDatapassData|base64_encode}}{% endcapture %}

ステップ3: SHA1 HMACハッシュを使用して暗号化署名を作成する

次に、プロジェクトURLとペイロードのSHA1 HMACハッシュを使用して暗号化署名を作成します。

コンテンツブロックに追加する2つ目のコードスニペットは、ハッシュに使用するURLをキャプチャします。

{% capture url %}{{projectUrl}}?data={{base64JsonPayload}}{% endcapture %}

次に、このハッシュとProject Secretを使用して署名を生成する必要があります。これは、3つ目のコードスニペットを含めることで実行できます。

{% capture sig %}{{url | hmac_sha1: "Project_Secret"}}{% endcapture %}

最後に、5つ目のコードスニペットを使用して、完全なURLに署名を追加します。

{% capture longURL %}{{projectUrl}}?data={{base64JsonPayload}}&sig={{sig}}{% endcapture %}

ステップ4: URLを出力する

最後に、最終的なURLを呼び出して、メッセージ内にSmartPass URLが出力されるようにします。

{{longURL}}

この時点で、次のようなコンテンツブロックが作成されています。

{% capture base64JsonPayload %}{{passData|base64_encode}}{% endcapture %}

{% capture url %}{{projectUrl}}?data={{base64JsonPayload}}{% endcapture %}

{% capture sig %}{{url | hmac_sha1: "Project_Secret"}}{% endcapture %}

{% capture longURL %}{{projectUrl}}?data={{base64JsonPayload}}&sig={{sig}}&utm_source=braze&utm_campaign={{campaign.${name}}}{% endcapture %}{% capture longURL %}{{longURL | url_encode}}{% endcapture %}

{{longURL}}

この例では、これらのインストールの流入元をBrazeとこのキャンペーンまで追跡するために、UTMパラメーターを追加しています。

ステップ5: すべてを組み合わせる

このコンテンツブロックを作成すると、今後も再利用できます。

サンプルのコンテンツブロックには、未定義の変数が2つ残っていることに気付くかもしれません。
{{passData}} - ステップ1で定義したJSONパスデータペイロード
{{projectUrl}} - Passkitプロジェクトの配布タブで確認できる、プロジェクトまたはプログラムのURL

これは意図的なもので、コンテンツブロックの再利用性を高めるためです。これらの変数はコンテンツブロック内で作成されるのではなく参照されるだけなので、コンテンツブロックを作り直すことなく変数を変更できます。

たとえば、ロイヤルティプログラムの初回ポイントを増やすように導入オファーを変更したい場合や、2枚目のメンバーカードやクーポンを作成したい場合があるでしょう。こうしたシナリオでは、異なるPasskitのprojectURLsや異なるパスペイロードが必要になり、それらはBrazeでキャンペーンごとに定義します。

メッセージ本文を作成する

メッセージ本文でこれら両方の変数をキャプチャしてから、コンテンツブロックを呼び出します。 ステップ1で作成した、圧縮済みのJSONペイロードをキャプチャします。

プロジェクトURLを割り当てる

{% assign projectUrl = "https://pub1.pskt.io/c/ww0jir" %}

JSONをキャプチャする

{% capture passData %}{"members.member.externalId": "{{${user_id}}}","members.member.points": "100","members.tier.name": "current_customer","person.displayName": "{{${first_name}}} {{${last_name}}}","person.externalId": "{{${user_id}}}","universal.expiryDate": "{{ "now" | date: "%s" | plus: 31622400 | date: "%FT%TZ" }}"}{% endcapture %}

作成したコンテンツブロックを参照する

{{content_block.${passkit_SmartPass_url}}}

メッセージ本文は次のようになります。 キャプチャしたJSONとコンテンツブロックの参照が表示されたメッセージ作成画面。

サンプルの出力URLは次のとおりです。 ランダムに生成された英数字の長い文字列を含む出力URL。

出力URLは長くなります。これは、すべてのパスデータを含み、データの完全性を確保してURLの改ざんを防ぐための最高水準のセキュリティを組み込んでいるためです。SMSを使用してこのURLを配信する場合は、bit.lyなどのリンク短縮処理にかけることをおすすめします。これは、bit.lyエンドポイントへのコネクテッドコンテンツ呼び出しによって実行できます。

PassKit Webhookを使用してパスを更新する

Brazeでは、Webhookキャンペーンまたはキャンバス内のWebhookを設定して、ユーザーの行動に基づいて既存のパスを更新できます。便利なPassKitエンドポイントの情報については、以下のリンクを参照してください。

ペイロードパラメーター

始める前に、PassKitへの作成および更新Webhookに含めることができる一般的なJSONペイロードパラメーターを紹介します。

データ 型 説明
externalId 文字列 パスレコードに一意のIDを追加し、一意の顧客識別子 (会員番号など) を使用する既存システムとの互換性を確保できます。このエンドポイントでは、パスIDの代わりに userDefinedId と campaignName を使用してパスデータを取得できます。この値はキャンペーン内で一意である必要があり、一度設定すると変更できません。

Brazeとの統合では、Brazeのexternal IDを使用することをお勧めします: {{${user_id}}}
campaignId (クーポン)

programId (メンバーシップ)
文字列 PassKitで作成したキャンペーンまたはプログラムテンプレートのID。これを確認するには、PassKitのパスプロジェクトの Settings タブに移動します。
expiryDate ISO 8601 日時 パスの有効期限。有効期限を過ぎると、パスは自動的に無効になります (isVoided を参照)。この値は、テンプレートとキャンペーンの終了日の値よりも優先されます。
status 文字列 クーポンの現在のステータス (REDEEMED や UNREDEEMED など)。

ステップ1: Braze Webhookテンプレートを作成する

今後のキャンペーンやキャンバスで使用するPassKit Webhookテンプレートを作成するには、Brazeダッシュボードの テンプレートとメディア セクションに移動します。1回限りのPassKit Webhookキャンペーンを作成する場合や既存のテンプレートを使用する場合は、新しいキャンペーンを作成する際にBrazeで Webhook を選択します。

PassKit Webhookテンプレートを選択すると、以下が表示されます。

  • Webhook URL: https://api-pub1.passkit.io/coupon/singleUse/coupon
  • リクエスト本文: 未加工テキスト

リクエストヘッダーとメソッド

PassKitでは、認証のために、Base64でエンコードされたPassKit APIキーを含む HTTP Header が必要です。以下はキーと値のペアとしてすでにテンプレートに含まれていますが、設定 タブで <PASSKIT_LONG_LIVED_TOKEN> をPassKitトークンに置き換える必要があります。トークンを取得するには、PassKitのプロジェクト/プログラムに移動し、Settings > Integrations > Long Lived Token に移動します。

  • HTTPメソッド: PUT
  • リクエストヘッダー:
    • Authorization: Bearer <PASSKIT_LONG_LIVED_TOKEN>
    • Content-Type: application/json

リクエスト本文

Webhookを設定するには、ユースケースに必要なペイロードパラメーターを含め、リクエスト本文に新しいイベントの詳細を入力します。

{
  "externalId": "{{${user_id}}}",
  "campaignId": " 2xa1lRy8dBz4eEElBfmIz8",
  "expiryDate": "2020-05-10T00:00:00Z"
}

ステップ2: リクエストをプレビューする

未加工テキストは、該当するBrazeタグであれば自動的にハイライトされます。

プレビュー パネルでリクエストをプレビューするか、テスト タブに移動します。このタブでは、ランダムユーザーや既存ユーザーを選択したり、独自のユーザーをカスタマイズしたりして、Webhookをテストできます。

Connected Content を使用してパスの詳細を取得する

パスの作成と更新に加えて、Braze の Connected Content を使用してユーザーのパスメタデータを取得し、メッセージングキャンペーンにパーソナライズされたパスの詳細を組み込むこともできます。

PassKit の Connected Content 呼び出し

{% connected_content  https://api-pub1.passkit.io/coupon/singleUse/coupon/externalId/{{${user_id}}} :headers {"Authorization": "Bearer <PASSKIT_LONG_LIVED_TOKEN>","Content-Type": "application/json"} :save passes %}

{{passes.status}}

Liquid のレスポンス例

{
    "redemptionDate": null,
    "redemptionCode": "",
    "lat": 0,
    "lon": 0,
    "alt": 0,
    "redemptionSource": "",
    "redemptionReference": "",
    "transactionReference": "",
    "transactionAmount": 0
}
UNREDEEMED
New Stuff!