イベント・オブジェクト
この記事では、イベント・オブジェクトのさまざまな構成要素、このオブジェクトの使用方法、そして使用例について説明する。
イベントオブジェクトとは何か?
イベント・オブジェクトは、特定のイベントが発生したときにAPIを通じて渡されるオブジェクトである。イベント・オブジェクトはイベント配列に格納される。events配列の各イベントオブジェクトは、指定された時間値における、特定のユーザーによるカスタムイベントの単一の発生を表す。イベント・オブジェクトにはさまざまなフィールドがあり、それらを使用して、メッセージ、データ収集、パーソナライゼーションにおいてイベントプロパティを設定し、使用することでカスタマイズすることができます。
特定のプラットフォームにカスタムイベントを設定する方法は、開発者ガイドのプラットフォーム・インテグレーション・ガイドを参照して確認することができる。この情報は、各プラットフォームのアナリティクス・タブにある「カスタムイベントのトラッキング」ページで確認できる。いくつかリンクを貼っておく。
カスタムイベント記事の追跡:
オブジェクト本体
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
// One of "external_id" or "user_alias" or "braze_id" or "email" or "phone" is required
"external_id" : (optional, string) External user ID,
"user_alias" : (optional, User Alias Object) User alias object,
"braze_id" : (optional, string) Braze user identifier,
"email": (optional, string) User email address,
"phone": (optional, string) User phone number,
"app_id" : (optional, string) see App Identifier,
"name" : (required, string) the name of the event,
"time" : (required, datetime as string in ISO 8601 or in `yyyy-MM-dd'T'HH:mm:ss:SSSZ` format),
"properties" : (optional, Properties Object) properties of the event
// Setting this flag to true will put the API in "Update Only" mode.
// When using a "user_alias", "Update Only" mode is always true.
"_update_existing_only" : (optional, boolean)
// See following notes regarding anonymous push token imports
}
既存のプロファイルのみを更新する
Braze で既存のユーザープロファイルのみを更新したい場合は、リクエスト本文の中で、_update_existing_only
キーと true
の値を渡す必要があります。この値を省略すると、external_id
がまだ存在しない場合、Brazeは新しいユーザープロファイルを作成する。
/users/track
エンドポイントを通じてエイリアスのみのユーザープロファイルを作成する場合、_update_existing_only
は false
に設定しなければなりません。この値が省略された場合、エイリアスのみのプロファイルは作成されない。
イベント・プロパティ・オブジェクト
カスタムイベントと購入にはイベントプロパティが含まれる場合があります。「プロパティ」値は、キーがプロパティ名で値がプロパティ値であるオブジェクトである必要があります。プロパティ名は、255文字以下の空でない文字列でなければならず、先頭にドル記号($)は付けない。
プロパティ値は、次のデータ型のいずれでもかまいません。
データ型 | 説明 |
---|---|
数値 | 整数または浮動小数点数のいずれかとして |
ブール値 | true または false |
日時 | ISO-8601 または yyyy-MM-dd'T'HH:mm:ss:SSSZ 形式の文字列。配列内ではサポートされていません。 |
文字列 | 255 文字以下。 |
配列 | 配列には日付時刻を含めることはできません。 |
オブジェクト | オブジェクトは文字列として取り込まれます。 |
配列またはオブジェクト値を含むイベントプロパティオブジェクトには、最大 50 KB のイベントプロパティペイロードを設定できます。
イベント・プロパティの永続性
イベント・プロパティは、親イベントによってトリガーされるメッセージのフィルタリングと、リキッド・パーソナライゼーションのために設計されている。デフォルトでは、Braze ユーザープロファイルでは永続化されません。セグメンテーションでイベントプロパティ値を使用するには、イベントプロパティ値を長期的に保存するための様々なアプローチについて詳述しているカスタムイベントを参照のこと。
イベント依頼例
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
POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"events" : [
{
"external_id" : "user1",
"app_id" : "your-app-id",
"name" : "watched_trailer",
"time" : "2013-07-16T19:20:30+01:00"
},
{
"external_id" : "user1",
"app_id" : "your-app-id",
"name" : "rented_movie",
"time" : "2013-07-16T19:20:45+01:00",
"properties": {
"movie": "The Sad Egg",
"director": "Dan Alexander"
}
},
{
"user_alias" : { "alias_name" : "device123", "alias_label" : "my_device_identifier"},
"app_id" : "your-app-id",
"name" : "watched_trailer",
"time" : "2013-07-16T19:20:50+01:00"
}
]
}
イベント・オブジェクト
提供された例を使えば、誰かが最近予告編を見て、映画をレンタルしたことがわかる。キャンペーンに入り、これらのプロパティに基づいてユーザーをセグメントすることはできませんが、Liquid を使用してチャネルを介し、カスタムメッセージを送信するために、受け取りの形でこれらのプロパティを使用することで、戦略的に使用することができます。例えば、『こんにちは、Beth。Dan Alexander の The Sad Egg をレンタルしていただき、ありがとうございます。お客様のレンタル状況に基づいて、お勧めの映画をご紹介いたします…』のように使用できます。