ドキュメントExperience Platformタグ

Zendesk Events API 拡張機能の概要

Last update: Thu Dec 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者

Zendesk は、カスタマーサービスソリューションおよびセールスツールです。 Zendesk イベント転送拡張機能は、Zendesk Events API を活用して、イベントを Adobe Experience Platform Edge Network から Zendesk に送信して、さらに処理できるようにします。 拡張機能を使用して、ダウンストリームの分析やアクションで使用する顧客プロファイルインタラクションを収集できます。

このドキュメントでは、UI で 拡張機能をインストールおよび設定する方法について説明します。

前提条件

この拡張機能を使用するには、Zendesk アカウントが必要です。 Zendesk アカウントは、Zendesk web サイトで登録できます。

また、Zendesk の設定に関して、次の詳細を収集する必要があります。

キータイプ
説明
例
サブドメイン
登録プロセス中に、アカウントに固有の一意の​ サブドメイン ​が作成されます。詳しくは、Zendesk のドキュメントを参照してください。
xxxxx.zendesk.com（xxxxx は、アカウントの作成時に指定された値です）
API トークン
Zendesk は、Zendesk API と通信するための認証メカニズムとして Bearer トークンを使用します。 Zendesk ポータルにログインした後、API トークンを生成します。 詳しくは、Zendesk のドキュメントを参照してください。
cwWyOtHAv12w4dhpiulfe9BdZFTz3OKaTSzn2QvV

最後に、API トークンのイベント転送の秘密鍵を作成する必要があります。 秘密鍵タイプを「トークン」に設定し、その値を Zendesk 設定から収集した API トークンに設定します。 秘密鍵の設定に関する詳細については、イベント転送での秘密鍵に関するドキュメントを参照してください。

拡張機能のインストール install

UI で Zendesk 拡張機能をインストールするには、イベント転送​に移動し、拡張機能を追加するプロパティを選択するか、代わりに新しいプロパティを作成します。

目的のプロパティを選択または作成したら、拡張機能／カタログ​に移動します。「Zendesk」を検索し、Zendesk 拡張機能で Install を選択します。

UI で選択されている Zendesk 拡張機能のインストールボタン

拡張機能の設定 configure

IMPORTANT
実装のニーズに応じて、拡張機能を設定する前に、スキーマ、データ要素、データセットの作成が必要になる場合があります。 ユースケースに合わせて設定する必要のあるエンティティを判断するには、開始する前にすべての設定手順を確認してください。

左側のナビゲーションの「拡張機能」を選択します。 インストール済み​で、Zendesk 拡張機能の「設定」を選択します。

UI で選択されている Zendesk 拡張機能の設定ボタン

Zendesk ドメイン​で、Zendesk サブドメインの値を入力します。Zendesk トークン​で、API トークンを含む、以前に作成した秘密鍵を選択します。

UI に入力された設定オプション

イベント転送ルールの設定

新しいイベント転送ルールのルールの作成を開始し、 必要に応じて条件を設定します。 ルールのアクションを選択する場合は、Zendesk 拡張機能を選択してから、「イベントを作成」アクションタイプを選択します。

ルールの定義

アクション設定を設定する際に、Zendesk に送信される様々なプロパティにデータ要素を割り当てるように求められます。

アクション設定の定義

これらのデータ要素は、以下に示すようにマッピングする必要があります。

event キー

event は、ユーザーによってトリガーされたイベントを表す JSON オブジェクトです。event オブジェクトが取得するプロパティについて詳しくは、イベントの詳細に関する Zendesk のドキュメントを参照してください。

次のキーは、event オブジェクト内でデータ要素にマッピングするときに参照されます。

event キー
タイプ
プラットフォームパス
説明
必須
制限
source
文字列
arc.event.xdm._extconndev.event_source
イベントを送信したアプリケーション。
○
Zendesk は、Zendesk 標準イベントのソース名として保護されているため、値として使用しないでください。使用を試みると、エラーが発生します。
値の長さは 40 文字を超えないようにします。
type
文字列
arc.event.xdm._extconndev.event_type
イベントタイプの名前。このフィールドを使用して、特定のソースに対して様々な種類のイベントを示すことができます。例えば、ユーザーログイン用のイベントと買い物かご用のイベントを 1 組ずつ作成できます。
○
値の長さは 40 文字を超えないようにする必要があります。
description
文字列
arc.event.xdm._extconndev.description
イベントに関する説明。
×
（N/A）
created_at
文字列
arc.event.xdm.timestamp
イベントが作成された時刻を反映した ISO-8601 タイムスタンプ。
×
（N/A）
properties
オブジェクト
arc.event.xdm._extconndev.EventProperties
イベントについての詳細を含むカスタム JSON オブジェクト。
○
（N/A）
NOTE
イベントプロパティについて詳しくは、Zendesk Events API ドキュメントを参照してください。

