セグメントリストをエクスポートする
/segments/list
このエンドポイントを使用して、セグメントのリストをエクスポートします。各セグメントには、名前、セグメントAPI識別子、分析トラッキングが有効かどうかが含まれます。
セグメントは100件ずつのグループで、作成日時順にソートされて返されます(デフォルトでは古いものから新しいものへ)。アーカイブされたセグメントは含まれません。
このエンドポイントを使用するタイミング
イベントや購入データは、/users/track エンドポイントを使用してBrazeに送信します。セグメントについてそのデータを時系列で確認するには、セグメントで分析トラッキングを有効にする必要があります。このエンドポイントのレスポンスに含まれる analytics_tracking_enabled フィールドは、どのセグメントで分析トラッキングが有効になっているかを示します。
セグメント詳細エクスポートエンドポイントではこの設定は返されないため、APIを通じてこの設定を確認するにはこのエンドポイントを使用します。
このエンドポイントは以下の用途に使用できます。
- 新しいデータを送信する前にトラッキングが有効であることを確認します。Brazeは、トラッキングを有効にする前の収益データや購入データを遡って補完しません。比較する予定のセグメントの
analytics_tracking_enabledがtrueであることを先に確認してください。 - 空のセグメントレポートをトラブルシューティングします。セグメントのセッション、カスタムイベント、または収益レポートが空の場合は、インテグレーションをデバッグする前に
analytics_tracking_enabledがfalseになっていないか確認してください。 - トラッキング対象のセグメント数を数えます。ワークスペースでは最大25個のセグメントでトラッキングを有効にできます。
pageパラメーターを使用してすべてのページを取得し、analytics_tracking_enabledがtrueのセグメント数を数えて、残りの枠数を確認してください。
少数のセグメントを一度だけ確認する場合は、セグメントページで高度なトラッキングセグメントのみフィルターを選択してください。スクリプトやスケジュールされたジョブで確認する必要がある場合は、このエンドポイントを使用してください。
このエンドポイントはトラッキング設定を読み取るだけで、変更は行いません。トラッキングを有効にするには、セグメントのセグメントの詳細セクションに移動し、分析トラッキングを有効にしてください。
このエンドポイントと他のエンドポイントを組み合わせる
以下のエンドポイントは、ユーザートラッキングワークフローの残りの部分をカバーします。セグメント関連のエンドポイントでは、このエンドポイントのレスポンスに含まれる id を segment_id として使用してください。
| エンドポイント | ユーザートラッキングワークフローでの役割 |
|---|---|
/users/track エンドポイント |
トラッキング対象のセグメントがレポートするカスタムイベント、購入、属性の更新を記録します。 |
| セグメント詳細エクスポートエンドポイント | 指定した segment_id のセグメントのフィルター説明とタグを取得します。 |
| セグメント分析エクスポートエンドポイント | セグメントの推定サイズを時系列で取得します。 |
/users/export/segment エンドポイント |
セグメント内のユーザープロファイルをエクスポートし、送信した属性、カスタムイベント、購入がプロファイルに反映されていることを確認できます。 |

OpenAPIドキュメントをダウンロードして、スキーマの検証に使用できます。方法については、リクエストの検証にOpenAPIスキーマを使用するを参照してください。