メッセージングメタデータは、会話フィールドおよび会話タグ（それぞれ「カスタムチケットフィールド」および「カスタムチケットタグ」とも呼ばれる）を使用して、サポート案件や製品またはサービスに関するより多くの情報を収集します。管理センターでトリガを作成することにより、エージェントワークスペースでこのメタデータを使用してチケットルーティングの迅速化を図ることもできます。エンドユーザーにカスタムフィールドを表示したい場合は、メッセージングメタデータをチケットに追加し、ヘルプセンターのリクエスト送信フォームに追加します。
また、会話フィールドやタグを使用して、クライアント側のAPI経由でWeb WidgetやZendesk SDKからエージェントにメッセージングメタデータを送信することもできます。これにより、商品SKU、確認番号、注文IDなどの関連情報をエージェントに自動的に転送することができます。この追加メタデータは、包括的なコンテキストを提供し、サポート提供の質を高めるのに役立ちます。
- エージェントのコンテキストの向上。エージェントは、エージェントワークスペースビューに表示される正しいコンテキスト情報を頼りにしています。情報の不足やエンドユーザーから提供されたデータは、エラーの原因となります。関連する情報をシステムで提供することで、エラーの発生を抑え、情報の問い合わせにかかる時間を短縮できます。
- ルーティングの改善。企業は、チケットフィールドやタグの情報に基づいて、チケットを適切なエージェントグループに迅速にルーティングすることができます。できるだけ多くの情報を提供することで、チケットを効率的に適切なエージェントグループにルーティングできるようになります。
- エンドユーザーにとって最適なエクスペリエンス。クライアント側ですでに保存されている情報について、エンドユーザーは再入力する必要がありません。
- 自動化フローの改善。ボットビルダーは、ボットエクスペリエンスの向上のために追加データを活用することができます。
- チケットフィールドとタグをサポートする従来版のWeb Widget Support SDKとの機能の互換性。
メッセージングメタデータの概要
自社のオンラインストアで、エンドユーザーが特定の靴を見ているとします。このページでは、商品のSKUと、サイズと色の選択肢が提供されます。この靴についてエンドユーザーが問い合わせがあった場合、エージェントはエンドユーザーがどの靴に興味があるかを正確に知るために、これらの情報を知る必要があります。カスタムチケットフィールドがない場合、エージェント（またはZendeskボット）は、エンドユーザーからこれらの情報をすべて聞き出さないと質問に答えることができません。
メッセージングメタデータを使用すると、これらの情報をページから自動的に取得するか、エンドユーザーにフォームに入力してもらうか、あるいは両方を組み合わせて取得することができます。たとえば、カスタムチケットフィールドを作成し、APIを使用して、商品ページから商品SKUを取得すことができます。靴の色やサイズをエンドユーザーが選択しているかどうかにかかわらず、たとえばZendeskボットはカスタムチケットフィールドを使用してこれらを照会し、デフォルト値を表示することができます。エンドユーザーは値を変えることも、デフォルト値のままにしておくこともできます。
- エンドユーザーは、訪問しているページにすでにあるデータを手動で入力する必要がない。たとえば、エンドユーザーが開いている返品注文フォームのページにすでに注文IDがある場合、エンドユーザーに入力させる必要はなく、その番号を自動的に取得することができます。
- エージェントの役に立つ追加のコンテキストを自動的に追加することができる。たとえば、エンドユーザーがショッピングカートを開いている場合、会話フィールド「Active Shopping Cart」をtrueに設定することができます。
- ボットがたどるパスをコントロールすることができる。たとえば、エンドユーザーがブランドAのページにいる場合、ボットがブランドAのパスを通過するようにフィールドに設定することができます。
メッセージングメタデータを設定する
会話フィールドは、フィールドの作成時にエンドユーザーが値を設定できるように、管理センター内で設定する必要があります。会話タグには、メタデータAPIを使用するための前提条件は必要ありません。
メッセージングメタデータを使用するための最初のステップは、収集したいデータとその用途を決定することです。これはユースケースに完全に依存します。開発者がZendesk Web WidgetやSDKでチケットのフィールドやタグの値をプログラミングする際のエンドユーザーエクスペリエンスを、十分に理解しておく必要があります。
- Zendesk管理者がカスタムチケットフィールドを作成し、開発者にフィールド名とIDを渡し、収集が必要なデータとその用途を伝えます。
- 開発者は、フィールドIDを使用してメタデータのAPIコールをコーディングし、値をそのフィールドに関連付けます。
- データは実行時にプログラムによってメタデータAPIに設定され、次回のセッションで利用可能になります。
- チケットフィールドとタグデータは、チケット作成時にサポートチケットに追加されます。
チケットフィールドとタグのメタデータは、チケット作成時にチケットに適用されます。たとえば、（ボットではなく）エージェントと即座にチャットするようにウィジェットを設定した場合、ウィジェットを開くとすぐ新しいチケットが作成されます。その際、作成前に設定されていたたチケットフィールドとタグのみがチケットに追加されます。
チケットが終了されると、バックエンド（チケットなど）のメッセージングメタデータは空のnull状態にリセットされます。現在のところ、メッセージングメタデータはクライアント側に保持されますが、将来のリリースで対処される予定です。
会話フィールドを追加する
会話フィールドはどのSupportプランでも作成できますが、メッセージングを設定し、メッセージング用のZendesk Web WidgetまたはSDKを使用する必要があります。
「優先度」フィールドなどのシステムチケットフィールドはサポートされません。ヘルプセンターからアクセスした場合、これらのフィールドはデフォルトの問い合わせフォーム（およびその他のチケットフォーム）に表示されますが、Web Widgetには表示されません。
会話フィールドが設定されているかどうかは、ZendeskエージェントワークスペースまたはZendesk APIでチケット情報を確認することでわかります。例については、「Using Messaging Metadata」を参照してください。
- 管理センターで、サイドバーの「
オブジェクトとルール」をクリックし、「チケット」>「フィールド」を選択します。 - 「フィールドを追加」をクリックします。
- フィールドタイプを選択し、「表示名」を入力します。
- （オプション）「説明」にカスタムフィールドの説明を入力します。これは管理者のみに表示されます。
- 「権限」で、「顧客は編集可能」を選択します。メモ：値はパブリックなクライアント側のAPIコールで設定できるため、データは常にエンドユーザーがデータを提供したものとして扱われるようにすることをお勧めします。機密性の高いデータに対して、これらのAPIを使用することは推奨されません。
- 「顧客に表示されるタイトル」にタイトルを入力します。
- チケットの解決時にエージェントにこのフィールドへの入力を求めたい場合は、「チケットの解決時に入力を要求する」を選択します。このオプションは、すべてのフィールドタイプで利用できるわけではありません。メモ：エージェントがチケットを統合する場合、統合されたチケットは「解決済み」をバイパスして「終了」に直接移動するため、必須フィールドに入力する必要はありません。エージェントではなくシステムプロセスがチケットを解決するため、ビジネスルールによってチケットが「解決済み」に変更された場合も、この設定はバイパスされます。
- チケットの送信時にエンドユーザーにこのフィールドへの入力を求めたい場合は、「リクエストの送信時に必須入力にする」を選択します。
- フィールドタイプに応じて、追加のオプションを設定します。
- （オプション）カスタムフィールドの「デフォルト値」を指定します。メモ：ドロップダウンリストのデフォルト値は、Supportインターフェイスを介してエージェントが作成した新しいチケット、またはチケットフォームが表示されている場所でユーザーが作成した新しいチケットにのみ適用されます。既存のチケットフォームを、デフォルトオプションが設定されたドロップダウンリストを含むフォームに変更すると、デフォルトオプションは表示されず、空白が表示されます。
- 「保存」をクリックします。または、別のカスタムフィールドを作成する場合は、ドロップダウンアイコンをクリックして「保存」を選択し、別のカスタムフィールドを追加します。
- 作成したフィールドのフィールドIDは、メタデータAPIを使用する際に必要になるので保存しておきます。
作成後、開発者は/api/v2/ticket_fields APIを使用して会話フィールドデータを表示することができます。以下に応答の例を示します。
[
{
url: "https://z3n-lhills.zendesk.com/api/v2/ticket_fields/10093547287955.json",
id: 10093547287955,
type: "integer",
title: "Bike Order id",
raw_title: "Bike Order id",
description:
"An API will populate this bike order id value",
raw_description:
"An API will populate this bike order id value",
position: 9999,
active: true,
required: false,
collapsed_for_agents: false,
regexp_for_validation: "\A[-+]?\d+\z",
title_in_portal: "Bike Order Id",
raw_title_in_portal: "Bike Order Id",
visible_in_portal: true,
editable_in_portal: true,
required_in_portal: false,
tag: null,
created_at: "2022-10-04T04:48:05Z",
updated_at: "2022-10-04T04:48:05Z",
removable: true,
agent_description: "Order id from our bikes catalog",
},
]会話フィールドの値の消去
会話フィールドの値を消去しなければならない場合があります。これはユースケースによりますが、取得したデータが有効でなくなった場合に行います。たとえば、会話フィールドを使用してエンドユーザーのオンラインカートからデータを収集しているとします。エンドユーザーがカート内のアイテムをすべて削除した場合、収集したデータは無効になるため、会話フィールドの値を消去します。
会話フィールドの値を消去するには、clearConversationFields(
) APIを使用します。
会話タグを追加する
タグは、単語または単語の組み合わせであり、チケットおよびトピックに詳しいコンテキストを追加するために使用できます。チケット、ユーザー、組織にタグを使用できます。たとえば、実際には商談の引き合いであると見られるリクエストすべてに対して、「商談」または「about_sales」といったタグを付けます。次に、ビューまたはレポートを作成すれば、これらのリクエストを追跡できます。
詳細については、「タグについて」を参照してください。
メタデータAPIを使用する
メタデータAPIの使用例については、開発者向けドキュメントの「Using Messaging Metadata」を参照してください。
会話フィールドとタグの設定
会話フィールドの値を設定するには、setConversationFields APIを使用します。たとえば、カスタムチケットのフィールドIDが10093547287955で、その値を文字列 '548832222' に設定したい場合、次のように呼び出します。
zE('messenger:set', 'conversationFields', [{ id: '10093547287955',
value: '548832222'}]);
カスタムドロップダウンフィールドや、フィールドの値をタグに関連付けるフィールドを使用している場合、カスタムフィールドの値を設定すると、結果のチケットのカスタムタグの値も設定されます。
以下に setConversationFields の応答の例を示します。
conversation: {
...
metadata: {
"zen:ticket_field": "30289064739483",
...
},
}{field ID}は文字列でなければなりません。そうでない場合は、文字列に変換されます。{value}は文字列、数値、またはブール値でなければなりません。会話タグの値を設定するには、setConversationTags APIを使用します。setConversationFields APIと同様に、編集可能なカスタムフィールドに関連付けられているカスタムタグを設定すると、カスタムフィールドが設定されます。カスタムタグがプライベート（編集不可）のカスタムフィールドに関連付けられている場合、カスタムフィールドは設定されません。
setConversationTags APIを使用した応答の例を以下に示します。
conversation: {
...
metadata: {
"zen:ticket:tags": "likes-nike-trainers, frequent-shopper",
},
}会話フィールドとタグの消去
クライアント側のコンテキストが変更された場合、会話フィールドの値とタグを消去できます。たとえば、エンドユーザーが商品ページからメインストアのランディングページに移動したとします。その商品ページから収集したデータは、もはや無効となります。
これを行うには、ClearConversationFields APIとClearConversationTags APIを使用します。これですべての会話フィールドの値とタグが一括消去されます。フィールドの値やタグを個別に消去することはできません。
ボットビルダー
メタデータAPIを使用して更新されたフィールドには既存のデータが入力され、このステップで表示される際にエンドユーザーが編集できます。詳細については、「回答ステップのタイプについて」および「カスタムチケットフィールドを作成する」を参照してください。