Braze API ガイド
Braze には、ユーザーs の追跡、メッセージの送信、データのエクスポートなどを可能にする高パフォーマンス RESTなAPI が用意されています。ここでは、使用可能なBraze API エンドポイントとその用途について説明します。
Endpoint
Description
カタログからフィールドを削除する。
カタログに複数のフィールドを作成する。
カタログ内の複数の項目を削除します。
カタログ内の複数の項目を編集します。
カタログ内に複数の項目を作成します。
カタログの複数の項目を置換します。
カタログの項目を削除する。
カタログ項目とその詳細をリストアップする。
複数のカタログ項目とその内容を返す。
カタログの項目を編集する。
カタログに項目を作成する。
カタログの項目を置換します。
カタログを削除する。
ワークスペース内のカタログを一覧表示する。
カタログを作成する。
カタログセレクションを削除します。
カタログにセレクションを作成する。
既存の統合のリストを返す。
同期ステータスのリストを返す。
指定した統合の同期をトリガーする。
一定期間内にメールメッセージを「ハードバウンス」したメールアドレスのリストを取得します。
以下の期間中に購読を解除したメールを返す。
start_date への end_date.
ユーザーのメール配信を停止し、ハードバウンスとしてマークします。
ユーザーのメールサブスクリプションの状態を設定します。
Braze のバウンスリストからメールアドレスを削除します。
Brazeのスパムリストからメールアドレスを削除する。
キャンペーンに関する様々な統計情報を日次で取得する。
指定したキャンペーンの関連情報を取得する。
キャンペーンs の一覧をエクスポートします。それぞれの一覧には、名前、キャンペーン API 識別子、API キャンペーンかどうか、およびキャンペーンに関連付けられたタグs が含まれます。
追跡対象のさまざまな統計の日次情報を取得します
send_id.
キャンバスの時系列データをエクスポートする。
キャンバスの時系列データのロールアップをエクスポートし、キャンバスの結果の簡潔な要約を提供する。
名前、作成時間、現在のステータスなど、キャンバスに関するメタデータをエクスポートします。
名前、キャンバスの API 識別子、関連タグを含むキャンバスのリストをエクスポートします。
名前、説明、データタイプ、配列長（該当する場合）、ステータス、関連タグを含むカスタム属性のリストをエクスポートする。
アプリに記録されたカスタムイベントの名前の一覧をエクスポートします。
指定された期間にわたり、アプリ内でカスタムイベントが発生した回数を取得します。
名前、説明、ステータス、関連タグ、分析レポートを含むカスタムイベントのリストをエクスポートします。
各日付の新規ユーザーの総数を日次で取得します。
各日付のアクティブユーザーの総数を日次で取得します。
30日間にわたり固有のアクティブユーザーの総数を日次で取得します。
各日付のアンインストールの総数を日次で取得します。
製品 ID のページ分割されたリストを返す。
時間範囲内のアプリでの購入総数を返す。
特定の期間内のアプリ内支出額の合計を返します。
Segments の一覧をエクスポートします。それぞれに名前、Segment API 識別子、および分析 "トラッキングが有効になっているかどうかが含まれます。
時間の経過に伴うセグメントの推定サイズの日次情報を取得します。
セグメントの関連情報を取得する。
指定されたSegment ID のエクスポートを取り消します。
指定した期間におけるアプリの一連のセッション数を取得します。
グローバルコントロールグループ内のすべてのユーザーをエクスポートする。
ユーザー識別子を指定して、任意のユーザープロファイルからデータをエクスポートする。
セグメント内のすべてのユーザーをエクスポートする。
iOSのライブアクティビティを更新する。
現在から指定された期間内に予定されているキャンペーンとエントリーキャンバスに関する情報のJSONリストを返す。
end_time リクエストで指定されました。
以前にスケジュールしたメッセージを、送信前にキャンセルします。
以前にスケジュールした、API でトリガーされるキャンバスメッセージを、送信前にキャンセルします。
以前にスケジュールした API でトリガーされるキャンペーンメッセージを、送信前にキャンセルします。
キャンペーン、キャンバス、その他のメッセージを指定時間に送信するようスケジュールする。
ダッシュボードで作成したキャンペーンメッセージをAPIトリガー配信で送信する。
APIトリガー配信でCanvasメッセージをスケジュールする。
スケジュールされたメッセージを更新する。このエンドポイントは
schedule または messages パラメータ、またはその両方です。
ダッシュボードに作成されたスケジュールされたAPIトリガーキャンペーンを更新する。
ダッシュボードで作成したスケジュールされた API-トリガー ed キャンバスをアップデートします。
送信ごとにキャンペーンを作成せずに、メッセージの送信およびメッセージパフォーマンスの"トラッキングに使用する送信ID をプログラムで作成します。
Braze API を介して、指定したユーザーに即座に単発のメッセージを送信します。
指定されたユーザーに、即時、単発のトランザクションメッセージを送信します。
API トリガー配信を介して、指定したユーザーに即時の1回限りのメッセージを送信します。 - メッセージを送信
APIトリガー配信でCanvasメッセージを送る。- メッセージを送信する
ユーザー設定センターの URL を作成します。
利用可能なユーザー設定センターをリストアップします。
ユーザー設定センターが作成された日時や更新d など、詳しく表示されます。
ユーザー設定センターを作成し、ユーザーがメールキャンペーンの通知設定を管理できるようにします。
ユーザー設定センターを更新します。
アプリの SDK 認証キーを削除する。
アプリの SDK 認証キーをリストアップする。
アプリ用に新しい SDK 認証キーを作成する。
SDK 認証キーをアプリのプライマリキーとして設定します。
Brazeが"invalid"とマークした電話番号の一覧を、一定期間内に引き出します。
Brazeの無効リストから「無効」な電話番号を削除する。Brazeが不正と判断した電話番号を再検証する場合に使用します。
サブスクリプショングループ内のユーザーのサブスクリプションステートを取得する。
特定のユーザーの購読グループをリストアップし、取得する。
Brazeダッシュボード上で最大50ユーザーのサブスクリプション状態を一括更新。
Brazeダッシュボード上で最大50ユーザーのサブスクリプション状態を一括更新。
既存のコンテンツブロックの情報をリストアップする。
既存のEメール・コンテンツ・ブロックの情報を呼び出す。
Eメールのコンテンツブロックを作成する。
Eメールのコンテンツブロックを更新する。
Brazeアカウントで利用可能なEメールテンプレートのリストを取得する。
Eメールテンプレートの情報を入手する。
BrazeダッシュボードでEメールテンプレートを作成する。
BrazeダッシュボードでEメールテンプレートを更新する。
ユーザーの古い非推奨外部 ID を削除します。
ユーザーの外部IDの名前を変更する。
識別された既存のユーザーのために新しいユーザーエイリアスを追加するか、識別されていないユーザーを新規作成します。
既知のユーザー識別子を指定して、任意のユーザープロファイルを削除する。
識別されていない（エイリアスのみの）ユーザーを識別する。
カスタムイベント、購入、ユーザープロファイル属性の更新を記録します。
既存のユーザーエイリアス名を新しいユーザーエイリアス名に更新する。
ユーザープロファイルを別のユーザーにマージする。
既存のダッシュボードユーザーを完全に削除する。
Eメールを指定して既存のダッシュボード・ユーザー・アカウントを検索する。
リソース ID を指定して、既存のダッシュボードユーザーアカウントを検索する。
メール、姓名、権限 (会社、ワークスペース、チームレベルでの権限設定) を指定して、新しいダッシュボードのユーザーアカウントを作成します。
メール、姓名、権限 (会社、ワークスペース、チームレベルでの権限設定) を指定して、既存ダッシュボードのユーザーアカウントを更新します。
New Stuff!