Zendesk Supportのプレースホルダは、動的に生成されるチケット、ユーザー、およびカスタムデータのコンテナです。フォーマットは、データ参照を二重の中括弧で囲みます。プログラミングロジックを設定するときにチケット、ユーザー、およびカスタムデータにもアクセスできるため、単なるプレースホルダではなく、プレースホルダとしても使用できるデータオブジェクトとそのプロパティとして考えるとわかりやすいかもしれません。
Zendesk Supportの主要なデータオブジェクトとして「チケット」と「ユーザー」の2つがあります。それぞれに独自のプロパティ、ユーザーオブジェクトのセットがあり、たとえば、名前やメールなどのユーザープロパティが含まれます。これら2つのデータオブジェクトに加えて、関連データオブジェクトがあります。チケットの場合、コメントと満足度評価オブジェクトがあります。ユーザーの場合、組織オブジェクトとエージェントオブジェクトがあります。さらに、ユーザーによる定義で、チケット、ユーザー、その他のZendeskオブジェクトに関連付けられるカスタムオブジェクトもあります。
プレースホルダはHTML形式でもかまいませんが、URLターゲットやWebhookにプレースホルダを送信する場合、HTMLではなく、書式設定されていないテキストがプレースホルダのレンダリングに使用されます。また、プレースホルダはコードブロック内では機能しません。
Supportには、特定の状況でチケットトリガ内のプレースホルダを非表示にする内部システムルールが含まれます。内部システムルールは、変更、変更、または上書きできないルールであり、Supportのデフォルトの動作を決定します。これらのルールによって、チケットトリガのプレースホルダが機能しなかったように見えることがありますが、これは誤動作ではありません。これらのルールは、スパム送信者がアカウントを使用してスパムメッセージを配信することを防止するため、ユーザーを保護しています。詳細については、「プレースホルダの非表示ルールについて」を参照してください。
この記事では、以下のように、プレースホルダをプレースホルダに表示されるデータごとに分類しています。プレースホルダを指定する際には、大文字と小文字が区別されるので注意が必要です。
関連記事
ユーザーデータ
- ticket.requester:チケットをリクエストしたユーザー
- ticket.assignee:チケットに割り当てられたエージェント
- ticket.submitter:リクエストを送信したユーザー、またはリクエスタの代理でチケットを作成したエージェントのいずれか
- current_user:現在チケットを更新しているユーザー(エンドユーザー、エージェントまたはシステムユーザーとしてのZendesk)
これは、次の表に示したユーザーデータのほとんどをユーザーのタイプごとに返すことができることを示します(たとえば、{{ticket.submitter.name}}{{current_user.name}}など)。
プロパティ/プレースホルダ | 説明 |
---|---|
user.name
重要:userの部分は、上述のユーザータイプのいずれかに置き換える必要があります(ticket.requesterなど)。
|
ユーザーのフルネーム。 |
user.first_name | ユーザーの名。 |
user.last_name | ユーザーの姓。 |
user.email | ユーザーのメールアドレス。 |
user.language | ユーザーの言語設定。 |
user.phone | ユーザーの電話番号。 |
user.external_id | ユーザーの外部ID(存在する場合)。JWTまたはSAMLを使用するエンタープライズシングルサインオンが有効になっているアカウント向けのオプションです。 |
user.details | ユーザーの詳細。 |
user.notes | ユーザーのメモ。 |
user.time_zone | ユーザーのタイムゾーン。 |
user.role | ユーザーのロール(管理者、エージェント、エンドユーザー)。 |
user.extended_role | SupportのEnterpriseエージェントロールを使用している場合、エージェントのEnterpriseロールの名前が返されます。次のプリセットのロールがあります。
カスタムエージェントロールを作成した場合、それらのロール名が返されます。Enterpriseアカウントでない場合は、このプレースホルダを使用すると、すべてのエージェントユーザーに対して「Agent」、すべてのエンドユーザーに対して「End user」が返されます。 カスタムエージェントロールについて詳しくは、「カスタムロールの作成とエージェントの割り当て」を参照してください。 |
user.id | ユーザーのID。 |
user.locale | ユーザーのロケール(例:en-US)。 |
user.signature | エージェントの署名。署名を使用できるのはエージェントだけです。 |
user.organization... | 下の「組織データ」を参照してください。 |
user.tags | タグ。「ユーザーおよび組織へのタグの追加」を参照してください。 |
user.custom_fields.<フィールドキー> | カスタムユーザーフィールド(ドロップダウンフィールドを除く)の値のプロパティ/プレースホルダフォーマット。例:{{ticket.requester.custom_fields.my_custom_field}}「ユーザープロフィールへのカスタムフィールドの追加」を参照してください。 |
user.custom_fields.<フィールドキー>.id | ルックアップリレーションシップフィールドのターゲットレコードのID。 |
user.custom_fields.<フィールドキー>.title | カスタムユーザードロップダウンフィールドの値のプロパティ/プレースホルダフォーマット。例:{{ticket.requester.custom_fields.manager_for_approval.title}}「ユーザープロフィールへのカスタムフィールドの追加」を参照してください。 |
名前のプレースホルダについて
姓と名のプレースホルダの動作は、プロフィール上の名前のフォーマットに依存します。たとえば、オランダ語の「van der Linde」という名前を使用する場合、「user.last_name」プレースホルダには「Linde」と表示されます。プロフィールにオランダ語で「van der Linde」という名前を使用している場合、「user.last_name」プレースホルダには「van der Linde」と表示されます。
さらに、日本では、ユーザーの名のプレースホルダはユーザーの姓を参照し、ユーザーの姓のプレースホルダはユーザーの名を参照します。
組織データ
各タイプのユーザーを組織に追加できます。組織には次のデータプロパティが含まれます。
プロパティ/プレースホルダ | 説明 |
---|---|
user.organization.id
重要:userの部分は、後述のユーザータイプのいずれかに置き換える必要があります。
|
ユーザーが割り当てられる組織のID。 |
user.organization.name | ユーザーが割り当てられる組織の名前。 |
user.organization.is_shared | TrueまたはFalse。組織が共有組織であることを示します。 |
user.organization.is_shared_comments | TrueまたはFalse。組織がユーザーに他のユーザーのチケットにコメントを追加できるようにします。 |
user.organization.details | 組織に関する詳細。 |
user.organization.notes | 組織に関するメモ。 |
user.organization.tags | タグ。「ユーザーおよび組織へのタグの追加」を参照してください。 |
- {{ticket.organization.name}}:チケットリクエスタの組織
- {{ticket.requester.organization.name}}:{{ticket.organization.name}}(リクエスタ)に同じ
- {{current_user.organization.name}}:現在チケットを更新しているユーザー(エンドユーザーまたはエージェント)
- {{ticket.assignee.organization.name}}:チケットに割り当てられたエージェント
- {{ticket.submitter.organization.name}}:リクエストを送信したユーザー、またはリクエスタの代理でチケットを作成したエージェントのいずれか
エージェントデータ
以下のプレースホルダはエージェント署名にのみ使用できます。エージェント署名の詳細については、「エージェント署名のチケットメール通知への追加」を参照してください。
プロパティ/プレースホルダ | 説明 |
---|---|
agent.name | エージェントのフルネーム(エイリアスを使用する場合、エイリアス)。 |
agent.first_name | エージェントの名。 |
agent.last_name | エージェントの姓。 |
agent.role | エージェントのロール。 |
agent.signature | エージェントの署名。 |
agent.email | エージェントのメールアドレス。 |
agent.phone | エージェントの電話番号。 |
agent.organization | エージェントの組織。 |
agent.language | エージェントの言語。 |
agent.time_zone | エージェントのタイムゾーン。 |
チケットデータ
Zendesk Supportのチケットには次のデータプロパティが含まれます。
プロパティ/プレースホルダ | 説明 |
---|---|
ticket.account | Zendeskのアカウント名。 |
ticket.assignee.name | チケット担当者の姓名(該当する姓名がある場合)前述の「ユーザーデータ」を参照してください。 |
ticket.brand.name | チケットに割り当てられたブランド名。 |
ticket.cc_names | チケットのCC欄にある名前を返します。
メモ:新しいCCおよびフォロワー機能を使用していて、プレースホルダを追加または更新する場合は、
ticket.email_cc_names プレースホルダではなく、tickets.cc_names プレースホルダを使用することをお勧めします。どちらもCC欄の名前を返します。メッセージのCCに含まれるメンバーのメールアドレスを返したい場合は、次のリキッドマークアップコードを使用します。
|
ticket.email_cc_names |
新しいCCおよびフォロワー機能では、チケットのCC欄にある名前を返します。古いバージョンのCC機能では、空白を返します。
メモ:新しいCCおよびフォロワー機能を使用していて、プレースホルダを追加または更新する場合は、
ticket.email_cc_names プレースホルダではなく、tickets.cc_names プレースホルダを使用することをお勧めします。どちらもCC欄の名前を返します。 |
ticket.follower_names | 新しいCCおよびフォロワー機能では、チケットのフォロワーの名前を返します。古いバージョンのCC機能では、空白を返します。 |
ticket.follower_reply_type_message |
新しいCCおよびフォロワー機能では、パブリックとプライベートのどちらのタイプのコメントが通知のトリガになるかを示します。「このメールに返信することにより、リクエストにコメントを追加できます」または「このメールに返信することにより、リクエストに社内メモを追加できます」というメッセージをメール通知に追加します(「CCおよびフォロワーへのデフォルトのメール通知のカスタマイズ」を参照)。
古いバージョンのCC機能では、空白を返します。 |
ticket.created_at | チケットが作成された日付(例:2014年5月18日)。
メモ:今年度に作成されたチケットには、年は記載されません。
|
ticket.created_at_with_timestamp | ISO 8601形式で日付と時刻が表記されたチケットの作成時刻。以下に例を示します。2013年12月12日午前5時35分(UTC)は、「2013-12-12T05:35Z」と表記されます。 |
ticket.created_at_with_time | チケットが作成された日付と時刻。「2月10日午後2時29分」など。 |
ticket.current_holiday_name | 休日以外の日に使用される場合、プレースホルダはnullになります。休日に使用された場合、休日名がプレースホルダに表示されます。スケジュールを複数定している場合、プレースホルダは、チケットに適用されているスケジュールの休日リストに従って機能します。 |
ticket.description | チケットの説明。これには、エージェントの名前、コメントの日付、チケットの説明(最初のコメント)が含まれます。
メモ:件名フィールドが空白またはリクエスタに表示されない場合、この最初のコメントが使用され、リクエスタに送信されます。これは、プライベートチケットでも同じです。
|
ticket.due_date | チケットの期限(タスクタイプのチケットの場合)。フォーマットは「May-18」のようになります。 |
ticket.due_date_with_timestamp | ISO 8601形式で日付と時刻が表記されたチケットの期限(タスクタイプのチケットの場合)。以下に例を示します。2013年12月12日午前6時35分(UTC+1)は、「2013-12-12T05:35+0100」と表記されます。 |
ticket.external_id | 外部チケットID(存在する場合)。 |
ticket.encoded_id | encoded IDは、受信メールの返信を既存のチケットにスレッド化するために使用されます。 |
ticket.group.name | チケットに割り当てられたグループ。 |
ticket.id | チケットID。#{{ticket.id}} は、クリック可能なリンクを作成します。{{ticket.id}} は、チケット番号をプレーンテキストでレンダリングします。 |
ticket.in_business_hours | TrueまたはFalse。営業時間中にチケットが更新された場合はtrue。詳しくは「営業時間を設定する」を参照してください。 |
ticket.link | チケットへのフルURLパス。 |
ticket.organization.custom_fields.<フィールドキー>.title | カスタム組織フィールドのプロパティ/プレースホルダフォーマット。詳しくは「組織プロフィールへのカスタムフィールドの追加」を参照してください。 |
ticket.organization.custom_fields.<フィールドキー>.id | ルックアップリレーションシップフィールドのターゲットレコードのID。 |
ticket.organization.custom_fields.<フィールドキー>.title | カスタム組織ドロップダウンフィールドの値のプロパティ/プレースホルダフォーマット。詳しくは「組織プロフィールへのカスタムフィールドの追加」を参照してください。 |
ticket.organization.external_id | チケットリクエスタの組織の外部ID。 |
ticket.organization.id | チケットリクエスタの組織のID。 |
ticket.organization.name | 前述の「組織データ」を参照してください。 |
ticket.priority | チケットの優先度(低、普通、高、緊急)。 |
ticket.requester.first_name | チケットリクエスタの名。
公開のZendesk Supportインスタンスの場合、このプレースホルダは最初の返信トリガでスパムのターゲットになる可能性があります。「Zendesk Support固有の機能を利用したスパムと対策」を参照してください。 |
ticket.requester.last_name | チケットリクエスタの姓。
公開のZendesk Supportインスタンスの場合、このプレースホルダは最初の返信トリガでスパムのターゲットになる可能性があります。「Zendesk Support固有の機能を利用したスパムと対策」を参照してください。 |
ticket.requester.name | チケットリクエスタの姓名。
公開のZendesk Supportインスタンスの場合、このプレースホルダは最初の返信トリガでスパムのターゲットになる可能性があります。「Zendesk Support固有の機能を利用したスパムと対策」を参照してください。 |
ticket.requester.email | チケットリクエスタのメールアドレス。 |
ticket.requester.custom_fields.<フィールドキー> | カスタムユーザーフィールドのプロパティ/プレースホルダフォーマット。例:{{ticket.requester.custom_fields.my_custom_field}}「ユーザープロフィールへのカスタムフィールドの追加」を参照してください。 |
ticket.requester.custom_fields.<フィールドキー>.id | ルックアップリレーションシップフィールドのターゲットレコードのID。 |
ticket.requester.custom_fields.<フィールドキー>.title | カスタムユーザードロップダウンフィールドの値のプロパティ/プレースホルダフォーマット。例:{{ticket.requester.custom_fields.manager_for_approval.title}}詳しくは「組織プロフィールへのカスタムフィールドの追加」を参照してください。 |
ticket.requester.details | リクエスタのユーザープロフィールの「詳細」フィールドの内容。 |
ticket.status | 標準のチケットステータス(新規、オープン、保留中、待機中、解決済み、終了)。 |
ticket.status_category | カスタムチケットステータスがアクティブになっている場合、チケットのステータスが属するステータスカテゴリ(新規、オープン、保留中、待機中、解決済み、終了)を返します。チケットステータスのカテゴリの詳細についてはこちらをご覧ください。 |
ticket.custom_status | カスタムチケットステータスがアクティブになっている場合、カスタムチケットのステータスを返します。 |
ticket.tags | チケットに接続されたすべてのタグ。 |
ticket.ticket_field_<フィールドID番号> | カスタムフィールドのプロパティ/プレースホルダフォーマット。例:{{ticket.ticket_field_123}}詳しくは「カスタムフィールドのプレースホルダ」を参照してください。 |
ticket.ticket_field_<フィールドID番号>.id | ルックアップリレーションシップフィールドのターゲットレコードのID。 |
ticket.ticket_field_option_title_<フィールドID番号> | ドロップダウンカスタムフィールドの値のプロパティ/プレースホルダフォーマット。例:{{ticket.ticket_field_option_title_456}}詳しくは「カスタムフィールドのプレースホルダ」を参照してください。 |
ticket.ticket_form | エンドユーザー向けフォームの名前。 |
ticket.ticket_type | チケットタイプ(質問、事象、問題、タスク)。チケットタイプが指定されていない場合、このプレースホルダは"Ticket"を返します。 |
ticket.title | チケットの件名。エンドユーザーには、このフィールドに異なるテキストが表示される場合があります。このプレースホルダに関するトラブルシューティングについては、「ticket.titleプレースホルダは、件名の代わりに最初のコメントを表示します」、および「メール通知の件名に「タイトルのないチケット」と表示されるのはなぜですか?」を参照してください。
公開のZendesk Supportインスタンスの場合、このプレースホルダは最初の返信トリガでスパムのターゲットになる可能性があります。「Zendesk Support固有の機能を利用したスパムと対策」を参照してください。 |
ticket.updated_at | チケットが最後に更新された日付(例:May18)。 |
ticket.updated_at_with_time | チケットが最後に更新された日付と時刻。「2月10日午後2時29分」など。 |
ticket.updated_at_with_timestamp | ISO 8601形式で日付と時刻が表記されたチケットの最終更新時刻。以下に例を示します。2013年12月12日午前5時35分(UTC)は、「2013-12-12T05:35Z」と表記されます。 |
ticket.url | チケットへの完全なURLパス(「http://」を除く)。 |
ticket.verbatim_description | チケットの説明(最初のコメント)のプレーンテキストの値。「メールにファイルを添付」が有効になっていると、添付ファイルが含まれます。
メモ:このプレースホルダは、Webhookで添付ファイルを送信するために使用することはできません。
|
ticket.via | チケットソースのタイプ(Webフォーム、メールなど)。 |
account.incoming_phone_number_ID | Zendesk Talk着信電話番号。例:{{account.incoming_phone_number_123}} |
コメントデータ
- HTMLコメントプレースホルダ:Gmailなどのメールアプリケーションでメールのスレッドを簡略化するために使用されます。最良の結果を得るには、他のコメントプレースホルダと共に使用しないでください。「シンプルなメールスレッドについて」および「メールアプリケーションのシンプルなメールスレッドの実装」を参照してください。
-
標準コメントプレースホルダ:リキッドのハッシュを使用して表示するオブジェクトを選択し、コメントのコレクションと添付ファイルデータを返します。たとえば、
{{ticket.comments}}
のプレースホルダを使用して、コメントを繰り返すテンプレートを設定できます。 -
書式設定されたオブジェクト:大幅なカスタマイズをせずに、標準のプレースホルダを書式設定してレンダリングしたHTML表現を返すことができます。これらのオブジェクトは、プリセットされた形式でコメントを返すだけです。たとえば、
{{ticket.comments_formatted}}
は、レンダリングされたHTMLのまとまりを返します。チケットのコメントには、日付、作成者、作成者のアバターなどが含まれます。 - リッチテキストコメントプレースホルダ:プリセットの書式設定ルールに制限されずに、カスタマイズされたテンプレートのリッチテキストを(書式設定されたオブジェクトプレースホルダと同様に)使用できるため、通知のルックアンドフィールをより細やかに制御できます。「メールにファイルを添付」を有効にすると、リッチテキストオブジェクトに添付ファイルを含めることができます。
- チケットに割り当てられた、またはチケットをフォローしているエージェントは、パブリックコメントと社内メモの両方を受け取ります。エンドユーザーが受け取るのは、パブリックコメントのみです。
- CCを有効にしている場合、CC(エージェントのCCを含む)は、パブリックコメントのメール通知のみを受け取ります。詳しくは「デフォルトでメール通知がCCに送信されるしくみを理解する」を参照してください。
- サイドカンバセーションでコメントのプレースホルダを使用した場合、パブリックコメントのみが含まれます。サイドカンバセーションで使用されるコメントプレースホルダは社内メモを返しません。
プロパティ/プレースホルダ | 説明 |
---|---|
ticket.latest_comment_html | 最新のコメント(添付ファイルも含む)。エージェントは、最新のパブリックコメントまたはプライベートコメントを受け取ります。エンドユーザーは、最新のパブリックコメントを受け取ります。 |
ticket.latest_public_comment_html | 最新のパブリックコメント(添付ファイルを除く)。 |
プロパティ/プレースホルダ | 説明 |
---|---|
ticket.comments | プレースホルダとして使用されます。{{ticket.comments}}にはチケット内のすべてのコメントが、書式設定されていないテキストで表示されます。
ticket.commentsプレースホルダは、コメントと添付ファイルのコレクションとしての役割も果たします。リキッドマークアップを使用して、次のデータにアクセスできます。
ビジネスルールでこのデータにアクセスする例については、「コメントとメール通知のテキストのフォーマットと配置をカスタマイズする」を参照してください。
メモ:ticket.public_comments、ticket.latest_comment、ticket.latest_public_commentの各プレースホルダを使用する場合には、同じコメントデータのコレクションを使用できます。
|
ticket.public_comments | すべてのパブリックコメント、最新のコメントから順に表示。書式設定されていないテキスト。 |
ticket.latest_comment | 最新のコメント。書式設定されていないテキスト。「メールにファイルを添付」が有効になっていない限り、添付ファイルは含まれません。添付ファイルを返すには、ticket.latest_comment_formattedを使用します。 |
ticket.latest_public_comment | 最新のパブリックコメント。書式設定されていないテキスト。 |
プロパティ/プレースホルダ | 説明 |
---|---|
ticket.comments_formatted | すべてのコメント、最新のコメントから順に表示。 |
ticket.public_comments_formatted | すべてのパブリックコメント、最新のコメントから順に表示。 |
ticket.latest_comment_formatted | 最新のコメント(添付ファイルも含む)。 |
ticket.latest_public_comment_formatted | 最新のパブリックコメント。 |
プロパティ/プレースホルダ | 説明 |
---|---|
ticket.latest_comment_rich |
最新のコメント。リッチテキストの書式設定。「メールにファイルを添付」が有効になっていると、添付ファイルが含まれます。 |
ticket.latest_public_comment_rich | 最新のパブリックコメント。リッチテキストの書式設定。「メールにファイルを添付」が有効になっていると、添付ファイルが含まれます。 |
満足度評価データ
プロパティ | 説明 |
---|---|
satisfaction.rating_section | ユーザーに満足度を評価するように促すフォーマット付きテキストブロック。 |
satisfaction.rating_url | サポートを評価するためのURL。 |
satisfaction.current_rating | 現在の満足度評価のテキスト(例:「満足」) |
satisfaction.positive_rating_url | サポートをプラス評価するためのURL。 |
satisfaction.negative_rating_url | サポートをマイナス評価するためのURL。 |
satisfaction.current_comment | チケットの評価時にユーザーが追加したコメント。 |
カスタムオブジェクトデータ
プロパティ | 説明 |
---|---|
custom_objects.<オブジェクトキー>.custom_fields.<フィールドキー> | カスタムオブジェクトのフィールドの値。 |
custom_objects.<オブジェクトキー>.custom_fields.<フィールドキー>.title | ドロップダウンフィールドの値。 |
custom_objects.<オブジェクトキー>.custom_fields.<フィールドキー>.id | ルックアップリレーションシップフィールドのターゲットオブジェクトのID。 |
custom_objects.<オブジェクトキー>.custom_fields.<フィールドキー>.name | ルックアップリレーションシップフィールドの名前。 |
custom_objects.<オブジェクトキー>.external_id | カスタムオブジェクトレコードの外部ID。 |
custom_objects.<オブジェクトキー>.id | カスタムオブジェクトレコードのID。 |
custom_objects.<オブジェクトキー>.name | カスタムオブジェクトレコードの名前。 |