Skip to content

コネクテッドコンテンツを使用したデータの取得

Braze コネクテッドコンテンツを使用して、Voucherify API からデータを取得し、特定の Braze セグメントにメッセージを送信できます。このリファレンス記事では、Voucherify クーポンの発行、新しい紹介者の招待、ロイヤルティカードの残高の取得などのために、コネクテッドコンテンツスクリプトを設定する方法などを紹介します。

スクリプトの基本スキーマは次のようになります:

1
2
3
4
5
6
7
8
9
10
11

{% connected content
  "voucherify-API-ENDPOINT-url"
  :method post
  :headers {
    "X-App-Id": "Voucherify-API-key",
    "X-App-Token": "Voucherify-Secret-key",
  }
  :content_type application/json
  :retry
  :save {{result_variable}}
}

Voucherify の GitHub リポジトリにアクセスして、コネクテッドコンテンツスクリプトの例を参照してください。

セキュリティ設定

以下の設定が行われてない場合、コネクテッドコンテンツメッセージがトリガーされるたびに、Voucherify API が2回以上呼び出されます。これらの設定により、Brazeに請求されるAPIコールの数が減り、メッセージ配信を妨げる可能性のあるハードブロッキングAPI制限に達するリスクが軽減されます。

レート制限

Braze によって送信されるメッセージの数を1分あたり制限するようにしてください。これにより、キャンペーンからの過剰なトラフィックに対して、BrazeおよびVoucherifyのAPIの両方が保護されます。キャンペーンの設定中にユーザーをターゲットにする場合、送信率を1分あたり500メッセージに制限してください。

POST 呼び出しでのキャッシュ

HTTP POST を使用して実行されるコネクテッドコンテンツ呼び出しは、デフォルトではキャッシュを行わず、発行済みのコードごとに2つの API リクエストを行います。この動作はAPIの制限に負担をかける可能性があります。このキャッシュメカニズムでは、バウチャー発行ごとに1回の API 呼び出しに制限できます。

POST呼び出しにキャッシュを追加するには:

  1. :cache_max_age属性を追加します。デフォルトでは、キャッシュ期間は5分です。秒単位で期間をカスタマイズできます。5分から4時間の間で設定できます。例: :cache_max_age 3600 の場合キャッシュ期間は1時間です。
  2. 宛先エンドポイントクエリパラメーターにキャッシュキー cache_id={{cache_id}} を指定します。これにより、Braze が一意のコード発行を識別できるようになります。最初に変数を定義してから、エンドポイントに一意のクエリ文字列を付加します。これにより、各コード発行が source_id によって区別されます。

_結果に注意してください。_BrazeはURLに基づいてAPIコールをキャッシュします。クエリパラメーターとして使用される一意の文字列は Voucherify では無視されますが、この文字列により Braze の異なる API リクエストが区別され、一意の試行を個別にキャッシュすることができるようになります。そのクエリパラメータがないと、すべての顧客はキャッシュ期間中に同じクーポンコードを受け取ります。

retry 属性

コネクテッドコンテンツは Voucherify 応答を検証しないため、コネクテッドコンテンツスクリプトに retry 属性を追加することを推奨します。コネクテッドコンテンツのロジックは、メッセージを中断する前に5回再試行します (これはレート制限に準拠します)。この方法は、Voucherifyからデータを取得するのに少し時間がかかる場合に、コードの公開が失敗するケースを防ぐのに役立ちます。

:retryを使用しない場合、Voucherifyから返される応答に関係なく、Brazeは配信を送信しようとします。これにより、公開されたコードなしでメールが生成される可能性があります。

顧客ごとの一意のコード発行

スクリプト本文のsource_idパラメータは、各顧客が単一のBrazeキャンペーンで一意のコードを1つだけ受け取ることができるようにします。その結果、たとえBrazeが意図せずリクエストを複数回行ったとしても、各ユーザーは最初のメッセージで彼/彼女に公開されたのと同じ一意のコードを受け取ります。

次の構成を使用して、{{source_id}}およびその出版物への影響を変更できます:

1回のみの参加

