Shopify Flowの便利なアクション機能のひとつ、「ログ出力」をご存知でしょうか。「ログ出力」アクションは、Shopify Flowのワークフロー内で使用したLiquidの情報を確認したいときや、ワークフローのエラー修正時などに便利です。
◆参考:Shopify Flow – New Log output action | Shopify公式Changelog
本記事では、ログ出力アクションの機能概要や具体的なユースケース、利用する際の注意点を解説していきます。
Shopify Flowのログ出力アクション(Log output)とは?
「ログ出力(Log output)」は、ワークフローの自動化アプリ「Shopify Flow」のアクション機能の一つです。主な使いどころとしては、Liquidの変数で書いた内容を出力して確認することで、エラーの修正や情報の確認に役立ちます。
Log outputのフィールドに書いた変数は、整数や文字に置き換えられた形で表示されます。出力された内容が期待した内容と合致しているか確認をして、異なるようなら変数の修正を行います。
【ログ出力前】
Liquidを使用して変数で書かれている部分を検証している例です。
{{ now }}は本日の日時を取得するLiquidで、date: フィルターを利用して、”YYYY年M月”の形式で出力するように指定しています。
▼
【ログ出力後】
変数が整数や文字に変更されました!期待していた値と一致するかを確認します。
具体的なユースケース
実際のワークフロー内で「Log output」を使用する例として、弊社アプリ「CRM PLUS on LINE」からShopify Flowに提供しているワークフロー「購入完了通知をLINEで配信する」内でLog outputアクションを使ってみます。
下記のようにログ出力(Log output)アクションを活用することができます。
Log outputの部分の中身を見てみましょう。多数の変数が使用されていてわかりにくい部分がありますが、実際にワークフローを実行してみてログの結果をみると、変数だった部分が文字や整数に変換されて理解しやすくなります。
上記で使用されている変数(請求先住所の苗字・注文作成日・合計金額など)は、購入完了通知のLINE配信文(Flexメッセージ)内で使用されている変数と一致します。変数を含んだメッセージ配信を行う際にも、実際にどんな文面が配信されるかを確認できます。
▼上記の購入完了通知がログ出力された場合
ログ出力はアクション機能なので、Shopify Flowの実行履歴は残りますが、あくまでも運用者側の情報確認として活用できる機能です。ストアの顧客様に何かしらの通知がいったりすることはありません。
▼アクションが実行された記録として「Log output」と表示されます
Log outputを利用する際の注意点
Log outputを使用する際の注意点として、ログ出力(Log output)内でHTMLマークアップ(pタグなどのHTMLタグ)を用いて入力した際には、HTMLがそのまま出力されてしまいます。
▼例:ログ出力前
HTMLのpタグを使用して書いた場合です。
▼例:ログ出力後
そのままpタグも一緒に出力されてしまいます。
今後の動向にも注目
今回ご紹介させていただきました「ログ出力(Log output)」に関連して、Shopify Flowのアクティビティログの各アクションで使用されている変数が実行履歴で表示されるようになる可能性があります。
参考:Shopify FlowのプロダクトマネージャーPaul氏のポスト
「今後はLog Outputの必要性は減るだろう」という趣旨の投稿がされておりますので、本記事をご参照の際には、公式のアップデート情報がまとまった「Shopify Changelog」ページもぜひ併せてご確認ください。
▼Shopify Changelog
https://changelog.shopify.com
おわりに
今回ご紹介した「ログ出力」は、ワークフロー運用者にとっては嬉しい機能の1つです。下記の関連記事でご紹介した「再試行ボタン」と併せて活用すると、エラー解明や検証の手助けとなります。ぜひ使ってみてください。
本記事についてのご不明点はもちろん、「ここを解説してほしい!」などご要望がありましたら、お気軽にご連絡ください!