Zendesk Export Integration

Zendesk® Sunshineのモダンなクラウドベースの CRM プラットフォームは、顧客のニーズやトレンドを特定するために使用されます。Zendesk Export Integration コネクタを使用して、Events データを Zendesk Sunshine にエクスポートできます。

• Treasure Data の基本知識
• Zendesk Sunshine アカウント

結果の出力スキーマは、ターゲットイベントで要求される列(名前とデータ型)と一致する必要があります。

profile_identifier は最大20列まで設定できます(1から20まで連続した昇順で設定)。

必須列

• profile_source (String)
• profile_type (String)
• event_source (String)
• event_type (String)
• event_properties (JSON String) – イベントペイロードのシリアル化されたキーと値のペアを提供します。

識別子(少なくとも1つ)

• profile_identifier_1 から profile_identifier_20 という名前の最大20列。
• 各値は type,value パターンに従う必要があります(例: email,example@gmail.com)。

オプション列

• profile_name
• profile_created_at
• profile_attributes
• event_description
• event_created_at
• event_received_at

必須列

• profile_id (String)
• event_source (String)
• event_type (String)
• event_properties (JSON String)

オプション列

• event_description
• event_created_at
• event_received_at

必須列

• user_id (String)
• profile_source (String)
• profile_type (String)
• event_source (String)
• event_type (String)
• event_properties (JSON String)

識別子(少なくとも1つ)

• 上記と同じ profile_identifier_1 から profile_identifier_20 列および type,value ルール。

オプション列

• profile_name
• profile_created_at
• profile_attributes
• event_description
• event_created_at
• event_received_at

API は標準の作成エンドポイントにレート制限を適用します。制限には、Zendesk Apps フレームワークから行われたリクエストも含まれます。各プランタイプのレート制限は以下の通りです:

次の表は、プロファイルのハード制限を示しています。可用性と制限は Sunshine プランタイプによって異なる場合があります。

次の表は、イベントのハード制限を示しています。可用性と制限は Sunshine プランタイプによって異なる場合があります。

OAuth Client Credentials で認証する場合のみ、次の手順を実行します。Client Credentials は、ジョブ実行時に担当者が認可する必要がないため、無人のスケジュール実行エクスポートに適しています。担当者が対話的に認可できる場合は、OAuth を使用してください。

1. 永続的なサービスアカウントの管理者として Zendesk にサインインします。Zendesk は、この連携が実行するすべての操作を OAuth クライアントを作成したユーザーの操作として記録します。無効化される可能性のある個人アカウントは使用しないでください。

2. 管理センター > アプリと連携 > API > OAuth クライアント に移動します。

3. OAuth クライアントを追加 をクリックします。

4. クライアント名、一意の識別子（これが クライアント ID になります）、リダイレクト URL を入力します。リダイレクト URL はクライアント資格情報グラントでは使用されませんが、Zendesk では値の入力が必須です。

5. 保存 をクリックして確認します。Zendesk が シークレット を生成します。

6. シークレット をこの時点でコピーして安全に保管してください。Zendesk はシークレットを一度しか表示せず、後から取得することはできません。再発行のみ可能です。

7. OAuth クライアントに、連携がリクエストするスコープが許可されていることを確認します。

   • インポート: read
   • エクスポート: users:write

   同じ OAuth クライアントをインポートとエクスポートの両方で使用する場合は、read と users:write の両方を許可してください。

これで、Treasure AI で接続を設定するために必要な クライアント ID（一意の識別子）と クライアントシークレット が用意できました。

Treasure Data では、クエリを実行する前に、エクスポート時に使用するデータ接続を作成および設定する必要があります。データ接続の一部として、インテグレーションにアクセスするための認証を提供します。

1. Treasure コンソール を開きます。

2. Integrations Hub > Catalog に移動します。

3. Zendesk を検索して選択します。

4. Create をクリックします。認証済み接続を作成しています。次のダイアログが開きます。

5. basic、token、または OAuth 認証でイベントデータをエクスポートするには、Zendesk のログイン URL を入力します。例: https://{your_domain}.zendesk.com。OAuth Client Credentials ではこのフィールドは使用しません。

6. Auth method には、basic、token、OAuth、OAuth Client Credentials の異なるオプションがあります。

7. オプションで、基本認証の場合は、username と password の値を入力します。

8. オプションで、token の場合は、username と token の値を入力します。

9. オプションで、OAuth の場合は、OAuth Access Token の値を入力します。

10. オプションで、OAuth Client Credentials の場合は、Zendesk subdomain、Client ID、Client Secret の値を入力します。サブドメインは Zendesk URL のサブドメイン部分のみです（例: https://example.zendesk.com の場合は example）。Zendesk OAuthクライアントの作成 を参照してください。

11. Continue を選択します。

12. 新しい Zendesk 接続に名前を付けます。

13. Done を選択します。

クエリを作成または再利用します。

場合によっては、クエリで列マッピングを定義する必要があります。

1. Treasure コンソール を開きます。

2. Data Workbench > Queries に移動します。

3. データのエクスポートに使用する予定のクエリを選択します。各タイプのリソースには特定の列と正確な列名(大文字小文字を区別)およびデータ型が必要です。データのエクスポートに使用できるコード例:

Events for profiles

SELECT
 profile_source,
 profile_type,
 profile_identifier_1,
 event_source,
 event_type,
 event_properties
