このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。

カスタムHTTPコネクター

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

重要

The Custom HTTP Connector 現在はベータ版である。ベータ版への参加に興味がある場合は、Brazeのアカウント・マネージャーに連絡を。

前提条件

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

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

統合

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

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

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

Brazeで、パートナー連携 > データのエクスポートに移動し、Create New Currentをクリックして、Custom Currents Exportを選択します。

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

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

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

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

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

データ損失の防止

エラー監視

データ損失やサービス中断を避けるために、エンドポイントを常に監視し、エラーやダウンタイムに迅速に対処することが不可欠です。

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

変更への耐性

Braze Currentsのスキーマに対して、非破壊的な変更を行うことがあります。非破壊的な変更とは、新しいnull許容カラムやイベントタイプの追加です。

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

ヒント

Currentsイベントスキーマの完全なリストについては、メッセージエンゲージメントイベントと顧客行動イベントを参照してください。

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

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

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

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

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

名前説明

"user" user_id、external_user_id、device_id、timezoneなどのユーザープロパティを含みます。

"properties" 適用されるapp/campaign/canvas/platformなど、イベントの属性を含みます。

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

認証

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

RFC 6750に従い、トークンは少なくとも1文字のBase64エンコードされた値である必要があります。RFC 6750では、通常のBase64文字に加えて、-、.、_、~の文字をトークンに含めることが許可されています。これらの文字をトークンに含めるかどうかは選択できますが、Base64形式である必要があります。

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

"Authorization: Bearer " + <token>

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

Authorization: Bearer 0p3n5354m3==

注

将来的に、Brazeに固有のカスタムキーバリューペア認可スキームを実装するためにAuthorizationヘッダーを使用する可能性があります。これはRFC 7235仕様に準拠するもので、Amazon Web Services（AWS）などの企業が認証スキームを実装する方法と同様です。

バージョニング

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

Braze-Currents-Version: 1

バージョンは常に1であり、この番号を頻繁にインクリメントすることは想定していません。

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

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

エラー処理とリトライメカニズム

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

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

以下にリストされていないHTTPエラーコードは、HTTP 5XXエラーとして扱われます。

警告

問題が5日以上続く場合、統合は無効化されます。新しい受信イベントはドロップされ永久に失われ、すでにキューに入っているイベントは7日間保持された後に永久にドロップされます。

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

ステータスコード応答説明

2XX 成功イベントデータは再送信されません。

5XX サーバー側エラーイベントデータはジッター付きのエクスポネンシャルバックオフパターンで再送信されます。問題が5日以上続く場合、統合は無効化され、すでにキューに入っているイベントは7日間保持されます。

400 クライアント側エラーコネクターが少なくとも1つの不正なイベントを送信しました。イベントデータはサイズ1のバッチに分割されて再送信されます。これらのサイズ1のバッチで再度400レスポンスを受信したイベントは永久にドロップされます。

401 未認証コネクターが無効な認証情報で設定されています。失敗したイベントは再送信されません。認証情報を修正し、統合を再度有効にして再開してください。問題が5日以上続く場合、統合は無効化され、すでにキューに入っているイベントは7日間保持されます。

403 禁止コネクターが無効な認証情報で設定されています。失敗したイベントは再送信されません。認証情報を修正し、統合を再度有効にして再開してください。問題が5日以上続く場合、統合は無効化され、すでにキューに入っているイベントは7日間保持されます。

404 見つかりませんコネクターが不正なエンドポイントURLまたは無効な認証情報で設定されています。エンドポイントURLが正しく、到達可能であることを確認してください。設定を修正し、統合を再度有効にして再開してください。問題が5日以上続く場合、統合は無効化され、すでにキューに入っているイベントは7日間保持されます。

413 ペイロードが大きすぎますイベントデータはより小さなバッチに分割されて再送信されます。

429 リクエストが多すぎますレート制限を示します。イベントデータはジッター付きのエクスポネンシャルバックオフパターンで再送信されます。問題が5日以上続く場合、統合は無効化され、すでにキューに入っているイベントは7日間保持されます。

New Stuff!