サポートされているパーソナライゼーションタグ

このリファレンス記事では、サポートされている Liquid パーソナライゼーションタグの完全なリストを紹介します。

サポートされているタグの概要

便宜上、サポートされているパーソナライゼーションタグの概要を以下に示します。各タグの種類とベストプラクティスの詳細については、引き続きお読みください。

サポートされている属性

Campaign、カード、Canvasの属性は、対応するメッセージングテンプレートでのみサポートされています（例えば、dispatch_id はアプリ内メッセージCampaignでは使用できません）。

詳細については、ソース別のCampaignおよびCanvas属性を参照してください。

CanvasとCampaignのタグの違い

以下のタグの動作は、CanvasとCampaignで異なります。

• dispatch_id の動作が異なるのは、Brazeがキャンバスステップを（「スケジュール済み」であっても）トリガーイベントとして扱うためです（スケジュール可能なエントリステップを除く）。詳細については、ディスパッチ ID の動作を参照してください。
• Canvasで {{campaign.${name}}} タグを使用すると、Canvasコンポーネント名が表示されます。Campaignでこのタグを使用すると、Campaign名が表示されます。

最近使用したデバイスの情報

すべてのプラットフォームにわたって、ユーザーの最新デバイスの以下の属性をテンプレート化できます。ユーザーがアプリケーションを使用したことがない場合（例えば、REST API経由でユーザーをインポートした場合）、これらの値はすべて null になります。

デバイスキャリア、モデル名、オペレーティングシステムは非常に多岐にわたるため、これらの値に条件付きで依存する Liquid は十分にテストすることを推奨します。特定のデバイスで利用できない場合、これらの値は null になります。

ターゲットアプリの情報

アプリ内メッセージでは、Liquid 内で以下のアプリ属性を使用できます。値は、アプリがメッセージングをリクエストする際に使用するSDK APIキーに基づいています。

例えば、以下の Liquid コードは、リクエストしているアプリがリスト内の 2 つのAPIキーのいずれでもない場合にメッセージを中止します。

1
2
3
4
5
6
{% assign allowed_api_keys = 'sdk_api_key_1,sdk_api_key_2' | split: ',' %}
{% if allowed_api_keys contains {{app.${api_id}}} %}
User is in list of apps
{% else %}
{% abort_message("User not in list of apps") %}
{% endif %}

ターゲットデバイスの情報

プッシュ通知、アプリ内メッセージ、バナーでは、メッセージを受信するデバイスの以下の属性をテンプレート化できます。プッシュ通知、アプリ内メッセージ、またはバナーには、ユーザーがメッセージを読むデバイスの属性を含めることができます。これらの属性はContent Cardsやメールでは機能しません。メールの場合、メッセージは送信前にレンダリングされるため、ユーザーがメールを開くデバイスはその時点では不明です。

デバイスキャリア、モデル名、オペレーティングシステムは非常に多岐にわたるため、これらの値に条件付きで依存するロジックは十分にテストすることを推奨します。特定のデバイスで利用できない場合、これらの値は null になります。

さらに、プッシュ通知の場合、プッシュトークンがAPI経由でインポートされた場合など、特定の状況下ではBrazeがプッシュ通知に関連付けられたデバイスを識別できないことがあり、その結果、それらのメッセージの値が null になります。

デフォルト値の代わりに条件付きロジックを使用する

状況によっては、デフォルト値を設定する代わりに条件付きロジックを使用することもできます。条件付きロジックを使用すると、カスタム属性の値に基づいて異なるメッセージを送信できます。さらに、条件付きロジックを使用して、null または空白の属性値を持つ顧客へのメッセージを中止することもできます。

ユースケース

例えば、顧客に報酬残高通知を送信するとします。デフォルト値を使用して、残高が少ない顧客や null の顧客に適切に対応する良い方法はありません。

この場合、デフォルト値を設定するよりも適切な 2 つのオプションがあります。

1. 残高が少ない、null、または空白の顧客に対してメッセージを中止します。

   1
   2
   3
   4
   5
   {% if {{custom_attribute.${balance}}} > 0 %}
   Your rewards balance is {{custom_attribute.${balance}}}
   {% else %}
   {% abort_message() %}
   {% endif %}
   

