このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。
Braze API ガイド
Brazeは、ユーザーのトラッキング、メッセージの送信、データのエクスポートなどを可能にする高パフォーマンスなREST APIを提供しています。このページでは、利用可能なBraze APIエンドポイントとその用途を紹介します。
Endpoint
Description
カタログからフィールドを削除します。
カタログに複数のフィールドを作成します。
カタログ内の複数のアイテムを削除します。
カタログ内の複数のアイテムを編集します。
カタログ内に複数のアイテムを作成します。
カタログの複数のアイテムを置換します。
カタログのアイテムを削除します。
カタログアイテムとその詳細をリストアップします。
複数のカタログアイテムとその内容を返します。
カタログのアイテムを編集します。
カタログにアイテムを作成します。
カタログのアイテムを置換します。
カタログを削除します。
ワークスペース内のカタログをリストアップします。
カタログを作成します。
カタログセレクションを削除します。
カタログにセレクションを作成します。
既存の統合のリストを返します。
同期ステータスのリストを返します。
指定した統合の同期をトリガーします。
一定期間内にメールメッセージを「ハードバウンス」したメールアドレスのリストを取得します。
start_dateからend_dateまでの期間に配信停止したメールアドレスを返します。
ユーザーのメール配信を停止し、ハードバウンスとしてマークします。
ユーザーのメールサブスクリプション状態を設定します。
Brazeのバウンスリストからメールアドレスを削除します。
Brazeのスパムリストからメールアドレスを削除します。
キャンペーンに関するさまざまな統計の日次データを取得します。
指定したキャンペーンの関連情報を取得します。
キャンペーンのリストをエクスポートします。各キャンペーンには、名前、キャンペーン API識別子、APIキャンペーンかどうか、およびキャンペーンに関連付けられたタグが含まれます。
トラッキング対象の
send_idに関するさまざまな統計の日次データを取得します。
キャンバスの時系列データをエクスポートします。
キャンバスの時系列データのロールアップをエクスポートし、キャンバスの結果の簡潔なサマリーを提供します。
名前、作成日時、現在のステータスなど、キャンバスに関するメタデータをエクスポートします。
名前、キャンバス API識別子、関連タグを含むキャンバスのリストをエクスポートします。
名前、説明、データタイプ、配列長（該当する場合）、ステータス、関連タグを含むカスタム属性のリストをエクスポートします。
アプリに記録されたカスタムイベント名のリストをエクスポートします。
指定した期間におけるアプリ内のカスタムイベント発生回数の時系列データを取得します。
名前、説明、ステータス、関連タグ、分析レポートへの含有状況を含むカスタムイベントのリストをエクスポートします。
各日付の新規ユーザー総数の日次データを取得します。
各日付のユニークアクティブユーザー総数の日次データを取得します。
30日間のローリングウィンドウにおけるユニークアクティブユーザー総数の日次データを取得します。
各日付のアンインストール総数の日次データを取得します。
ページ分割された製品IDのリストを返します。
指定した期間におけるアプリの購入総数を返します。
指定した期間におけるアプリの総支出額を返します。
セグメントのリストをエクスポートします。各セグメントには、名前、セグメントAPI識別子、および分析トラッキングが有効かどうかが含まれます。
セグメントの推定サイズの日次データを時系列で取得します。
セグメントの関連情報を取得します。
指定されたセグメントIDのエクスポートをキャンセルします。
指定した期間におけるアプリのセッション数の時系列データを取得します。
グローバルコントロールグループ内のすべてのユーザーをエクスポートします。
ユーザー識別子を指定して、任意のユーザープロファイルからデータをエクスポートします。
セグメント内のすべてのユーザーをエクスポートします。
メディアライブラリにアセットをアップロードします。
iOSのライブアクティビティを更新します。
現在からリクエストで指定した
end_timeまでの間にスケジュールされたキャンペーンおよびエントリキャンバスに関する情報のJSONリストを返します。
以前にスケジュールしたメッセージを送信前にキャンセルします。
以前にAPIトリガーでスケジュールしたキャンバスメッセージを送信前にキャンセルします。
以前にスケジュールしたAPIトリガーキャンペーンメッセージを送信前にキャンセルします。
キャンペーン、キャンバス、またはその他のメッセージを指定した時間に送信するようスケジュールします。
ダッシュボードで作成したキャンペーンメッセージをAPIトリガー配信で送信します。
APIトリガー配信でキャンバスメッセージをスケジュールします。
スケジュール済みメッセージを更新します。このエンドポイントは、
scheduleパラメータまたはmessagesパラメータ、あるいはその両方の更新を受け付けます。
ダッシュボードで作成したスケジュール済みのAPIトリガーキャンペーンを更新します。
ダッシュボードで作成したスケジュール済みのAPIトリガーキャンバスを更新します。
送信ごとにキャンペーンを作成せずに、メッセージの送信およびメッセージパフォーマンスのトラッキングに使用する送信IDをプログラムで作成します。
Braze APIを使用して、指定したユーザーに即時の1回限りのメッセージを送信します。
指定したユーザーに即時の1回限りのトランザクションメッセージを送信します。
APIトリガー配信を使用して、指定したユーザーに即時の1回限りのメッセージを送信します。
APIトリガー配信でキャンバスメッセージを送信します。
ユーザー設定センターのURLを作成します。
利用可能なユーザー設定センターをリストアップします。
ユーザー設定センターの作成日時や更新日時などの詳細を表示します。
ユーザー設定センターを作成し、ユーザーがメールキャンペーンの通知設定を管理できるようにします。
ユーザー設定センターを更新します。
アプリのSDK認証キーを削除します。
アプリのSDK認証キーをリストアップします。
アプリ用に新しいSDK認証キーを作成します。
SDK認証キーをアプリのプライマリキーとして設定します。
一定期間内にBrazeが「無効」とマークした電話番号のリストを取得します。
Brazeの無効リストから「無効」な電話番号を削除します。Brazeが無効とマークした電話番号を再検証する場合に使用します。
サブスクリプショングループ内のユーザーのサブスクリプション状態を取得します。
特定のユーザーのサブスクリプショングループをリストアップして取得します。
Brazeダッシュボード上で最大50ユーザーのサブスクリプション状態を一括更新します。
Brazeダッシュボード上で最大50ユーザーのサブスクリプション状態を一括更新します。
既存のContent Blocksの情報をリストアップします。
既存のメールContent Blocksの情報を取得します。
メールのContent Blocksを作成します。
メールのContent Blocksを更新します。
Brazeアカウントで利用可能なメールテンプレートのリストを取得します。
メールテンプレートの情報を取得します。
Brazeダッシュボードでメールテンプレートを作成します。
Brazeダッシュボードでメールテンプレートを更新します。
ユーザーの古い非推奨external IDを削除します。
ユーザーのexternal IDの名前を変更します。
識別された既存のユーザーに新しいユーザーエイリアスを追加するか、未識別の新規ユーザーを作成します。
既知のユーザー識別子を指定して、任意のユーザープロファイルを削除します。
未識別（エイリアスのみ）のユーザーを識別します。
カスタムイベント、購入を記録し、ユーザープロファイル属性を更新します。
既存のユーザーエイリアス名を新しいユーザーエイリアス名に更新します。
ユーザープロファイルを別のユーザーにマージします。
既存のダッシュボードユーザーを完全に削除します。
メールアドレスを指定して、既存のダッシュボードユーザーアカウントを検索します。
リソースIDを指定して、既存のダッシュボードユーザーアカウントを検索します。
メール、姓名、権限（会社、ワークスペース、チームレベルでの権限設定）を指定して、新しいダッシュボードユーザーアカウントを作成します。
メール、姓名、権限（会社、ワークスペース、チームレベルでの権限設定）を指定して、既存のダッシュボードユーザーアカウントを更新します。
New Stuff!