Skip to content

カスタムCurrentsエクスポート

カスタムCurrentsコネクターを統合して、Brazeからリアルタイムでイベントデータを取得し、よりカスタマイズされた分析、レポート、オートメーションを実現する方法を説明します。

前提条件

Brazeでカスタム Currents コネクターを連携するには、エンドポイントURLとオプションの認証トークンを提供する必要があります。

また、Brazeに複数のアプリグループがある場合は、グループごとにカスタム Currents コネクターを設定する必要があります。ただし、すべてのアプリグループを同じエンドポイント、または your_app_group_key="Brand A" のような追加の GET パラメーターを持つエンドポイントに向けることができます。

連携

ステップ1：エンドポイントを設定する

この連携を設定するには、エンドポイントURLが必要です。エンドポイントはHTTP POSTリクエストを受信でき、イベントの受信が成功したことを示す2XXステータスコードを返す必要があります。Brazeからのリクエストを認証する場合は、ベアラートークンも必要です。

ステップ2：Braze Currentsを設定する

Brazeでパートナー連携 > データエクスポートに移動し、新しいCurrentを作成をクリックして、カスタムCurrentsエクスポートを選択します。

エクスポートに名前と連絡先メールアドレスを入力し、Currentの詳細ページに進みます。このページで、エンドポイントURLとオプションのベアラートークンを入力します。

認証情報を設定したら、エクスポートしたいメッセージエンゲージメント、顧客行動、およびユーザーイベントをすべてチェックし、Currentを起動をクリックします。

サポートされているCurrentsイベント

Brazeは、カスタムHTTPコネクターに以下のデータをエクスポートすることをサポートしています。

各イベントのペイロード構造については、イベント用語集のカスタムHTTPコネクタータブを選択してください。

データ損失の防止

エラー監視

データ損失やサービス中断を防ぐために、エンドポイントを常に監視し、エラーやダウンタイムが発生した場合は速やかに対処することが不可欠です。

ほとんどのエラータイプ（サーバーエラーやネットワーク接続エラーなど）に対して、Brazeはイベント送信を自動的にリトライします。問題が5日以上続く場合、連携は自動的に無効化されます。新しい受信イベントはドロップされ、永久に失われます。

変更への耐性

Braze Currentsのスキーマに対して、破壊的でない変更を行う場合があります。破壊的でない変更とは、新しいnullable列やイベントタイプの追加です。

通常、これらの変更については2週間前に通知しますが、それが難しい場合もあります。認識できないフィールドやイベントタイプを適切に処理できるよう連携を設計することが不可欠です。そうしないと、データ損失につながる可能性があります。

バッチ処理とシリアライゼーション

ターゲットデータ形式はHTTPS経由のJSONです。デフォルトでは、イベントは最大100件ずつのバッチでエンドポイントに送信されます。

イベントは、以下の形式ですべてのイベントのJSON配列としてエンドポイントに送信されます。

1

{"events": [event1, event2, event3, etc...]}

"events"というキーを持つトップレベルのJSONオブジェクトがあり、これはさらなるJSONオブジェクトの配列にマッピングされます。各JSONオブジェクトは単一のイベントを表します。各イベントには2つのサブオブジェクトが含まれます。

ダウンストリームエンドポイントがイベント数がゼロのペイロードまたは空のリクエストボディを受信した場合、その結果はノーオペレーション（no-op）とみなされるべきです。つまり、この呼び出しによってダウンストリームへの影響は発生しないということです。ただし、（通常のAPI呼び出しと同様に）Authorizationヘッダーを確認し、401や403など、無効な認証情報に対して適切なHTTPレスポンスを返す必要があります。これにより、Brazeはコネクターの認証情報が有効であることを確認できます。

認証

ペイロード内の認証トークンはオプションです。RFC 6750 に規定されている Bearer 認可スキームを使用して、HTTP Authorization ヘッダーを通じて渡すことができます。オプションではありますが、認証トークンが渡された場合、Brazeはペイロードにイベントが含まれていなくても、常にまずそのトークンを検証します。

RFC 6750 に基づき、トークンは1文字以上のBase64エンコード値である必要があります。RFC 6750 では、通常のBase64文字に加えて -、.、_、~ の文字もトークンに含めることができます。これらの文字をトークンに含めるかどうかは自由に選択できます—ただし、Base64形式である必要があります。

また、Authorization ヘッダーが存在する場合、以下の形式で構成されます。

1

"Authorization: Bearer " + <token>

たとえば、認証トークンが 0p3n5354m3== の場合、Authorization ヘッダーは以下のようになります。

1

Authorization: Bearer 0p3n5354m3==

バージョニング

HTTP コネクター連携からのすべてのリクエストは、Currents リクエストのバージョンを示すカスタムヘッダーとともに送信されます。

1

Braze-Currents-Version: 1

バージョンは常に 1 です。この番号を増やすことはほとんど、あるいはまったくないと想定しています。

データウェアハウスストレージスキーマと同様に、個々のイベント内のすべてのイベントフィールドは、Apache Avro の後方互換性の定義に従い、以前のイベントペイロードバージョンとの後方互換性が保証されています。

  1. 特定のイベントフィールドは、常に同じデータ型を維持することが保証されています。
  2. ペイロードに追加される新しいフィールドは、すべての関係者によってオプションとみなされる必要があります。
  3. 必須フィールドが削除されることはありません。

エラーハンドリングとリトライメカニズム

エラーが発生した場合、Brazeは受信したHTTPリターンコードに基づいてリクエストをキューに入れ、リトライします。問題が5日以上続くと、連携は自動的に無効化されます。新しい受信イベントはドロップされ、永久に失われます。すでにキューに入っているイベントは7日間保持された後、永久にドロップされます。データが24時間以上停滞している場合、オンコールエンジニアに自動的にアラートが送信されます。各ステータスコードの処理方法の詳細については、次のセクションの表を参照してください。

Currents連携が認証エラーを返している場合、Brazeは自動的に通知メールを送信します。

次のセクションに記載されていないHTTPエラーコードは、HTTP 5XX エラーとして扱われます。

以下のHTTPステータスコードがコネクタークライアントによって認識されます。
New Stuff!