2. これらの顧客にまったく異なるメッセージを送信します。例えば：

   1
   2
   3
   4
   5
   {% if ${first_name} != blank and ${first_name} != null %}
   Hello {{${first_name} | default: 'there'}}, thanks for downloading!
   {% else %}
   Thanks for downloading!
   {% endif %}
   

このユースケースでは、名が空白または null のユーザーには「Thanks for downloading!」というメッセージが届きます。ミスが発生した場合に顧客に Liquid が表示されないよう、名にデフォルト値を含めることを推奨します。

変数タグ

assign タグを使用して、メッセージ作成画面で変数を作成できます。変数にはユニークな名前を使用することを推奨します。サポートされているパーソナライゼーションタグ（language など）と類似した名前の変数を作成すると、メッセージングロジックに影響を与える可能性があります。

変数を作成した後、メッセージングロジックやメッセージ内でその変数を参照できます。このタグは、コネクテッドコンテンツ機能から返されるコンテンツを再フォーマットしたい場合に便利です。詳細については、Shopifyのドキュメントの変数タグを参照してください。

ヒント

毎回のメッセージで同じ変数を割り当てていませんか？assign タグを何度も書く代わりに、そのタグをコンテンツブロックとして保存し、メッセージの先頭に配置できます。

1. コンテンツブロックを作成します。
2. コンテンツブロックに名前を付けます（スペースや特殊文字は使用しないでください）。
3. ページ下部の編集を選択します。
4. assign タグを入力します。

コンテンツブロックがメッセージの先頭にある限り、変数がオブジェクトとしてメッセージに挿入されるたびに、選択したカスタム属性を参照します。

ユースケース

顧客が報酬ポイントを 100 ポイント貯めた後にポイントを賞品に交換できるとします。そのため、追加購入を行った場合にポイント残高が 100 以上になる顧客にのみメッセージを送信したいとします。

1
2
3
4
5
6
{% assign new_points_balance = {{custom_attribute.${current_rewards_balance} | plus: 50}} %}
{% if new_points_balance >= 100 %}
Make a purchase to bring your rewards points to {{new_points_balance}} and cash in today!
{% else %}
{% abort_message('not enough points') %}
{% endif %}

反復タグ

反復タグを使用して、コードブロックを繰り返し実行できます。以下のユースケースでは for タグを使用しています。

ユースケース

Nike のスニーカーのセールを開催しており、Nike に興味を示した顧客にメッセージを送信したいとします。各顧客のプロファイルには、閲覧した製品ブランドの配列があります。この配列には最大 25 の製品ブランドが含まれる可能性がありますが、直近 5 回の製品閲覧のうち Nike の製品を閲覧した顧客にのみメッセージを送信したいとします。

1
2
3
4
5
6
7
8
9
10
{% for items in {{custom_attribute.${Brands Viewed}}} limit:5 %}
{% if {{items}} contains 'Converse' %}
{% assign converse_viewer = true %}
{% endif %}
{% endfor %}
{% if converse_viewer == true %}
Sale on Converse!
{% else %}
{% abort_message() %}
{% endif %}

このユースケースでは、閲覧したスニーカーブランドの配列の最初の 5 つのアイテムを確認します。そのうちの 1 つが Converse であれば、converse_viewer 変数を作成して true に設定します。

次に、converse_viewer が true の場合にセールメッセージを送信します。それ以外の場合はメッセージを中止します。

これは、Brazeのメッセージ作成画面で反復タグを使用する方法の簡単な例です。詳細については、Shopifyのドキュメントの反復タグを参照してください。

構文タグ

構文タグを使用して、Liquid のレンダリング方法を制御できます。echo タグを使用して式を返すことができます。これは式を波括弧で囲むのと同じですが、Liquid タグ内でこのタグを使用できます。また、liquid タグを使用して、各タグにデリミタを付けずに Liquid のブロックを記述できます。liquid タグを使用する場合、各タグは独自の行に記述する必要があります。詳細と例については、Shopifyのドキュメントの構文タグを参照してください。

空白制御を使用すると、タグの周囲の空白を削除でき、Liquid の出力の見た目をさらに制御できます。

HTTP ステータスコード

コネクテッドコンテンツ呼び出しの HTTP ステータスを利用するには、まずローカル変数として保存し、次に __http_status_code__ キーを使用します。例えば：