profile キー

profile は、イベントをトリガーしたユーザーを表す JSON オブジェクトです。 profile オブジェクトによって取り込まれるプロパティについて詳しくは、Zendesk のドキュメントにあるプロファイルの詳細を参照してください。

データ要素へのマッピングの際、次のキーは profile オブジェクト内で参照できます。

profile キー
タイプ
プラットフォームパス
説明
必須
制限
source
文字列
arc.event.xdm._extconndev.profile_source
プロファイルに関連付けられた製品またはサービス（例：Support、CompanyName、または Chat）。
○
（N/A）
type
文字列
arc.event.xdm._extconndev.profile_type
プロファイルタイプの名前。このフィールドを使用して、特定のソースに対応する様々な種類のプロファイルを作成できます。例えば、顧客用と従業員用に 1 組の会社プロファイルを作成できます。
○
プロファイルタイプの長さは 40 文字以下にする必要があります。
name
文字列
arc.event.xdm._extconndev.name
プロファイルの人物名
×
（N/A）
user_id
文字列
arc.event.xdm._extconndev.user_id
Zendesk におけるその人物のユーザー ID。
×
（N/A）
identifiers
配列
arc.event.xdm._extconndev.identifiers
1 つ以上の識別子を含む配列。 各識別子は、タイプと値で構成されます。
○
identifiers 配列について詳しくは、Zendesk ドキュメントを参照してください。すべてのフィールドと値は一意である必要があります。
attributes
オブジェクト
arc.event.xdm._extconndev.attrbutes
人物に関するユーザー定義のプロパティを含むオブジェクト。
×
プロファイル属性について詳しくは、Zendesk ドキュメントを参照してください。

Zendesk 内のデータの検証 validate

イベントの収集と Adobe Experience Platform の統合が成功した場合は、Zendesk コンソール内のイベントが以下のように表示されます。これは、統合が成功したことを示します。

プロファイル：

Zendesk プロファイルページ

イベント：

Zendesk イベントページ

リクエストの制限 limits

アカウントのタイプに基づいて、Zendesk Events API は、1 分あたりに次のリクエスト数を処理できます。

Account Type
1 分あたりのリクエスト数
Team
250
Growth
250
Professional
500
Enterprise
750
Enterprise Plus
1000

これらの制限の詳細については、Zendesk のドキュメントを参照してください。

エラーとトラブルシューティング errors-and-troubleshooting

拡張機能の使用中または設定中に、以下のエラーが Zendesk Events API から返される場合があります。

エラーコード
説明
解像度
例
400
無効なプロファイル長：​このエラーは、プロファイル属性の長さが 40 文字を超える場合に発生します。
プロファイル属性データの長さを最大 40 文字に制限します。
{"error": [{"code":"InvalidProfileTypeLength","title": "Profile type length > 40 chars"}]}
401
ルートが見つかりません：​このエラーは、無効なドメインが指定された場合に発生します。
有効なドメインが次の形式 {subdomain}.zendesk.com で指定されていることを確認します。
{"error": [{"description": "No route found for host {subdomain}.zendesk.com","title": "RouteNotFound"}]}
401
認証が無効または見つかりません：​このエラーは、トークンへのアクセスが無効、見つからない、または期限切れの場合に発生します。
アクセストークンが有効で、期限切れでないことを確認します。
{"error": [{"code":"MissingOrInvalidAuthentication","title": "Invalid or Missing Authentication"}]}
403
必要な権限がありません：​このエラーは、リソースにアクセスするのに十分な権限が提供されていない場合に発生します。
必要な権限が提供されていることを確認します。
{"error": [{"code":"PermissionDenied","title": "Insufficient permisssions to perform operation"}]}
429
リクエストが多すぎます：​このエラーは、エンドポイントオブジェクトのレコード制限を超えた場合に発生します。
制限ごとのしきい値の詳細については、リクエスト制限に関する上記の節を参照してください。
{"error": [{"code":"TooManyRequests","title": "Too Many Requests"}]}

次の手順

このドキュメントでは、UI で Zendesk イベント転送拡張機能をインストールおよび設定する方法について説明しました。 Zendesk でのイベントデータの収集について詳しくは、次の公式ドキュメントを参照してください。

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743