Skip to main content
MoEngage Business Events API(V5)を使用すると、フライトの遅延、ウォッチ中のアイテムの値下げ、OTT シリーズの新エピソード公開など、ワークスペースに登録済みのビジネスイベントを発火できます。イベントを発火すると、それに関連付けられたすべてのアクティブなキャンペーンとフローが配信キューに追加されるため、ユーザー行動だけでなく外部のデータポイントに基づいた、文脈に即したコミュニケーションを自動化できます。V5 エンドポイントでは、ワークスペースに存在するビジネスイベントを参照することもできます。 これらのエンドポイントは、統合された MoEngage ゲートウェイを通じて、バージョン管理された {response_id, type, data} エンベロープで提供されます。新しいビジネスイベントを作成するには、Business Events(レガシー) API を使用してください。この操作はまだ V5 に移行されていません。

​
エンドポイント

Business Events API(V5)は、以下のエンドポイントで構成されています。
  • Trigger Business Event (V5): 登録済みのビジネスイベントを発火し、関連付けられたキャンペーンとフローをキューに追加します。
  • List Business Events: ワークスペース内のすべてのビジネスイベントを一覧表示するか、名前または ID で 1 つを参照します。キャンペーン数とトリガー数を返し、カーソルベースのページネーションをサポートします。
  • Search Business Events (V5): すべてのビジネスイベントを一覧表示するか、名前または ID で複数のイベントを一度に参照します。List Business Events と同じフィールドを返し、カーソルベースのページネーションをサポートします。

​
認証

認証は Basic 認証で行います。認証には、username:password の形式で認証情報を Base64 エンコードした文字列が必要です。
  • Username: MoEngage の Workspace ID（App ID とも呼ばれます）を使用します。MoEngage ダッシュボードの Settings > Account > API keys で確認できます。
  • Password: Settings > Account > API keys の API キーを使用します。
API キーの作成と管理の詳細については、API Key Dashboard を参照してください。

​
よくある質問

​
ビジネスイベントのトリガー

いいえ。ビジネスイベントに定義されたすべての属性を送信する必要はありません。キャンペーンとフローで使用するパーソナライズに必要な属性のみを含めてください。
イベント名は、ワークスペースに登録されているイベントと照合して検証されます。トリガーする前に、event_name が Create Business Event API で作成済みのイベントと一致していることを確認してください。
triggered_status はトリガーの結果をまとめたものです。SUCCESS(関連付けられたすべてのキャンペーンまたはフローが予約された)、PARTIAL_SUCCESS(少なくとも 1 つが予約され、少なくとも 1 つがクォータによりスキップされた)、FAILURE(何も予約されなかった。すべてがクォータによりスキップされたか、イベントにアクティブなキャンペーンやフローが関連付けられていない)のいずれかです。
レスポンスの data オブジェクト内の triggered_campaign_ids と triggered_flow_ids を確認してください。これらには、今回の発火で予約された ID が一覧表示されます。failed_campaign_ids と failed_flow_ids には、クォータによりスキップされたものが一覧表示されます。
MoEngage ダッシュボードで Engage -> Campaigns に移動し、ビジネスイベントに関連付けられたキャンペーンを検索すると、リアルタイムの分析とトリガー数を確認できます。

​
ビジネスイベントの参照

すべてを閲覧する場合や、クエリパラメータとして渡した正確な name または id で 1 つのイベントを参照する場合は、List Business Events を使用してください。filters.names と filters.ids は配列を受け付けるため、複数のイベントを一度に参照する場合は Search Business Events (V5) を使用してください。どちらも同じフィールドを返し、フィルターを指定しない場合はすべてを一覧表示します。
いいえ。filters.names または filters.ids のいずれか一方を指定し、両方は指定しないでください。両方を指定すると 400 エラーが返されます。List Business Events の name および id クエリパラメータにも同じルールが適用されます。
どちらのエンドポイントも、1 ページあたり最大 20 件のイベントを返します。pagination.has_more が true の場合は、pagination.next_cursor を cursor として渡して次のページを取得します。カーソルは不透明な値として扱い、デコードや変更は行わないでください。
V5 エンドポイントは、属性の型を string、number、boolean、datetime として返します。レガシーの Create Business Event API は、string、int、float、array、date を受け付けます。連携を V5 に移行する際は、両者の対応付けを行ってください。
trigger_count は、イベントがトリガーされた合計回数です。campaign_count は、すべての発火を通じてそれらのトリガーによって開始された子キャンペーンの累計数です。

​
Postman コレクション

事前設定済みの Postman コレクションを使用して、これらのエンドポイントをテストできます: MoEngage Business Events コレクションを表示。