1
2
3
4
{% connected_content https://example.com/api/endpoint :save connected %}
{% if connected.__http_status_code__ != 200 %}
{% abort_message('Connected Content returned a non-200 status code') %}
{% endif %}

注

このキーは、エンドポイントが JSON オブジェクトを返す場合にのみ、コネクテッドコンテンツオブジェクトに自動的に追加されます。エンドポイントが配列やその他の型を返す場合、そのキーはレスポンスに自動的に設定できません。

言語、最新ロケール、タイムゾーンに基づいたメッセージ送信

状況によっては、特定のロケールに固有のメッセージを送信したい場合があります。例えば、ブラジルポルトガル語は通常、ヨーロッパポルトガル語とは異なります。

ユースケース：最新ロケールに基づくローカライズ

最新ロケールを使用して、国際化されたメッセージをさらにローカライズする方法のユースケースを紹介します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% if ${language} == 'en' %}
Message in English
{% elsif  ${language} == 'fr' %}
Message in French
{% elsif  ${language} == 'ja' %}
Message in Japanese
{% elsif  ${language} == 'ko' %}
Message in Korean
{% elsif  ${language} == 'ru' %}
Message in Russian
{% elsif ${most_recent_locale} == 'pt_BR' %}
Message in Brazilian Portuguese
{% elsif ${most_recent_locale} == 'pt_PT' %}
Message in European Portuguese
{% elsif  ${language} == 'pt' %}
Message in default Portuguese
{% else %}
Message in default language
{% endif %}

このユースケースでは、最新ロケールが pt_BR の顧客にはブラジルポルトガル語のメッセージが届き、最新ロケールが pt_PT の顧客にはヨーロッパポルトガル語のメッセージが届きます。最初の 2 つの条件に該当しないが、言語がポルトガル語に設定されている顧客には、デフォルトのポルトガル語タイプとして設定したメッセージが届きます。

ユースケース：タイムゾーンによるユーザーのターゲティング

タイムゾーンによってユーザーをターゲティングすることもできます。例えば、EST にいるユーザーには 1 つのメッセージを送信し、PST にいるユーザーには別のメッセージを送信します。これを行うには、現在の時刻を UTC で保存し、if/else 文をユーザーの現在の時刻と比較して、適切なタイムゾーンに適切なメッセージを送信します。ユーザーのローカルタイムゾーンで送信するようCampaignを設定し、適切な時間にCampaignが届くようにする必要があります。

以下のユースケースでは、午後 2 時から午後 3 時の間に配信されるメッセージを、各タイムゾーン向けの特定のメッセージで記述する方法を示します。

1
2
3
4
5
6
7
8
{% assign hour_in_utc = 'now' | date: '%H' | plus:0 %}
{% if hour_in_utc >= 19 && hour_in_utc < 20 %}
It is between 2:00:00 pm and 2:59:59 pm ET!
{% elsif hour_in_utc >= 22 && hour_in_utc < 23 %}
It is between 2:00:00 pm and 2:59:59 pm PT!
{% else %}
{% abort_message %}
{% endif %}

ランダムな数値を使用したメッセージ送信

{% random %} タグはランダムな数値を返します。A/B テストスタイルのロジック、サンプリング、またはメッセージコンテンツのバリエーションに使用できます。

ユースケース：ユーザーにランダムなバリアントを送信する

1
2
3
4
5
6
7
{% capture roll_str %}{% random %}{% endcapture %}
{% assign roll = roll_str | plus: 0 %}
{% if roll < 0.5 %}
Show variant A
{% else %}
Show variant B
{% endif %}

eコマースショッピングカートタグ

shopping_cart タグは、eコマースのカート放棄およびチェックアウト放棄のCanvasユースケースで、ユーザーのカート内容にアクセスします。CART_ID を実際のカート ID 値（{{context.${cart_id}}} など）に置き換えてください。

1
{% shopping_cart CART_ID :abort_if_not_abandoned false %}

この例の abort_if_not_abandoned パラメーターは、ecommerce.checkout_started イベントと併用するチェックアウト放棄のユースケースにのみ適用されます。カート放棄のユースケースには適用されません。詳細については、abort_if_not_abandoned を参照してください。