セグメントリストをエクスポートする
/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 エンドポイント |
セグメント内のユーザープロファイルをエクスポートし、送信した属性、カスタムイベント、購入がプロファイルに反映されていることを確認できます。 |
Endpoint reference
This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/ja/assets/api/openapi/export_segments_get_segment.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.