Skip to main content
MoEngage Segments API を使用すると、オーディエンスセグメントを管理できます。このスイートには、大量のファイルベースのセグメントとセグメントのライフサイクルを処理する v2 API、動的なフィルターベースのセグメント用の v3 API、外部のオーディエンスを MoEngage と直接同期する Cohort Sync API が含まれています。

​
エンドポイント

Segments API は、次のエンドポイントで構成されています。

​
File Segments (v2)

File Segments API を使用すると、URL でホストされている CSV ファイルからユーザーをインポートして、セグメントを作成および管理できます。
  • Create File Segment: CSV ファイルの URL から新しいファイルセグメントを作成します。
  • Add Users to File Segment: CSV ファイルのユーザーリストを既存のファイルセグメントに追加します。
  • Remove Users from File Segment: CSV ファイルのユーザーリストを既存のファイルセグメントから削除します。
  • Replace Users in File Segment: 既存のファイルセグメント内のすべてのユーザーを、CSV ファイルの新しいユーザーリストに置き換えます。
ファイルセグメントに含める前に、すべてのユーザーが MoEngage にインポートされていることを確認してください。正常にマッピングできるのは既存のプロファイルのみです。30 日を超えてアーカイブされているファイルセグメントでは、ユーザーが完全に削除されます。削除されたデータは復元できません。

​
Manage Segments (v2)

Manage Segments API を使用すると、セグメントをアーカイブまたはアーカイブ解除して、セグメントのライフサイクルを制御できます。
  • Archive Segment: 既存のセグメント (File または Filter) をアーカイブします。
  • Unarchive Segment: 既存のセグメントのアーカイブを解除し、再びアクティブにします。

​
Filter Segments (v3)

Filter Segments API を使用すると、ユーザー属性と行動フィルター条件に基づいて動的なセグメントを作成および管理できます。
  • List Segments: すべてのフィルターセグメントを一覧表示します。
  • Create Filter Segment: 一連のフィルター条件に基づいて新しいフィルターセグメントを作成します。
  • Get Segment by ID: ID で特定のセグメント (File または Filter) を取得します。
  • Update Filter Segment: ID で既存のフィルターセグメントを更新します。

​
Cohort Sync

Cohort Sync API を使用すると、独自のエコシステムで作成したコホートやオーディエンスを MoEngage と直接同期できます。このサーバー間連携により、カスタムセグメントにユーザーを動的に追加または削除でき、マーケティングキャンペーンが常に最も関連性の高いオーディエンスをターゲットにできるようになります。
  • セグメントの自動作成: カスタムセグメントがまだ存在しない場合は、MoEngage に自動的に作成します。
  • 動的なメンバーシップ: セグメントがリアルタイムで更新されるため、スケジュール済みキャンペーンで最新のユーザーセットにエンゲージできます。
  • ミドルウェア不要: サーバー間で直接呼び出すため、CSV の手動アップロードや外部 URL のホスティングが不要です。
  • 効率性の向上: 少数のユーザーを対象とするセグメント操作に最適です。
エンドポイント:
  • Sync Cohort Members: カスタムセグメントにユーザーを追加または削除します。
これらの API エンドポイントは、現在チームレベルのスコープをサポートしていません。これらの呼び出しで生成されたすべてのセグメントは、自動的に Default Team に割り当てられます。

​
よくある質問

​
フィルターベースのセグメント

ペイロードは MoEngage ダッシュボードから直接生成できます。Test & Debug -> Segment Payload に移動し、フィルターを選択して Generate Payload をクリックします。
name クエリパラメーターを指定して List Segment API を使用し、目的のセグメントの一意の ID をフィルタリングして取得します。
セグメントの名前と定義 (フィルター) の両方が一意である必要があります。定義が既存のセグメントと一致する場合、API は 409 Conflict を返します。
409 エラーの場合、レスポンスペイロードに競合しているセグメントの existing_cs_name と existing_cs_id が含まれます。
アカウントマネージャーにお問い合わせください。

​
ファイルベースのセグメント

セグメントの処理は非同期で行われます。MoEngage はまずセグメントのコンテナーを作成し (ユーザー数は 0 と表示されます)、その後ファイルを処理します。処理が完了すると、ユーザー数が更新されます。
いいえ。固定の処理タイムアウトはありません。MoEngage は、処理が正常に完了するかエラーが発生するまでファイルを処理し、その後結果を callback_url に送信します。
最初のファイルのダウンロードに失敗した場合、MoEngage はコールバックで失敗を報告する前に自動的に再試行します。コールバックのペイロードには、失敗の内容を説明する error_message フィールドが含まれます。
いいえ。ファイルセグメントは、CSV インポートを使用した File Segment API によってのみ更新 (追加/削除/置換) できます。属性ベースの更新には、Filter Segments を使用してください。

​
セグメントの管理

アーカイブすると、アクティブなセグメントリストを 1000 セグメントの上限内に保ちながら、セグメントを一から作り直すことなく A/B テストや履歴分析に再利用できます。

​
Cohort Sync

Cohort Sync API では、個別のファイルや CSV を必要とせずにセグメントを作成できるため、File Segment API のように個別のパスや URL を用意する必要がありません。サーバー間で直接呼び出すことでセグメントの作成を開始できるため、ユーザーファイルの生成に必要な追加の手順が不要になります。
Cohort Sync API は、少数のユーザーを対象とするセグメントやセグメント操作に最適です。
Cohort Sync API は MoEngage に新しいユーザーを作成しません。代わりに、事前に定義されたユーザー識別子に基づいて MoEngage 内の既存のユーザーを解決し、Cohort Sync で作成された対応するカスタムセグメントに割り当てます。

​
Postman コレクション

Postman で次の Postman コレクションをインポートして、これらのエンドポイントをすばやくテストできます: File Segments、Filter Segments、Cohort Sync。