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