Liquid 言語

このガイドでは、Zendesk で Liquid テンプレート言語を使用するためのリファレンスを提供します。Liquid により、トリガー、自動化、テーマで動的コンテンツを利用できます。このページでは、一般的な変数、関数、実用例を扱います。

Liquid 言語とは

Liquid は、Shopify が作成したオープンソースのテンプレート言語で、Ruby で記述されています。テーマやページなどでより動的なコンテンツを利用できるようにするために使用します。

Zendesk で Liquid を使用する方法

Zendesk では、Liquid を主にトリガー、自動化、拡張機能で利用しています。これにより、より動的なメッセージ（コメント、URL など）を実現できます。Liquid 言語を完全に使いこなすには時間がかかる場合があります。特に多くの機能があり、頻繁に更新されるためです。

変数の展開

テキストまたは出力に値を挿入するには、変数、関数、または値の名前を二重波かっこで囲みます。

例として、チケットのリクエスター名を出力する場合は、次の形式になります。

• 入力: Greetings {{ticket.requester.name}}
• 出力: Greetings John Doe

同じ方法で関数も使用できます。たとえば、メッセージに自分のロールを入れつつ、大文字化したい場合は、次の形式になります。

• 入力: My role is {{current_user.role | capitalize }}
• 出力: My role is Fullstack Engineer

コードブロック

コードブロック（一般的なループ、代入、条件分岐など）を使用するには、行を {% で開始し、%} で終了します。

たとえば、チケットのコメントに対するループを開始する場合は、{% for comment in ticket.comments %} のようにします。

一般的な変数

さらに多くの変数を使用できますが、GitLab で使用するものの中では、これらが圧倒的に一般的です。

チケットフィールド ID の確認

これには管理者レベルのアクセスが必要になる場合が多いため、支援が必要な場合は Customer Support Systems チームに連絡することをおすすめします。

一般的な関数

一般的なタグ

条件分岐

ループ

例

ドキュメント Issue 作成トリガー

これをトリガーで使用し、最新コメントの作成者、タイトル、説明を特定してドキュメント Issue を作成します。

{% for comment in ticket.comments limit:1 offset:0 %}
  {% assign author = comment.author.custom_fields.gitlab_user_id %}
  {% assign lines = comment | url_encode | split: "%0A" %}
  {% for line in lines %}
    {% assign first_five = line | slice: 0,5 %}
    {% if first_five == 'Title' %}
      {% assign title = line | url_decode | split: ': ' | last %}
    {% endif %}
  {% endfor %}
  {% assign description = comment | split: 'Description:' | last | join: '\n' %}
{% endfor %}

行ごとの内訳:

1. チケットコメントに対する for ループを開始し、上限を 1 イテレーションに設定します（つまり最新の 1 件だけを取得します）
2. 変数 author に値を代入します
   • 値はコメント作成者の GitLab ユーザー ID（カスタム ユーザーフィールド）にします
3. 変数 lines に値を代入します
   • これにより comment を関数 url_encode に渡し、文字列を URL セーフ形式にエンコードします
   • これにより URL エンコードされた文字列を split 関数に渡し、区切り文字 %0A で分割した配列に変換します
4. lines 変数に格納された配列に対する for ループを開始します
5. 変数 first_five に値を代入します
   • これにより line を slice 関数に渡し、最初の 5 文字を返します
6. first_five の値が Title であることを条件とする if ブロックを宣言します
7. 変数 title に値を代入します
   • これにより line を関数 url_decode に渡し、url_encode が先に行ったことを元に戻します
   • これを split 関数に渡し、区切り文字 : で分割した配列に変換します
   • これを last 関数に渡し、配列の最後の項目を返します
8. if ブロックを終了します
9. 2 つ目の for ループを終了します
10. 変数 description に値を代入します
    • これにより comment を split 関数に渡し、区切り文字 ‘Description:’ で分割した配列に変換します
    • これを last 関数に渡し、配列の最後の項目を返します
    • これを join 関数に渡し、区切り文字 \n を使用して項目を結合します
11. 最初の for ループを終了します

時間外メッセージを表示するか判断する

これを使用して、チケットが現在営業時間内かどうかに基づき、テキストブロックを表示するかどうかを判断します。

{% if ticket.in_business_hours == 'false' %}
  <li>You indicated in this ticket, #{{ticket.id}}, a "Preferred Region for Support." The current time is outside of that region's standard business hours. You can rest assured that this ticket will be addressed by the next available engineer in the selected region. It is important that you understand when you may expect a reply regarding this case. Please see the linked handbook section for more information regarding the <a href='https://about.gitlab.com/support/#effect-on-support-hours-if-a-preferred-region-for-support-is-chosen' target='_blank'>effect of using Preferred Region</a>.<br />During the course of this ticket if you require assistance outside of the selected region's standard business hours please feel free to reply asking one of our support engineers to set this ticket's preferred region to "All regions".</li>
{% endif %}

行ごとの内訳:

1. チケットが営業時間内ではないことを条件とする if ブロックを宣言します
2. テキストブロックを表示します
   • これにより、Liquid 変数 {{ticket.id}} を使用してチケットの ID を挿入します
3. if ブロックを終了します

SSAT Issue 作成トリガー

これを、顧客が残した SSAT 評価に基づいて Issue を作成するトリガーの一部として使用します。これは、チケットで使用しているフォームを特定し、チケットフォームに対応する GitLab Issue タグを含む、使用する変数を設定するために使用されます。

{% assign form = ticket.ticket_form %}

{% if form == 'GitLab.com User Accounts and Login Issues' %}
  {% assign form = 'form::GitLab.com' %}
{% elsif form == 'Support for GitLab.com' %}
  {% assign form = 'form::GitLab.com' %}
{% elsif form == 'Support for a self-managed GitLab instance' %}
  {% assign form = 'form::Self-managed' %}
{% elsif form == 'Licensing and Renewals Problems' %}
  {% assign form = 'form::Upgrades & Renewals' %}
{% elsif form == 'Contact the Security team' %}
  {% assign form = 'form::Security' %}
{% elsif form == 'Other Request' %}
  {% assign form = 'form::Other' %}
{% else %}
  {% assign form = 'form::GitLab Community Edition' %}
{% endif %}

行ごとの内訳:

1. 変数 form に値を代入します
   • 値はチケットのフォームにします
2. 間隔を空けるための空行です（必須ではなく、見た目をよくするためだけのものです）
3. form の値が GitLab.com User Accounts and Login Issues であることを条件とする if ブロックを宣言します
4. 変数 form に値を代入します
5. form の値が Support for GitLab.com であることを条件とする elsif ブロックを宣言します
6. 変数 form に値を代入します
7. form の値が Support for a self-managed GitLab instance であることを条件とする elsif ブロックを宣言します
8. 変数 form に値を代入します
9. form の値が Licensing and Renewals Problems であることを条件とする elsif ブロックを宣言します
10. 変数 form に値を代入します
11. form の値が Contact the Security team であることを条件とする elsif ブロックを宣言します
12. 変数 form に値を代入します
13. form の値が Other Request であることを条件とする elsif ブロックを宣言します
14. 変数 form に値を代入します
15. else ブロックを宣言します
16. 変数 form に値を代入します
17. if ブロックを終了します

便利なリンク

• Liquid GitHub リポジトリ
• Liquid ドキュメント
• Zendesk プレースホルダーリファレンス

一般的な問題とトラブルシューティング

これは必要に応じて項目が追加される継続的なセクションです。

ページのソースコードを見る - ページの編集 - please contribute.