このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、 GitHubでイシューを作成してください.
エクスポートエンドポイント
このエンドポイントコレクションを使用すると、KPI、アプリセッション、ユーザー、Segments、Campaigns、Canvasesに関するさまざまなレベルの詳細にアクセスしてエクスポートできます。パラメーターとリクエストボディを作成する際には、Brazeインスタンス、APIキー、およびAPI識別子を確認してください。
前提条件
開始する前に、以下を準備してください。
| 要件 | 説明 |
|---|---|
| Braze REST APIキー | 呼び出す予定のエンドポイントに対する適切なエクスポート権限を持つREST APIキー。APIキーは特定のエンドポイントにスコープされ、作成後に権限を変更することはできません。詳細については、REST APIキーを参照してください。 |
| 関連する識別子 | エクスポートしたいデータの識別子(Campaign ID、Segment ID、Canvas IDなど)。これらはBrazeダッシュボードで確認できます。完全なリストについては、API識別子タイプを参照してください。 |
| クラウドストレージの認証情報(オプション) | 大規模なデータセットをエクスポートする場合は、Amazon S3、Microsoft Azure Blob Storage、またはGoogle Cloud Storageバケットを接続して、エクスポートファイルをストレージに直接書き込むことができます。 |
注
APIアクセス権を持たないマーケターやチームメンバーの場合は、組織内の開発者または管理者と連携してAPIキーと統合を設定してください。
エクスポートできるデータ
以下の表は、エクスポートAPIで利用可能なデータカテゴリをまとめたものです。
| カテゴリ | 含まれるデータ | APIリファレンス |
|---|---|---|
| Campaigns | パフォーマンス分析、Campaignの詳細、Campaignリスト、送信分析 | Campaignエンドポイント |
| Canvases | データシリーズ分析、分析サマリー、Canvasの詳細、Canvasリスト | Canvasエンドポイント |
| Segments | Segmentリスト、Segment分析、Segmentの詳細 | Segmentエンドポイント |
| ユーザーデータ | 識別子またはSegment別の完全なユーザープロファイル、グローバルコントロールグループ別のユーザー | ユーザーデータエンドポイント |
| KPI | デイリーアクティブユーザー、月間アクティブユーザー、日次新規ユーザー、日付別アンインストール | KPIエンドポイント |
| セッション | アプリセッションの時系列データ | セッションエンドポイント |
| カスタムイベント | イベント名、イベントリスト、時系列のイベント分析 | カスタムイベントエンドポイント |
| カスタム属性 | 属性名 | カスタム属性エンドポイント |
| 購入 | 時間別収益データ、製品IDリスト、購入数 | 購入エンドポイント |
エクスポートデータの配信方法
APIエクスポートは、ダッシュボードからダウンロードするCSVファイルとは異なり、JSON形式でデータを返します。配信方法は、クラウドストレージが接続されているかどうかによって異なります。
- クラウドストレージなしの場合: BrazeはエクスポートファイルをBraze独自のS3バケットに書き込み、APIレスポンスに一時的なダウンロードURLを含めます。このURLは4時間後に期限切れになり、エクスポートはJSONファイルを含む圧縮アーカイブ(
output_formatパラメーターに応じてZIPまたはGZIP)としてパッケージされます。JSONファイルの各行は1つのデータオブジェクトを表します。 - クラウドストレージ接続済みの場合: Brazeはエクスポートファイルを設定済みのバケットに直接書き込みます。APIレスポンスにはダウンロードURLは含まれません。ファイルは独自の保持ポリシーに従い、大規模なエクスポートではより信頼性が高くなります。
ヒント
「クラウドストレージ」とは、お客様独自のストレージバケット(Amazon S3、Microsoft Azure Blob Storage、Google Cloud Storageなど)を指します。パートナー連携 > テクノロジーパートナーでバケットを接続すると、Brazeがエクスポートファイルを直接書き込めるようになります。
エクスポートの配信とトラブルシューティングの詳細については、エクスポートのトラブルシューティングを参照してください。
エクスポートエンドポイント一覧
以下の表は、利用可能なすべてのエクスポートAPIを一覧にしたものです。
| カテゴリ | メソッド | エンドポイント |
|---|---|---|
| Campaigns | GET | Campaign分析 |
| Campaigns | GET | Campaignの詳細 |
| Campaigns | GET | Campaignリスト |
| Campaigns | GET | 送信分析 |
| Canvases | GET | Canvasデータシリーズ分析 |
| Canvases | GET | Canvas分析サマリー |
| Canvases | GET | Canvasの詳細 |
| Canvases | GET | Canvasリスト |
| カスタムイベント | GET | カスタムイベント |
| カスタムイベント | GET | カスタムイベントリスト |
| カスタムイベント | GET | カスタムイベント分析 |
| カスタム属性 | GET | カスタム属性 |
| KPI | GET | 日付別の日次新規ユーザーKPI |
| KPI | GET | 日付別のデイリーアクティブユーザーKPI |
| KPI | GET | 過去30日間の月間アクティブユーザーKPI |
| KPI | GET | 日付別のアンインストールKPI |
| 購入 | GET | 製品IDリスト |
| 購入 | GET | 購入数 |
| 購入 | GET | 時間別収益データ |
| Segments | GET | Segmentリスト |
| Segments | GET | Segment分析 |
| Segments | GET | Segmentの詳細 |
| セッション | GET | アプリセッションの時系列データ |
| ユーザーデータ | POST | 識別子によるユーザーデータ |
| ユーザーデータ | POST | Segmentによるユーザーデータ |
| ユーザーデータ | POST | グローバルコントロールグループによるユーザーデータ |
関連記事
ダッシュボードからの単発エクスポートについては、以下の記事を参照してください。
New Stuff!