Braze API ガイド
Braze は、ユーザーの追跡、メッセージの送信、データのエクスポートなどを可能にする高性能の REST API を提供します。このページでは、利用可能な Braze API エンドポイントとその用途を示します。
Select endpoint type to narrow the glossary:
Endpoint
Description
カタログ内の複数のアイテムを削除します。
カタログの複数の項目を編集します。
カタログに複数のアイテムを作成します。
カタログの複数の項目を更新します。
カタログの項目を削除します。
カタログ項目とその詳細を一覧表示します。
複数のカタログ項目とその内容を返します。
カタログの項目を編集します。
カタログに項目を作成します。
カタログの項目を更新します。
カタログを削除します。
ワークスペース内のカタログを一覧表示します。
カタログを作成します。
既存の統合のリストを返します。
同期ステータスのリストを返します。
指定した統合の同期をトリガーします。
一定期間内にメールメッセージを「ハードバウンス」したメールアドレスのリストを取得します。
start_date から end_date までの期間に配信停止したメールを返します。
ユーザーのメール配信を停止し、ハードバウンスとしてマークします。
ユーザーのメールサブスクリプション状態を設定します。
Braze のバウンスリストからメールアドレスを削除します。
Braze のスパムリストからメールアドレスを削除します。
一定期間にわたるキャンペーンのさまざまな統計の日次系列を取得します。
指定したキャンペーンの関連情報を取得します。
キャンペーンのリストをエクスポートします。各キャンペーンには、名前、キャンペーン API 識別子、API キャンペーンかどうか、キャンペーンに関連するタグが含まれます。
追跡している
send_id の各種統計情報を毎日取得します。
キャンバスの時系列データをエクスポートします。
キャンバスの時系列データのロールアップをエクスポートして、キャンバスの結果を簡潔に要約できます。
キャンバスの名前、作成時間、現在のステータスなど、キャンバスに関するメタデータをエクスポートします。
キャンバス名、キャンバス API 識別子、関連タグを含むキャンバスのリストをエクスポートします。
アプリに記録されたカスタムイベントのリストをエクスポートします。
指定した期間にアプリ内で発生したカスタムイベントの回数を取得します。
各日付の新規ユーザー総数の日次系列を取得します。
各日付の一意のアクティブユーザーの総数の日次系列を取得します。
30日間にわたる一意のアクティブユーザーの総数の日次系列を取得します。
各日付のアンインストール総数の日次系列を取得します。
経時的なカードのエンゲージメント統計情報の日次系列を取得します。
カードの関連情報を取得します。
ニュースフィードカードのリストをエクスポートします。各カードには名前とカード API 識別子が含まれます。
製品 ID のページ分割されたリストを返します。
特定の時間範囲におけるアプリでの購入数の合計を返します。
特定の時間範囲にわたってアプリで使用された合計金額を返します。
セグメントのリストをエクスポートします。各セグメントには、セグメントの名前、セグメント API 識別子、アナリティクスのトラッキングが有効かどうかが含まれます。
セグメントの推定サイズの日次系列を経時的に取得します。
セグメントの関連情報を取得します。
指定した期間におけるアプリのセッション数を取得します。
グローバルコントロールグループ内のすべてのユーザーをエクスポートします。
ユーザー識別子を指定して、任意の顧客プロファイルからデータをエクスポートします。
セグメント内のすべてのユーザーをエクスポートします。
iOS のライブアクティビティを更新します。
現在からリクエストで指定された
end_time までの間にスケジュールされたキャンペーンとエントリーキャンバスに関する情報の JSON リストを返します。
以前に予約したメッセージを送信前にキャンセルします。
API トリガーで以前にスケジューリングしたキャンバスメッセージを送信前にキャンセルします。
以前にスケジューリングした API トリガーキャンペーンメッセージを、送信前にキャンセルできます。
キャンペーン、キャンバス、その他のメッセージを指定時間に送信するようスケジュールします。
Send dashboard created campaign messages via API-triggered delivery.
API トリガー配信でキャンバスメッセージをスケジュールします。
スケジュールされたメッセージを更新します。このエンドポイントは、
schedule か messages パラメータのどちらか、または両方の更新を受け付けます。
ダッシュボードに作成されたスケジュールされた API トリガーキャンペーンを更新します。
ダッシュボードで作成されたスケジュールされた API トリガーキャンバスを更新します。
送信ごとにキャンペーンを作成することなく、プログラムでメッセージを送信し、メッセージのパフォーマンスを追跡するために使用できる送信 ID を作成します。
Braze API を使用して、指定したユーザーに即座に単発のメッセージを送信します。
指定されたユーザーに、即座に単発のトランザクションメッセージを送信します。
API トリガー配信により、指定したユーザーに即座に単発のメッセージを送信します。 - Send Messages
API トリガー配信でキャンバスメッセージを送信します。 - Send Messages
ユーザー設定センターの URL を作成します。
利用可能なユーザー設定センターをリストアップしてください。
作成日や更新日などユーザー設定センターの詳細を表示します。
ユーザー設定センターを作成し、ユーザーがメールキャンペーンの通知設定を管理できるようにします。
ユーザー設定センターを更新します。
一定期間内に「無効」と判断された電話番号のリストを引き出します。
Braze の無効リストから「無効」な電話番号を削除します。これは、無効とマークされた電話番号を再度検証するために使用できます。
サブスクリプショングループ内のユーザーのサブスクリプション状態を取得します。
特定のユーザーのサブスクリプショングループをリストアップして取得します。
Braze ダッシュボード上で最大 50 ユーザーのサブスクリプション状態を一括更新します。
Braze ダッシュボード上で最大 50 ユーザーのサブスクリプション状態を一括更新します。
既存のコンテンツブロックの情報を一覧表示します。
既存のメールコンテンツブロックの情報を呼び出します。
メールコンテンツブロックを作成します。
メールのコンテンツブロックを更新します。
Braze アカウントで利用可能なメールテンプレートのリストを取得します。
メールテンプレートの情報を取得します。
Braze ダッシュボードでメールテンプレートを作成します。
Braze ダッシュボードでメールテンプレートを更新します。
ユーザーの古い非推奨外部 ID を削除してください。
ユーザーの外部 ID の名前を変更します。
既存の識別されたユーザーのために新しいユーザーエイリアスを追加するか、または新しい識別されていないユーザーを作成します。
既知のユーザー識別子を指定して、任意の顧客プロファイルを削除します。
識別されていない（エイリアスのみの）ユーザーを識別します。
カスタムイベント、購入を記録し、顧客プロファイル属性を更新します。
既存のユーザーエイリアス名を新しいユーザーエイリアス名に更新します。
顧客プロファイルを別のユーザーにマージします。
既存のダッシュボードユーザーを完全に削除します。
メールアドレスを指定して、既存のダッシュボードユーザーアカウントを検索します。
メールアドレスを指定して、既存のダッシュボードユーザーアカウントを検索します。
メールアドレス、姓名、権限（会社、ワークスペース、およびチームレベルでの権限設定）を指定して、新しいダッシュボードユーザーアカウントを作成します。
メール、姓名、権限（会社、ワークスペース、およびチームレベルでの権限設定）を指定して、既存のダッシュボードユーザーアカウントを更新します。
GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」