FROM
  your_table;

Events for profile ID

SELECT p
 profile_id,
 event_source,
 event_type,
 event_properties
FROM
 your_table;

Events for user id

SELECT
 user_id,
 profile_source,
 profile_type,
 profile_identifier_1,
 event_source,
 event_type,
 event_properties
FROM
 your_table;

4. クエリエディタの上部にある Export Results を選択します。Choose Integration ダイアログが開きます。結果をエクスポートする接続を選択する際には、既存の接続を使用するか、新しい接続を作成するかの2つのオプションがあります。これらの手順では、既存の接続を選択することを前提としています。

5. 検索ボックスに接続名を入力してフィルタリングします。

6. 接続を選択します。

7. 次のいずれかを選択します:

8. オプションで、Skip invalid records を選択します。

9. Done を選択します。

Scheduled Jobs と Result Export を使用して、指定したターゲット宛先に出力結果を定期的に書き込むことができます。

Treasure Data のスケジューラー機能は、高可用性を実現するために定期的なクエリ実行をサポートしています。

2 つの仕様が競合するスケジュール仕様を提供する場合、より頻繁に実行するよう要求する仕様が優先され、もう一方のスケジュール仕様は無視されます。

例えば、cron スケジュールが '0 0 1 * 1' の場合、「月の日」の仕様と「週の曜日」が矛盾します。前者の仕様は毎月 1 日の午前 0 時 (00:00) に実行することを要求し、後者の仕様は毎週月曜日の午前 0 時 (00:00) に実行することを要求するためです。後者の仕様が優先されます。

1. Data Workbench > Queries に移動します

2. 新しいクエリを作成するか、既存のクエリを選択します。

3. Schedule の横にある None を選択します。

4. ドロップダウンで、次のスケジュールオプションのいずれかを選択します:

   ドロップダウン値	説明
   Custom cron...	Custom cron... の詳細を参照してください。
   @daily (midnight)	指定されたタイムゾーンで 1 日 1 回午前 0 時 (00:00 am) に実行します。
   @hourly (:00)	毎時 00 分に実行します。
   None	スケジュールなし。

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

次の名前付きエントリを使用できます:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

各フィールド間には単一のスペースが必要です。各フィールドの値は、次のもので構成できます:

1. (オプション) Delay execution を有効にすることで、クエリの開始時刻を遅延させることができます。

クエリに名前を付けて保存して実行するか、単にクエリを実行します。クエリが正常に完了すると、クエリ結果は指定された宛先に自動的にエクスポートされます。

(オプション) Delay execution を有効にすることで、クエリの開始時刻を遅延させることができます。

Audience Studio で activation を作成することで、segment データをターゲットプラットフォームに送信することもできます。

1. Audience Studio に移動します。
2. parent segment を選択します。
3. ターゲット segment を開き、右クリックして、Create Activation を選択します。
4. Details パネルで、Activation 名を入力し、前述の Configuration Parameters のセクションに従って activation を設定します。
5. Output Mapping パネルで activation 出力をカスタマイズします。

• Attribute Columns
  • Export All Columns を選択すると、変更を加えずにすべての列をエクスポートできます。
  • + Add Columns を選択して、エクスポート用の特定の列を追加します。Output Column Name には、Source 列名と同じ名前があらかじめ入力されます。Output Column Name を更新できます。+ Add Columns を選択し続けて、activation 出力用の新しい列を追加します。
• String Builder
  • + Add string を選択して、エクスポート用の文字列を作成します。次の値から選択します:
    • String: 任意の値を選択します。テキストを使用してカスタム値を作成します。
    • Timestamp: エクスポートの日時。
    • Segment Id: segment ID 番号。
    • Segment Name: segment 名。
    • Audience Id: parent segment 番号。

6. Schedule を設定します。

• スケジュールを定義する値を選択し、オプションでメール通知を含めます。

7. Create を選択します。

ワークフローでデータコネクタを使用してデータをエクスポートする方法の詳細については、About Using Workflows to Export Data with the TD Toolbelt を参照してください。

Basic Auth を使用:

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    login_url: https://{example}.zendesk.com
    auth_method: basic
    username: {username}
    password: {password}
    target: event_profile
    skip_invalid_records: true

Auth Token を使用:

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    login_url: https://{example}.zendesk.com
    auth_method: token
    username: {username}
    token: {token}
    target: event_profile
    skip_invalid_records: true

OAuth Token を使用

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    login_url: https://{example}.zendesk.com
    auth_method: oauth
    access_token: {access_token}
    target: event_profile
    skip_invalid_records: true

OAuth Client Credentials を使用:

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    auth_method: client_credentials
    subdomain: {example}
    client_id: {client_id}
    client_secret: {client_secret}
    target: event_profile
    skip_invalid_records: true

client_credentials では login_url の代わりに subdomain を指定します。Treasure AI はクライアント ID とシークレットを短命のアクセストークンと交換し、ジョブ実行中に自動的に更新します。

Basic Auth を使用

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    login_url: https://{example}.zendesk.com
    auth_method: basic
    username: {username}
    password: {password}
    target: event_profile_id
    skip_invalid_records: true

Basic Auth を使用

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    login_url: https://{example}.zendesk.com
    auth_method: basic
    username: {username}
    password: {password}
    target: event_user_id
    skip_invalid_records: true