Voucherifyキャンペーンに制限がある場合_顧客は一度しか参加できません_、スクリプト本文から公開ソースIDを削除してください。Voucherifyは、同じ顧客に送信される各Brazeメッセージが最初に公開されたのと同じコードを配信することを確認します。

あなたのコネクテッドコンテンツスクリプトは次のようになります:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign cache_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}

{% connected_content
   https://api.voucherify.io/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
    "X-App-Id": "VOUCHERIFY-APP-ID",
    "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

ユースケース

以下のすべてのユースケースでは、Voucherify の発行ソース ID と Braze のキャッシュおよび再試行パラメーターを使用して、Braze キャンペーンによって呼び出される API 呼び出しを制限していることに留意してください。次に示す影響に注意する必要があります。

  • 同じ顧客に異なるコードを単一のBrazeキャンペーンで公開および送信することはできません。
  • Voucherifyキャンペーンで_一度だけ参加機能_を使用する場合は、上記の一度だけ参加タブに記載されているように、コネクテッドコンテンツ本文からsource_idを削除する必要があります。

Voucherify の GitHub リポジトリにアクセスして、コネクテッドコンテンツスクリプトの例を参照してください。

公開してユニークなクーポンコードを送信する

このユースケースでは、コネクテッドコンテンツスクリプトがVoucherify APIを呼び出して一意のクーポンコードを発行し、それをBrazeメッセージで送信します。各Brazeユーザーは一意のコードを1つだけ受け取ります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

新しい紹介者を招待する

顧客に紹介プログラムに参加してもらうには、その人に紹介コードを割り当てる必要があります。コネクテッドコンテンツは前の例と同じです。このコネクテッドコンテンツスクリプトを使用すると、選択したBrazeユーザーにユニークな紹介コードを公開して送信できます。各ユーザーは、他のユーザーと共有して新しい紹介者を獲得するための紹介コードを1つだけ受け取ります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

ロイヤルティカード残高を取得する

ここに、カスタム属性として事前にBrazeに送信されたロイヤルティカードコードに基づいて現在のロイヤルティ残高を取得するコネクテッドコンテンツスクリプトのユースケースがあります。このスクリプトを使用する前に、ロイヤルティカードコードをBrazeユーザープロファイルにカスタム属性として保存する必要があることに注意してください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/loyalties/members/{{custom_attribute.${loyalty.card}}}?cache_id={{cache_id}}
   :method get
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age
   :retry
   :save member
 %}

カスタムコードを作成する

コネクテッドコンテンツは、クリエイティブなシナリオの導入を可能にする強力なツールです。顧客のプロファイル情報に基づいてカスタムクーポンコードを作成できます。

ここに、顧客の電話番号を考慮して一意のコードを生成するコードスニペットがあります。このユースケースでは、コネクテッドコンテンツスクリプトがVoucherify APIを呼び出してカスタムクーポンコードを発行します。

  1. まず、必要なすべての変数を定義します。次に、クーポン{コード}を「SummerTime-」というプレフィックスで始め、残りの{コード}は{顧客}の電話番号にします。クーポンコードの基準とするカスタム属性を決定できます。

    1
