# Braze Export Integration Brazeプラットフォームは、新しい成長機会とブランドインタラクションに関する洞察を提供し、変革的なキャンペーンの構築と戦略的なアクションの実行をサポートします。Treasure Dataは、Treasure Dataからのジョブ結果をBrazeに直接書き込むことができるようにすることで、Brazeプラットフォームをサポートしています。 # この連携でできること - **外部IDのマッピング:** たとえば、CRMシステムのIDをBrazeのユーザーアカウントにマッピングできます。 - **オプトアウト:** エンドユーザーが参加しないことを選択して同意を更新した場合。 - **独自のイベント、購入、またはカスタムプロファイル属性のトラッキングをアップロード**。この情報は、キャンペーンのユーザーエクスペリエンスを向上させる正確な顧客セグメントの構築に役立ちます。 - **ユーザーのサブスクリプショングループステータスの更新**: external_id、email、またはphoneを介してユーザーのサブスクリプション状態(subscribed/unsubscribed)を更新します # 前提条件 - Treasure Dataの基本的な知識 - [Braze](https://www.braze.com/)の基本的な知識 # 制限事項 Braze Export Integrationは、大量のデータの送信をサポートしていません。これは、Braze REST APIの[制限事項](https://www.braze.com/docs/api/api_limits/#rate-limits-by-request-type)によるものです。 # BrazeでRest APIキーを取得する 1. Brazeダッシュボードに移動し、開発コンソールに入ります。 ![](/assets/screen-shot-2021-03-02-at-20.19.43.bd8e8ddaab558bc8d1a01321d0558a017618c426affa7aa153ede2d7c973251f.bcdb7aa7.png) 2. API設定タブに移動し、新しいRest APIキーを作成します。 ![](/assets/image2021-3-3_8-5-23.de3d49d870cd160a5ae262e2eb597be64932315827ae511473991a089693904f.bcdb7aa7.png) # TD Consoleを使用して接続を作成する ## 新しい接続を作成する クエリを実行する前に、Treasure Dataでデータ接続を作成して設定する必要があります。データ接続の一部として、連携にアクセスするための認証情報を提供します。 1. **TD Console**を開きます。 2. **Integrations Hub > Catalog**に移動します。 3. Catalog画面の右端にある検索アイコンを選択し、**Braze**と入力します。 4. Brazeコネクタにカーソルを合わせて、**Create Authentication**を選択します。![](/assets/braze.033d4385f429c845548e4a05b9b554b9216eb7cb9c0a27e018b4b2caad408fef.bcdb7aa7.png) 5. 必要な認証情報を入力します。 ![](/assets/screen-shot-2021-03-02-at-20.27.29.ab4716d80f1cd7a008641dd40d15cb7fa4a8d53694abd3bfa76863c008fbdfac.bcdb7aa7.png) 6. 接続の名前を入力します。 7. **Done**を選択します。 # クエリを定義する 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. 既存の統合認証を選択します。 ![](/assets/image2020-12-18_13-44-6.09e8af43184e33e337bef7c546600eaaa5be9f010b690af1d591c7c2b4bb2df3.c27c97ee.png) 7. 追加のExport Resultsの詳細を定義します。エクスポート統合コンテンツで統合パラメータを確認してください。 たとえば、Export Results画面が異なる場合や、追加の詳細を入力する必要がない場合があります: ![](/assets/image2023-5-17_14-42-52.d2483b20e117c4abf1aaa32c5071595644e4c6b9d987ef4ea4ce4a2038171b85.c27c97ee.png) 8. **Done**を選択します。 9. クエリを実行します。 10. 指定した宛先にデータが移動されたことを確認します。 ## Brazeの統合パラメータ エクスポート結果のパラメータは、画像の後の表に記載されています。 ![](/assets/image2021-3-9_9-20-50.355652941f452a0c60e907505564cd40f6565c0cf89ec2b5ab45a8eeb606a0da.bcdb7aa7.png) | タイトル | パラメータ | 値 | 必須 | 説明 | | --- | --- | --- | --- | --- | | Mode | mode | user_new_alias, user_identifying, user_track, user_delete, user_subscription_group | Yes | コネクタモード | | Track Record Type | track_record_type | custom_events, purchases, user_profile_attributes | No | user_trackモードのレコードタイプ | | Pre-formatted Fields | pre_formatted_fields | String | No | ArrayまたはJSON値を持ち、そのままBrazeに送信するカラムのリストを指定します。このリストにフィールドが指定されている場合、その値はそのまま送信されます。(そうでない場合、値はString値にキャストされます。)このフィールドは、Brazeに複雑な属性を送信する場合や、Braze APIがサポートできる追加の操作を送信する場合などのユースケースで重要です。このパラメータのユースケース例として、「Brazeの特定のユーザーに複数のオーディエンスを追加するための便利なスクリプト」のようなセクションを指定することが挙げられます。 | | Subscription Status | subscription_status | subscribed / unsubscribed | No | | | Skip on invalid records? (User Track Mode) | skip_on_invalid_records | Boolean | No | user_trackモードで表示されます。有効にすると、JSONカラムの失敗レコードを継続して無視します。そうでない場合、ジョブは停止します。 | | Skip on invalid records? (User Subscription Mode) | skip_invalid_records_user_subscription | Boolean | No | user_subscription_groupモードで表示されます。有効にすると、JSONカラムの失敗レコードを継続して無視します。そうでない場合、ジョブは停止します。 | | Send null values (User Track Mode and User Profile Attributes Track Record Type) | send_null_values | Boolean | No | ユーザープロファイル属性を削除するためにnull値を設定する場合に有効にします。external_id、user_alias、braze_id、phone、emailを含む一部のフィールドは、ユーザープロファイルに追加された後は削除できません。 | | Mode | Track Record Type | Columns | | --- | --- | --- | | user_new_alias | | 必須カラム: - external_id - alias_name - alias_label その他のカラムは無視されます。 | | user_identifying | | 必須カラム: - external_id - alias_name - alias_label その他のカラムは無視されます | | user_track | custom_events | 必須カラム: - external_id または (alias_name と alias_label) または braze_id - name, time その他のエイリアスはそのまま送信されます | | user_track | purchases | 必須カラム: - external_id または (alias_name と alias_label) または braze_id - product_id, currency, price, time その他のエイリアスはそのまま送信されます | | user_track | user_profile_attributes | 必須カラム: - external_id または (alias_name と alias_label) または braze_id その他のエイリアスはそのまま送信されます | | user_delete | | 必須カラム: - external_id または (alias_name と alias_label) または braze_id | | user_subscription_group | | 必須カラム: subscription_group_idと - external_id、email、またはphoneの単一カラム - 以下の2つのカラム: - external_id と email - external_id と phone スキーマ内でphoneとemailのカラムを一緒に使用することはできません。 Phoneは[E.164](https://en.wikipedia.org/wiki/E.164)形式のStringである必要があります。 Emailは有効なメール形式のStringである必要があります。 SMS Subscription Group/Phoneは、Brazeのプレミアム機能です。詳細については、Brazeサポートチームにお問い合わせください。 | ## クエリの例 ```SQL SELECT external_id, alias_name, alias_label FROM table create_user_alias ``` ## user_subscription_groupのクエリの例 external_id、email、またはphoneの単一カラムを使用する場合 ```sql SELECT {external_id | email | phone}, subscription_group_id FROM table tbl ``` external_idと{emailまたはphone}の2カラムを使用する場合 ```sql SELECT external_id , {email | phone}, subscription_group_id FROM table tbl ``` ### (オプション) 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 を有効にすることで、クエリの開始時刻を遅延させることができます。 # Workflowでエクスポート結果を設定する(オプション) Treasure Workflow内で、このデータコネクタを使用してデータをエクスポートするように指定できます。 詳細については、[Using Workflows to Export Data with the TD Toolbelt](https://docs.treasuredata.com/smart/project-product-documentation/exporting-data-with-parameters)を参照してください。 ## Mode user_new_alias、user_identifying、user_delete のWorkflow例 ```yaml _export: td: database: td.database +braze_export_task: td>: export_braze.sql database: ${td.database} result_connection: your_authentication_name result_settings: mode: {user_new_alias|user_identifying|user_delete} ``` ## Mode user_track のWorkflow例 ```yaml _export: td: database: td.database +braze_export_task: td>: export_braze.sql database: ${td.database} result_connection: your_authentication_name result_settings: mode: user_track track_record_type: custom_events pre_formatted_fields: array,json skip_on_invalid_records: false ``` ## Mode user_subscription_group のWorkflow例 ```yaml _export: td: database: td.database +braze_export_task: td>: export_braze.sql database: ${td.database} result_connection: your_authentication_name result_settings: mode: user_subscription_group subscription_status: subscribed skip_invalid_records_user_subscription: false ``` # Brazeの特定のユーザーに複数のAudienceを追加するための便利なスクリプト BrazeはユーザーをAudience / Audiencesリストに直接アップロードするAPIをサポートしていません。 Brazeは、特定の条件を満たす属性(カスタム属性を含む)を持つユーザーのみを選択することで、ユーザーをフィルタリング(特定のSegmentに含める)できます。この条件は、特定の値を含むArray Attributeもサポートしています。この機能を使用して、1つのidだけでなく、segment_idの配列を送信し、1人のユーザーを複数のAudienceにマッピングすることができます。 ユーザーがすでに存在している後にオプトイン/オプトアウトしたい場合はどうすればよいでしょうか?直感的には、その配列属性から要素を追加または削除したくなるでしょう。Braze APIはこれらの操作をサポートしています:[API User attributes object](https://www.braze.com/docs/api/objects_filters/user_attributes_object)。 ![](/assets/image-20230613-080557.53878fbfa626a18afbd5e33135c83af87351710c125aae4de51b65f14ea38fc5.bcdb7aa7.png) 必要なのは、このJSONオブジェクトを選択した属性に含めることです。たとえば、以下はその作業を行うcurlスクリプトです。 ```bash curl --location --request POST 'https://rest.iad-03.braze.com/users/track?Authorization=Bearer *****************************' \ --header 'Authorization: Bearer *****************************' \ --header 'Content-Type: application/json' \ --data-raw '{ "attributes": [ { "email": "some_one@mail.com", "_td_segment_id": { "add": {"segment_id_1", "segment_id_2"}, "remove": {"segment_id_old"} } } ] }' ``` TDクエリまたはアクティベーションでは、これを次のように送信できます ```SQL SELECT 'some_one@mail.com' AS "email", '{"add":{"segment_id_1", "segment_id_2"}, "remove": {"segment_id_old"}}' AS "_td_segment_id" FROM user_table; ``` "_td_segment_id"を`Pre-formatted Field`としてマークすることを忘れないでください。