変換の作成

Braze Data Transformation を使用すると、Webhook 連携の構築および管理を行って、外部プラットフォームから Braze へのデータフローを自動化できます。これらの Webhook 連携により、さらに洗練されたマーケティングユースケースを強化できます。データ変換によって、デフォルトのコードからデータ変換を構築したり、専用のテンプレートライブラリを用いて特定の外部プラットフォームの使用を開始したりできます。

前提条件

ステップ 1: ソースプラットフォームの特定

Braze に接続する外部プラットフォームを特定し、プラットフォームが Webhook に対応しているか確認します。これらの設定は、”API通知 “や “Webサービスリクエスト “と呼ばれることもある。

以下に Typeform webhook の例を示します。これは、Typeform のプラットフォームにログインすることで設定できます。

ステップ 2: 変換の作成

Brazeダッシュボードで、データ設定>データ変換に進む。

トランスフォームの作成」を選択してトランスフォームに名前を付け、編集エクスペリエンスを選択する。

変形の詳細は、編集体験のために「テンプレートを使用する」または「ゼロから始める」を選択するオプションがある。

データ変換のユースケースを含むテンプレート・ライブラリを参照するには、Use a templateを選択する。または、”Start from scratch “を選択してデフォルトのコードテンプレートを読み込む。

ゼロから始めるのであれば、変身のための送信先を選ぶ。テンプレート・ライブラリーからコード・テンプレートを挿入することはできる。

トランスフォームを作成すると、トランスフォームの詳細ビューが表示される。ここでは、Webhook Detailsの下に、このトランスフォーメーションに対して受信した最新のWebhookを表示することができ、Transformation codeの下に、トランスフォーメーションコードを書き込むスペースがある。

ステップ 3: テスト Webhook の送信 (推奨)

このステップは任意ですが、新規に作成した変換にソースプラットフォームからテスト Webhook を送信することをお勧めします。

1. URL を変換からコピーします。
2. ソースプラットフォームで、この URL に送信するサンプル Webhook を生成する「テスト送信」機能を見つけます。
   • ソースプラットフォームにリクエストタイプを求められた場合は、「POST」を選択します。
   • ソースプラットフォームに認証オプションがある場合は、「認証なし」を選択します。
   • ソースプラットフォームにシークレットを求められた場合は、「シークレットなし」を選択します。
3. Brazeダッシュボードでページを更新し、Webhookが受信されたか確認する。受信した場合は、「Most recent webhook」の下にWebhookペイロードが表示されるはずだ。

Typeform の場合は以下のようになります。

ステップ 4: 変換コードの記述

JavaScript コードを扱ったことがほとんどないか、より詳しい手順を希望する場合は、変換コードを記述するときに、「初心者 - POST: ユーザーの追跡」または「初心者 - PUT:複数のカタログ項目を更新する 変換コードを書くためのタブ。

開発者であるか、JavaScript コードの経験が豊富な場合は、「上級 - POST: ユーザーの追跡」タブで、変換コードを記述するための大まかな手順を確認できます。

• 初心者 - トラックユーザー
• 初心者 - カタログ項目を更新する
• 詳細 - ユーザーをトラッキングする

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// Here, we will define a variable, "brazecall", to build up a `/users/track` request
// Everything from the incoming webhook is accessible via the special variable "payload"
// So you can template in desired values in your `/users/track` request with dot notation, such as payload.x.y.z

let brazecall = {
  "attributes": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "attribute_1": payload.attribute_1
    }
  ],
  "events": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "name": payload.event_1,
      "time": new Date(),
      "properties": {
        "property_1": payload.event_1.property_1
      }
    }
  ],
  "purchases": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "product_id": payload.product_id,
      "currency": payload.currency,
      "price": payload.price,
      "quantity": payload.quantity,
      "time": payload.timestamp,
      "properties": {
        "property_1": payload.purchase_1.property_1
      }
    }
  ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// This is a default template that you can use as a starting point
// Feel free to delete this entirely to start from scratch, or to edit specific components

// First, this code defines a variable, "brazecall", to build a PUT /catalogs/{catalog_name}/items request
// Everything from the incoming webhook is accessible via the special variable "payload"
// As such, you can template in desired values in your request with JS dot notation, such as payload.x.y.z

let brazecall = {
  // For Braze Data Transformation to update Catalog items, the special variable "catalog_name" is required
  // This variable is used to specify the catalog name which would otherwise go in the request URL
  "catalog_name": "catalog_name",
  
  // After defining "catalog name", construct the Update Multiple Catalog Items request as usual below
  // Documentation for the destination endpoint: https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/asynchronous/put_update_catalog_items/
  "items": [
    {
      "id": payload.item_id_1,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    },
    {
      "id": payload.item_id_2,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    },
    {
      "id": payload.item_id_3,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    }
  ]
};

// After the request body is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

ステップ 5: 変換の監視

トランスフォーメーションを有効化したら、トランスフォーメーションのメインページにある分析でパフォーマンスの概要を確認しよう。

• 受信リクエスト:この変換の URL で受信した Webhook の数です。受信リクエストが 0 の場合、ソースプラットフォームが Webhook を送信していないか、接続を確立できません。
• 配信数:受信リクエストをを受け取った後、Data Transformation は変換コードを適用して、選択されている Braze の宛先に送信します。

配信に至る受信リクエストが 100% になることは、良い目標です。配信数が受信リクエスト数を超えることはありません。

トラブルシューティング

より詳細なモニタリングとトラブルシューティングについては、「ログ」ページで特定のログを参照する。このページには、ワークスペース全体のすべてのトランスフォームに対する直近1,000件の受信リクエストが記録されている。それぞれのログを選択して、リクエスト本文、トランスフォーム出力、トランスフォーム送信先からのレスポンシブ本文を見ることができる。

配信がない場合は、変換コードに構文エラーがないかチェックし、コードがコンパイルされることを確認する。次に、出力が有効な宛先リクエストであるかどうかを確認します。

受信リクエスト数より少ない配信数は、少なくともいくつかのWebhookが正常に配信されていることを示す。エラー例については変換ログを参照し、変換出力が意図どおりかを確認します。変換コードが、受信した Webhook の個々のバリエーションに対応していない可能性があります。