# Klaviyo Export Integration Klaviyoは、eコマース企業向けのEメールマーケティングオートメーションに焦点を当てたデジタルマーケティングプラットフォームです。Klaviyoはeコマース向けのSMSおよびEメールマーケティングオートメーションプラットフォームを提供しています。 このインテグレーションとTDを使用すると、 - Klaviyoメンバーリストにプロファイルを追加できます。 - Klaviyoメンバーリストからプロファイルを削除できます。 ## 前提条件 - [TD Toolbelt](https://api-docs.treasuredata.com/en/tools/cli/quickstart/)を含むTreasure Dataの基本的な知識。 - Private APIアクセストークンを持つKlaviyoアカウント。 ## API情報 Treasure Dataは[Campaigns API](https://developers.klaviyo.com/en/reference/campaigns_api_overview)を使用してKlaviyoにEメールメッセージの送信を指示します。このAPIのリクエストボディに関するドキュメントは、Klaviyoでのメールテンプレートの設定に非常に役立ちます。 ## 要件と制限事項 - 「Remove Profiles」操作を実行するには、クエリでデータ型がstringのprofile_id列(大文字小文字を区別)を指定する必要があります。クエリでこの列を指定しない場合、エラーが返され、ジョブは失敗します。 - 「Add Profiles」操作を実行するには、クエリでデータ型がstringのemail列(大文字小文字を区別)を指定する必要があります。クエリでこの列を指定しない場合、エラーが返され、ジョブは失敗します。 - クエリでphone_number列(大文字小文字を区別)を指定する場合、このフィールドのデータは[Accepted phone number formats for SMS in Klaviyo](https://help.klaviyo.com/hc/en-us/articles/360046055671-Accepted-Phone-Number-Formats-for-SMS-in-Klaviyo)に従う必要があります。そうでない場合、エラーが返され、ジョブは失敗します。 ## Klaviyo ConsoleからPrivate APIアクセストークンを取得 1. [Klaviyo Dashboard](https://www.klaviyo.com/login)にログインします。 2. Settingsタブで**Create Private API Key**を選択します。 3. Private API keyをコピーして、安全な場所に保存します。 ![](/assets/image2021-9-2_19-8-32.3c940e83c69573c651a7da50d75f3d29c1cea78773d0919014671f5cce866889.9d563c94.png) ## Klaviyo Consoleからリスト名またはリストIDを取得 1. [Klaviyo Dashboard](https://www.klaviyo.com/login)にログインします。 2. ダッシュボードの左側で**Lists & Segments**を選択します。 3. Lists & Segmentsページから、リスト名のリンクを選択します。 4. リスト表示ページのURLからlist_idをコピーして、安全な場所に保存します。 ## TD Consoleを使用してコネクションを作成 ### 新しいコネクションを作成 Treasure Dataでは、クエリを実行する前にデータコネクションを作成して設定する必要があります。データコネクションの一部として、インテグレーションにアクセスするための認証情報を提供します。 1. **TD Console**を開きます。 2. **Integrations Hub** > **Catalog**に移動します。 3. Klaviyoを検索し、**Klaviyo Output Beta**を選択します。 4. **Create Authentication**を選択します。 ![](/assets/klaviyo_out.0f1f332e2fc85584bcb180c9fa57797ba9cf1d0a8c104ef10e5135ca3b4a15f9.9d563c94.png) 5. KlaviyoのPrivate API keyを入力します。 6. **Continue**を選択します。 ![](/assets/image2021-9-2_19-14-14.07bfc65e3d181f1ab49f3dbe1216044dced2a2b71f29e03d716a3f93f0f71541.9d563c94.png) 7. コネクションの名前を入力します。 8. **Done**を選択します。 ### クエリを定義 「Add Profiles」操作を実行するには、クエリでデータ型がstringのemail列(大文字小文字を区別)を指定する必要があります。クエリでこの列を指定しない場合、エラーが返され、ジョブは失敗します。 「Remove Profiles」操作を実行するには、クエリでデータ型がstringのprofile_id列(大文字小文字を区別)を指定する必要があります。クエリでこの列を指定しない場合、エラーが返され、ジョブは失敗します。 1. [Creating a Destination Integration](https://docs.treasuredata.com/smart/project-product-documentation/creating-a-destination-integration)の手順を完了します。 2. Data Workbench > Queriesに移動します。 3. データをエクスポートするクエリを選択します。 4. クエリを実行して結果セットを検証します。 5. Export Resultsを選択します。 6. **Use Existing Integration**を選択します。 ![](/assets/image2021-9-2_19-23-5.c6b3eb8e8b76d7851851789359e57bca513b4d9131d3ba63d22498b710a4242e.9d563c94.png) 7. 追加のExport Resultsの詳細を定義します。エクスポートインテグレーションのコンテンツで、インテグレーションパラメータを確認します。 ![](/assets/screen-shot-2024-04-10-at-11.12.26.b5eae7fa5e71597f36ea8a08fe276329846e8678c14ec021c4260e197779ad5e.9d563c94.png) 8. **Done**を選択します。 9. クエリを実行します。 10. 指定した宛先にデータが移動したことを検証します。 **Klaviyoのインテグレーションパラメータ** | パラメータ | 値 | 説明 | | --- | --- | --- | | Data operation | - Add profiles - Remove profiles | Klaviyoリストにプロファイルを追加または削除します。remove profiles操作にはKlaviyoのprofile_idが必要です。削除後、プロファイルはこの特定のリストからマーケティングメールを受信しなくなります。 | | Add to | - List ID - List Name | Klaviyoリストを識別するために使用されます。 | | List ID or List Name value | - List ID - List Name | プロファイルが追加されるリストIDまたはリスト名。 「Add to」パラメータがList Nameに設定されており、ここで指定された名前がKlaviyoに存在しない場合、これらの値を持つ新しいリストが作成されます。 | | Wait Until The Operation Is Finished? | True/False | チェックを入れると、TD ConsoleはKlaviyo側で操作が完了するまで待機してから続行します。 チェックを外すと、TD ConsoleはタスクをKlaviyoに送信して先に進みます。 | | The waiting time for operation completion | 最小: 300000 ms (5分) 最大: 86400000 ms (1日) | TD Consoleが操作の完了を待機する時間(ミリ秒)。 | ## クエリ例 このクエリにはemail列を含める必要があります。 ```sql SELECT email, col_a, col_b, col_c FROM your_table; ``` このクエリにはprofile_id列が必要です。 ```sql SELECT profile_id FROM your_table; ``` ### (オプション) 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 を有効にすることで、クエリの開始時刻を遅延させることができます。 ## ワークフローでのエクスポート結果の設定（オプション） Treasure Workflowでは、このデータコネクタを使用してデータをエクスポートするよう指定できます。 [TD Toolbeltを使用してワークフローでデータをエクスポートする方法](https://api-docs.treasuredata.com/en/tools/cli/api/#workflow-commands)の詳細をご覧ください。 ### リストIDでプロファイルを追加するワークフローの例 ```yaml _export: td: database: klaviyo_db +klaviyo_export_task: td>: export_data.sql database: ${td.database} result_connection: new_created_klaviyo_auth result_settings: type: klaviyo api_token: api_token operation: add list_identify_type: id list_value: id_value wait_for_completion: true waiting_time_for_completion_millis: 3600000 ``` ### リスト名でプロファイルを追加するワークフローの例 ```yaml _export: td: database: klaviyo_db +klaviyo_export_task: td>: export_data.sql database: ${td.database} result_connection: new_created_klaviyo_auth result_settings: type: klaviyo api_token: api_token operation: add list_identify_type: name list_value: name_value wait_for_completion: true waiting_time_for_completion_millis: 3600000 ``` ### リストIDでプロファイルを削除するワークフローの例 ```yaml _export: td: database: klaviyo_db +klaviyo_export_task: td>: export_data.sql database: ${td.database} result_connection: new_created_klaviyo_auth result_settings: type: klaviyo api_token: api_token operation: remove_profiles list_identify_type: id list_value: id_value ``` ### リスト名でプロファイルを削除するワークフローの例 ```yaml _export: td: database: klaviyo_db +klaviyo_export_task: td>: export_data.sql database: ${td.database} result_connection: new_created_klaviyo_auth result_settings: type: klaviyo api_token: api_token operation: remove_profiles list_identify_type: name list_value: name_value ```