APIキャンペーン
このリファレンス記事では、API呼び出しに含める
campaign_idの生成方法とそのキャンペーンの設定方法について説明します。
APIキャンペーンは通常、トランザクションメッセージングに使用されます。APIキャンペーン（APIトリガーキャンペーンではない）を作成する場合、Brazeダッシュボードはcampaign_idを生成するためだけに使用され、キャンペーンレポートの分析を追跡できます。また、キャンペーン内の各バリアントごとに異なるメッセージバリエーションIDを生成することもできます。
次に、その情報を以下の内容とともに開発チームに送信し、APIリクエストで使用します。
- キャンペーンコピー
- オーディエンスメンバーシップ
- アセット
キャンペーンが開始された後、結果をダッシュボードで確認できます。APIキャンペーンはBrazeのメッセージングAPIを使用します。これらのAPIは、ダッシュボードを通じて完全に作成されたキャンペーンと同じ詳細なレポートおよびリターゲティングオプションを備えています。
APIキャンペーンは通常トランザクション型であるため、グローバルコントロールグループに属するユーザーも含め、すべてのユーザーがAPIキャンペーンの対象となります。これらの送信にはワンクリックリスト配信停止ヘッダーが追加されません。すべてのAPIキャンペーンにワンクリックリスト配信停止ヘッダーを追加する場合は、カスタマーサクセスマネージャーにお問い合わせください。
新しいキャンペーンを作成する
メッセージング > Campaignsに移動してキャンペーンを作成を選択し、API Campaignsを選択します。これで、APIキャンペーンの設定に進むことができます。
APIトリガーキャンペーンは、APIキャンペーンとは異なります。
キャンペーンを設定する
キャンペーンを設定するには、次のステップを実行します。
- メッセージを送信した後にCampaignsページで結果を見つけられるように、わかりやすいタイトルを追加します。
- Add Messageをクリックして、APIキャンペーンに含めるメッセージタイプを追加します。これにより、
campaign_idとメッセージバリエーションIDが生成されます。メッセージバリエーションIDは含める各チャネルごとに異なります。 - オプションとして、特定のアクションやキャンペーン目標に対するユーザーのコンバージョンを追跡するために、コンバージョンイベントを追加できます。
- Save Campaignをクリックすると、APIキャンペーンを開始する準備が整います。
API呼び出し
APIキャンペーンを保存したら、APIリクエストに次の内容を含めます。
- メッセージ送信エンドポイントに記載されている箇所に、生成された
campaign_idフィールドを含めます。 - キャンペーンに含まれる各プラットフォームのメッセージオブジェクト。メッセージオブジェクトにメッセージバリエーションIDを指定します。これにより、統計が収集され、そのバリアントの下に表示されるようになります。次のメッセージオブジェクトがサポートされています：Android、Content Cards、メール、iOS、Kindle、SMS/MMS、Webプッシュ、Webhook。