フィルター

この参考記事では、Liquidにおけるフィルターの概要と、Brazeでサポートされているフィルターを取り上げている。これらのフィルターの使い方のアイデアをお探しですか？リキッドのユースケースライブラリーをチェックしよう。

フィルターは、Liquid の数値、文字列、変数、オブジェクトの出力を変更する方法だ。フィルターを使用して、文字列の小文字から大文字への変更など、静的テキストまたは動的テキストを再フォーマットしたり、加算や除算などの数学演算を実行したりできます。

フィルターは出力タグ{{ }} 内に置かなければならず、パイプ文字| で示される。

• インプット
• 出力

1
{{"Big Sale" | upcase}}

1
BIG SALE

この例では、Big Sale が文字列で、upcase が適用されるフィルターである。

1つの出力に複数のフィルターを使うことができる。左から右に適用される。

• インプット
• 出力

1
 {{ "Big Sale" | upcase | remove: "BIG" }}

1
SALE

アレイ・フィルター

アレイ・フィルターは、アレイの出力を変更するために使われる。

カラーフィルター

カラーフィルターはBrazeではサポートされていない。

フォントフィルター

Brazeではフォントフィルターはサポートされていない。

数学フィルター

数学フィルターでは、数学的な演算を行うことができる。覚えておいてほしいのは、1つの出力に複数のフィルターを使った場合、それらは左から右に適用されるということだ。

カスタム属性を使った数学演算

2つのカスタム属性の間で数学的演算を実行することはできないことを覚えておいてほしい。

1
{{custom_attribute.${current_rewards_balance} | plus: {{custom_attribute.${giftcard_balance}}}}}

リキッドの1行で複数のカスタム属性を参照することはできないので、この例はうまくいかないだろう。その代わりに、数学関数が実行される前に、これらの値の少なくとも1つに変数を代入する必要がある。つのカスタム属性を一緒に追加するには、2行のリキッドが必要になる：

1. カスタム属性を変数に割り当てる、
2. ひとつは追加を行う。

例えば、ギフトカードの残高とリワードの残高を足して、ユーザーの現在の残高を計算したいとしよう。まず、assign タグを使って、current_rewards_balance のカスタム属性を “balance “という言葉に置き換える。つまり、balance という変数ができたことになる。

1
{% assign balance = {{custom_attribute.${current_rewards_balance}}} %}

次に、plus フィルタを使って、各ユーザーのギフトカード残高と、{{balance}} オブジェクトで示されるリワード残高を結合する。

• インプット
• 出力

1
2
{% assign balance = {{custom_attribute.${current_rewards_balance}}} %}
You have ${{custom_attribute.${giftcard_balance} | plus: {{balance}}}} to spend!

1
You have $35 to spend!

マネーフィルター

ユーザーの購入品や口座残高など、お金に関することを更新する場合は、マネーフィルターを使うべきだ。マネーフィルターは、小数が適切な位置にあり、更新の一部が失われないようにする（最後にある厄介な0 ）。

1
2
{% assign my_int = "350000.25" | plus: 0 %}
{{ my_int | money }}

ShopifyマネーフィルターとBrazeマネーフィルターの比較

カスタム属性（account_balance など）を入力する場合は、常にmoney フィルタを使用して、小数点が適切な位置にあり、数字の末尾からゼロが抜けていないことを確認する必要がある：

1
${{custom_attribute.${account_balance} | money}}

マネーフィルター付き	マネーフィルターなし
ここで、account_balance は17.8 で入力される。	ここで、account_balance は17.8 で入力される。

Brazeのmoney フィルタは、Shopifyとは異なり、プリセット設定に従って自動的に小数点を適用するわけではない。例えば、rewards_redeemed に145 という値が含まれている場合を考えてみよう：

• インプット
• 出力

1
${{event_properties.${rewards_redeemed} | money }}

1
$145.00

Shopifyのマネーフィルターによると、これは$1.45 の出力となるはずだが、Brazeでは$145.00 の出力となる。回避策として、divided_by フィルタを使って数値を10進数に変換してから、マネーフィルタを適用することができる：

• インプット
• 出力

1
${{event_properties.${rewards_redeemed} | divided_by: 100.00 | money }}

1
$1.45

文字列フィルター

文字列フィルターは、文字列の出力や変数を操作するために使われる。文字列は英数字の組み合わせであり、ストレート引用符で囲む必要がある。

追加フィルター

以下の一般的なフィルターは、コンテンツのフォーマットや変換など、さまざまな目的を果たす。

エンコーディングやURLフィルターなど、サポートされているフィルターについては、アドバンス・フィルターのページで確認できる。

日付フィルター

date フィルタは、タイムスタンプを別の日付フォーマットに変換するのに使える。タイムスタンプを再フォーマットするために、date フィルタにパラメータを渡すことができる。これらのパラメータの例については、以下を参照のこと。 strfti.me.

例えば、date_attribute の値がタイムスタンプ2021-06-03 17:13:41 UTC だとしよう。

• インプット
• 出力

1
{{custom_attribute.${date_attribute} | date: '%b %d'}}

1
03 June

strftime フォーマットオプションに加えて、Brazeは%s 日付フィルタを使ったタイムスタンプのUnix時間への変換もサポートしている。例えば、date_attribute をUnix時間で取得する：

• インプット
• 出力

1
{{custom_attribute.${date_attribute} | date: '%s' }}

1
1433351621

タイムゾーンフィルター

Shopifyのドキュメントに記載されているフィルターに加えて、Brazeはtime_zone フィルターもサポートしている。

time_zone フィルタは、時刻、タイムゾーン、日付フォーマットを受け取り、そのタイムゾーンの時刻を指定された日付フォーマットで返す。例えば、{{custom_attribute.$date_attribute}}} の値が2021-08-04 9:00:00 UTC だとしよう：

• インプット
• 出力

1
{{custom_attribute.${date_attribute} | time_zone: 'America/Los_Angeles' | date: '%a %b %e %T' }}

1
Wed August 4 2:00:00

予約変数now を使って、現在の日付と時刻にアクセスして操作することもできる。

• インプット
• 出力

1
{{ 'now' | date: '%Y-%m-%d %H:%M:%S' }}

1
2021-08-04 18:13:13