2
3
4
5
6
7

    {% assign braze_campaign_id = {{campaign.${dispatch_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign phoneNumber = {{${phone_number}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign cache_id = source_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign prefix = "SummerTime-" %}

  2. 次に、Voucherifyに依頼してキャンペーンで単一のコードを生成します。URLで作成するクーポンコードの名前を提供します:

    1
2
3
4
5
6
7
8
9
10
11
12

    {% connected_content
   YOUR-API-ENDPOINT/v1/campaigns/{{voucherify_campaign_id}}/vouchers/{{prefix}}{{phoneNumber}}?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age 
   :save voucher_created
   :retry
%}

  3. 最後に、作成したコードを公開します。コードスニペットは、キャンペーンからランダムなバウチャーを生成するために使用したものとほとんど同じように見えます。しかし、今回は特定のバウチャーコードを対象としています。

    1
2
3
4
5
6
7
8
9
10
11
12
13

    {% connected_content
   YOUR-API-ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
       "X-App-Id": "VOUCHERIFY-APP-ID",
       "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body voucher={{prefix}}{{phoneNumber}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age 
   :save publication
   :retry
%}

その結果、顧客に次のメールが送信されます。

こちらがこの例で使用されている完全なスニペットです:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

{% assign braze_campaign_id = {{campaign.${dispatch_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign phoneNumber = {{${phone_number}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign cache_id = source_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign prefix = "Your Prefix" %}

{% connected_content
   YOUR-API-ENDPOINT/v1/campaigns/{{voucherify_campaign_id}}/vouchers/{{prefix}}{{phoneNumber}}?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age 
   :save voucher_created
   :retry
%} 

{% connected_content
   YOUR-API-ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
       "X-App-Id": "VOUCHERIFY-APP-ID",
       "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body voucher={{prefix}}{{phoneNumber}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age 
   :save publication
   :retry
%}

Brazeメッセージに取得したデータを表示する

私たちは、すでにコネクテッドコンテンツスクリプトを使用したいBrazeキャンペーンまたはキャンバスを持っていると仮定しています。

ステップ1:メッセージテンプレートにコネクテッドコンテンツスクリプトを追加

  1. メッセージHTMLテンプレートの<body>タグの下にコネクテッドコンテンツスクリプトをコピーして貼り付けます。VoucherifyキャンペーンダッシュボードのURLアドレスからコピーしたCAMPAIGN_IDをVoucherifycampaign_idに置き換えます。

    1

    assign voucherify_campaign_id = "camp_Y7h1meBSyybsNs7UpSVVZZce"

  2. Voucherify APIエンドポイントを提供してください。APIエンドポイントがわからない場合は、プロジェクト設定 > 一般 > APIエンドポイントで確認できます。

    1

     YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}

  3. 認証のためにAPIキーを追加してください。Voucherify-App-IdとVoucherify-App-Tokenはプロジェクト設定 > 一般 > アプリケーションキー.で見つけることができます。

    1
2

    "X-App-Id": "VOUCHERIFY-APP-ID",
"X-App-Token": "VOUCHERIFY-APP-TOKEN"

これで、コネクテッドコンテンツスクリプトの準備が整いました。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "camp_Y7h1meBSyybsNs7UpSVVZZce" %}
{% assign cache_id = source_id %}

{% connected_content
   https://api.voucherify.io/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "490a3fb6-a",
        "X-App-Token": "328099d5-a"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

ステップ2:取得したデータを表示するスニペットを作成する

Voucherify API からの応答は、:save パラメーターの値の下にコネクテッドコンテンツによって保存されます。以下に例を示します。

1

:save member

これにより、Voucherify 応答からデータを取得して Braze メッセージに表示できます。

スニペットを作成して、公開されたコード、ロイヤルティカードの残高、有効期限、およびVoucherify APIからのJSON形式のレスポンスに含まれるその他のパラメーターを表示できます。

例えば、メッセージテンプレートに公開されたコードを表示するには、バウチャーオブジェクトからユニークなコードを取得するスニペットを作成する必要があります。

コネクテッドコンテンツスクリプト:

コネクテッドコンテンツ呼び出しの最後に Voucherify 応答を保存することを示しているコネクテッドコンテンツスクリプト

Brazeメッセージテンプレートのスニペット:

1

{{publication.voucher.code}}

その結果、それぞれの顧客は各自のプロファイルに自動的に割り当てられた一意のコードを含むメッセージを受け取ります。ユーザーがコードを受け取るたびに、そのコードは Voucherify のプロファイルに発行されます。

ロイヤルティカードの残高を Voucherify API から取得して表示するには、次のスニペットを作成する必要があります。

1

{{member.loyalty_card.balance}}

ここで member は、コネクテッドコンテンツスクリプトの :saveパラメーターの値です。

1

:save member

「プレビューモード」に完全に依存せず、いくつかのテストメッセージを送信して、すべてが正常に動作していることを確認することを強くお勧めします。

ステップ3:レート制限を設定する

キャンペーンターゲットを設定する際は、高度な設定を使用して、1分あたりに送信されるメッセージの数を制限します。

レート制限とフリークエンシーキャップについて詳しくは、Braze のドキュメントでご確認ください。

Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!