# Iterable エクスポートインテグレーション Iterable は、完全なクロスチャネルカスタマーエンゲージメントプラットフォームです。メール、SMS、埋め込みメッセージ、アプリ内メッセージ、プッシュ通知、Web プッシュ通知を通じて顧客にメッセージを送信し、顧客基盤を拡大し、エンゲージメントを高め、ユーザーライフタイムバリューを向上させることができます。 このインテグレーションにより、Treasure Data ユーザーは Iterable リストに購読者を追加または削除できます。 ## 前提条件 - Treasure Data の基本知識 - Iterable の基本知識 ## API キーの取得 [Iterable インポートインテグレーション](/ja/int/iterable-import-integration)を参照してください ## TD Console を使用して接続を作成する ### 既存の接続を使用する Iterable 用に作成された Authentication は、入力コネクタと出力コネクタ間で再利用できます。**Integration Hub** > **Authentications** から既存の Authentication を検索してください。 ### 新しい接続を作成する API キーを使用して Iterable への新しい接続を作成する方法については、[Iterable インポートインテグレーション](/ja/int/iterable-import-integration)を参照してください。 ## クエリを定義する ### クエリ例 ``` SELECT email, user_id FROM table my_table ``` ### オーディエンスリストにユーザーを追加する 以下の表は、クエリ結果に含めることができるカラムと、それらが Iterable にどのように送信されるかを説明しています。 | 名前 | 型 | 説明 | | --- | --- | --- | | email | String | | | user_id | String | **userId** に変換されます | | prefer_user_id | Boolean | email よりも user_id を優先します | | merge_nested_objects | Boolean | | 予約カラム **email**、**user_id**、**prefer_user_id**、**merge_nested_objects** は、Iterable に送信する前にペイロード内のそれぞれ **email**、**userId**、**preferUserId**、**mergeNestedObjects** を構築するために使用されます。予約カラム以外のフィールドは、Iterable に送信する前に、ペイロード内の **data fields** に自動的に組み込まれます。 ### オーディエンスリストからユーザーを削除する このコネクタは以下のフィールドのみをサポートしています。 | 名前 | 型 | 説明 | | --- | --- | --- | | email | String | | | user_id | String | | ## Query Export Result を使用してデータをエクスポートする 以下のパラメータを設定してください: ![](/assets/screen-shot-2024-09-09-at-15.12.02.2108b447c894b5262ef80fb7d5b2a9fee0db33feeb9b3fb6ce72efd1c5fa7c8c.94a4ad06.png) | パラメータ | 値 | 説明 | | --- | --- | --- | | **action** | String | add/remove | | **list_id** | Number | | | **campaign_id** | Number | | | **channel_unsubscribe** | Boolean | | | `skip_invalid_data` | Boolean | | ### (オプション) Query Export ジョブをスケジュールする Scheduled Jobs と Result Export を使用して、指定したターゲット宛先に出力結果を定期的に書き込むことができます。 Treasure Data のスケジューラー機能は、高可用性を実現するために定期的なクエリ実行をサポートしています。 2 つの仕様が競合するスケジュール仕様を提供する場合、より頻繁に実行するよう要求する仕様が優先され、もう一方のスケジュール仕様は無視されます。 例えば、cron スケジュールが `'0 0 1 * 1'` の場合、「月の日」の仕様と「週の曜日」が矛盾します。前者の仕様は毎月 1 日の午前 0 時 (00:00) に実行することを要求し、後者の仕様は毎週月曜日の午前 0 時 (00:00) に実行することを要求するためです。後者の仕様が優先されます。 #### TD Console を使用してジョブをスケジュールする 1. **Data Workbench > Queries** に移動します 2. 新しいクエリを作成するか、既存のクエリを選択します。 3. **Schedule** の横にある None を選択します。 ![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png) 4. ドロップダウンで、次のスケジュールオプションのいずれかを選択します: ![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png) | ドロップダウン値 | 説明 | | --- | --- | | Custom cron... | [Custom cron... の詳細](#custom-cron-details)を参照してください。 | | @daily (midnight) | 指定されたタイムゾーンで 1 日 1 回午前 0 時 (00:00 am) に実行します。 | | @hourly (:00) | 毎時 00 分に実行します。 | | None | スケジュールなし。 | #### Custom cron... の詳細 ![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png) | **Cron 値** | **説明** | | --- | --- | | `0 * * * *` | 1 時間に 1 回実行します。 | | `0 0 * * *` | 1 日 1 回午前 0 時に実行します。 | | `0 0 1 * *` | 毎月 1 日の午前 0 時に 1 回実行します。 | | "" | スケジュールされた実行時刻のないジョブを作成します。 | ``` * * * * * - - - - - | | | | | | | | | +----- 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. 各フィールド間には単一のスペースが必要です。各フィールドの値は、次のもので構成できます: | フィールド値 | 例 | 例の説明 | | --- | --- | --- | | 各フィールドに対して上記で表示された制限内の単一の値。 | | | | フィールドに基づく制限がないことを示すワイルドカード `'*'`。 | `'0 0 1 * *'` | 毎月 1 日の午前 0 時 (00:00) に実行するようにスケジュールを設定します。 | | 範囲 `'2-5'` フィールドの許可される値の範囲を示します。 | `'0 0 1-10 * *'` | 毎月 1 日から 10 日までの午前 0 時 (00:00) に実行するようにスケジュールを設定します。 | | カンマ区切りの値のリスト `'2,3,4,5'` フィールドの許可される値のリストを示します。 | `0 0 1,11,21 * *'` | 毎月 1 日、11 日、21 日の午前 0 時 (00:00) に実行するようにスケジュールを設定します。 | | 周期性インジケータ `'*/5'` フィールドの有効な値の範囲に基づいて、 スケジュールが実行を許可される頻度を表現します。 | `'30 */2 1 * *'` | 毎月 1 日、00:30 から 2 時間ごとに実行するようにスケジュールを設定します。 `'0 0 */5 * *'` は、毎月 5 日から 5 日ごとに午前 0 時 (00:00) に実行するようにスケジュールを設定します。 | | `'*'` ワイルドカードを除く上記の いずれかのカンマ区切りリストもサポートされています `'2,*/5,8-10'` | `'0 0 5,*/10,25 * *'` | 毎月 5 日、10 日、20 日、25 日の午前 0 時 (00:00) に実行するようにスケジュールを設定します。 | 1. (オプション) Delay execution を有効にすることで、クエリの開始時刻を遅延させることができます。 ### クエリを実行する クエリに名前を付けて保存して実行するか、単にクエリを実行します。クエリが正常に完了すると、クエリ結果は指定された宛先に自動的にエクスポートされます。 設定エラーにより継続的に失敗するスケジュールジョブは、複数回通知された後、システム側で無効化される場合があります。 (オプション) Delay execution を有効にすることで、クエリの開始時刻を遅延させることができます。 ## Audience Studio で Segment をアクティベートする Audience Studio で activation を作成することで、segment データをターゲットプラットフォームに送信することもできます。 1. **Audience Studio** に移動します。 2. parent segment を選択します。 3. ターゲット segment を開き、右クリックして、**Create Activation** を選択します。 4. **Details** パネルで、Activation 名を入力し、前述の Configuration Parameters のセクションに従って activation を設定します。 5. **Output Mapping** パネルで activation 出力をカスタマイズします。 ![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png) - 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 番号。 1. **Schedule** を設定します。 ![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png) - スケジュールを定義する値を選択し、オプションでメール通知を含めます。 1. **Create** を選択します。 batch journey の activation を作成する必要がある場合は、[Creating a Batch Journey Activation](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation) を参照してください。 ## (オプション) CLI を使用したエクスポートインテグレーション CLI(Toolbelt) を使用して Iterable への Result Export を実行することもできます。 `td query` コマンドの `--result` オプションとして、Iterable サーバーへのエクスポート情報を指定する必要があります。`td query` コマンドについては、[こちらの記事](https://docs.treasuredata.com/display/PD/TD+Toolbelt+Job+and+Query+Command+Reference)を参照してください。 オプションの形式は JSON で、一般的な構造は以下の通りです。 ```json { "type" : "iterable", "api_key" : "xxxxxxxxxxxxxx", "region" : "", "action": "", "list_id": "xxxxxxxxxxx", "channel_unsubscribe": "false", "skip_invalid_data": "true" } ``` ### パラメータ | 名前 | 説明 | 値 | デフォルト値 | 必須 | | --- | --- | --- | --- | --- | | type | エクスポート先のサービス名を記述します。 | Iterable | N/A | はい | | api_key | Data Center にアクセスするための API キー | API Key | N/A | はい | | region | Data Center のリージョン | Region | US | いいえ | | action | データをエクスポートするアクション | Add または remove | N/A | はい | | list_id | リスト ID | List ID | N/A | はい | | skip_on_invalid_records | 無効なレコードをスキップしてジョブを失敗させない | true または false | false | いいえ | | channel_unsubcribe​ | チャネル購読解除 | true または false | false | ​いいえ | ### 使用例 ```bash td query \ --result '{"type":"iterable","api_key":"xxx","region":"us","action":"remove","list_id":"xxxx", "skip_on_invalid_records":true,"channel_unsubscribe": "false"}' \ -d sample_datasets "select * from www_access" \ -T presto ``` ## Iterable のワークフロー例 アクションは以下の値を受け付けます: - Add - Remove ```yaml _export: td: database: example_database +iterable_export_task: td>: export_iterable.sql database: ${td.database} result_connection: iterable   result_settings: type: iterable region : us # or eu action: add list_id: 769207 skip_invalid_data: false ``` ## 参考資料 - API 概要: [https://api.iterable.com/api/docs](https://api.iterable.com/api/docs)