Skip to content

APIキャンペーン

このリファレンス記事では、API呼び出しに含めるcampaign_idの生成方法と、そのキャンペーンの設定方法について説明します。

APIキャンペーンは通常、トランザクションメッセージングに使用されます。APIキャンペーン（APIトリガーキャンペーンではない）を作成する場合、Brazeダッシュボードはcampaign_idを生成するためだけに使用され、キャンペーンレポートの分析を追跡できます。また、キャンペーン内の各バリアントごとに異なるメッセージバリエーションIDを生成することもできます。

その情報を以下の内容とともに開発チームに送信し、APIリクエストで使用してもらいます。

  • キャンペーンコピー
  • オーディエンスメンバーシップ
  • アセット

キャンペーンが開始された後、結果をダッシュボードで確認できます。APIキャンペーンはBrazeのメッセージングAPIを使用します。これらのAPIは、ダッシュボードを通じて完全に作成されたキャンペーンと同じ詳細なレポートおよびリターゲティングオプションを備えています。

新しいキャンペーンを作成する

メッセージング > キャンペーンに移動し、キャンペーンを作成を選択してから、APIキャンペーンを選択します。これで、APIキャンペーンの設定に進むことができます。

APIトリガーキャンペーンはAPIキャンペーンとは異なります。

キャンペーンを設定する

キャンペーンを設定するには、以下のステップを実行します。

  1. キャンペーンページでメッセージ送信後に結果を見つけやすいよう、わかりやすいタイトルを追加します。
  2. メッセージを追加を選択し、APIキャンペーンに含めるメッセージタイプを追加します。これにより、campaign_idと、含めるチャネルごとに異なるメッセージバリエーションIDが生成されます。
  3. 必要に応じて、特定のアクションやキャンペーン目標に対するユーザーのコンバージョンを追跡するコンバージョンイベントを追加できます。
  4. キャンペーンを保存を選択すれば、APIキャンペーンを開始する準備は完了です。

API呼び出し

APIキャンペーンを保存した後、APIリクエストに以下を含めてください。

  • 生成されたcampaign_idフィールドを、メッセージ送信エンドポイントに記載されている箇所でAPIリクエストに含めます。
  • キャンペーンに含まれる各プラットフォームのメッセージオブジェクト。メッセージオブジェクトでは、メッセージバリエーションIDを指定します。これにより、統計がそのバリアントの下で収集・表示されるようになります。サポートされているメッセージオブジェクトは、Android、Content Cards、メール、iOS、Kindle、SMS/MMS、Webプッシュ、Webhookです。

APIキャンペーンにワンクリックリスト購読解除を追加する

デフォルトでは、BrazeはAPIキャンペーンにワンクリックリスト購読解除ヘッダーを追加しません。個々のAPIキャンペーン送信にこのヘッダーを追加するには、APIリクエストのメールヘッダーフィールドに{{${set_user_to_one_click_list_unsubscribe}}}Liquidタグを含めます。

ワンクリックリスト購読解除のRFC 8058に準拠するには、APIリクエストにList-UnsubscribeとList-Unsubscribe-Postの両方のヘッダーを含めてください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "external_user_ids": ["user_id"],
  "messages": {
    "email": {
      "app_id": "your_app_id",
      "subject": "Your Subject",
      "from": "Sender Name <[email protected]>",
      "body": "<p>Email body content</p>",
      "headers": {
        "List-Unsubscribe": "<{{${set_user_to_one_click_list_unsubscribe}}}>",
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
      }
    }
  }
}

メール添付ファイルの追加

APIキャンペーンのメールに添付ファイルを追加するには、メールオブジェクトにattachments配列を含めます。ドラッグ＆ドロップエディターまたはHTMLエディターで作成したメールテンプレートを参照するには、メールオブジェクトにemail_template_idを指定し、API呼び出しを通じて添付ファイルを追加します。

添付ファイルの詳細、サイズ制限、ベストプラクティスについては、添付ファイル付きメールオブジェクトの例を参照してください。
New Stuff!