メール配信設定新規作成APIを実装したい

メール配信設定新規作成APIとは

本APIの概要

メール配信設定新規作成APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面を介さずにメールアプリの機能の1つであるメール配信設定を新規に作成することができるAPIです。

貴社の基幹システム/アプリケーションに連携したメール配信を行いたい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

本APIで取得できるb→dash管理画面上のデータ

b→dash管理画面と同等の操作

メール配信設定新規作成APIでは、b→dash管理画面にある「メール配信新規作成画面（以下キャプチャ）」における操作と同様に、メール配信設定の作成を行うことができます。

メール配信設定新規作成画面の例

b→dash管理画面上の更新結果確認方法

メール配信設定新規作成APIを利用した結果は以下のb→dash管理画面（「メール配信設定一覧画面」「メール配信設定詳細画面」「メールコンテンツ詳細画面」）で確認することができます。

メール配信設定一覧画面の例

メール配信設定詳細画面_更新履歴モーダルの例

メールコンテンツ詳細画面_利用状況モーダル

本API利用にあたっての前提事項

事前準備

メール配信設定APIを利用する事前準備として、「❶ セグメント用データの作成」「❷ メール配信対象外データファイルの作成」「❸ メールコンテンツの作成」「❹ 送信元情報の設定」の4つの手順を踏む必要があります。

❶ セグメント用データの作成

メール配信設定の作成過程で送信対象となるセグメントを選択するため、事前にセグメントを作成する必要があります。

セグメントアプリ上でセグメント用データの作成がまだ完了していない場合は「セグメントを作成したい」をご参照の上、設定を完了させてください。

❷ メール配信対象外データファイルの作成

特定の顧客に対して配信しないメール配信設定を作成したい場合、b→dash管理画面上でメールを配信しない対象とする配信対象外データファイルを作成する必要があります。

データパレットアプリ上で配信対象外データファイルの作成がまだ完了していない場合は、メールの配信設定に利用するセグメント用データの参照元データファイルから配信しない顧客またはメールアドレスの「絞込み」を行って配信対象外データファイルを作成してください。

b→dash管理画面上で行うデータの絞込みの方法に関しては「データの「絞込み」をしたい」をご参照ください。

※「b→dashデータのオプトアウトフォームデータ」「配信不達データ」はb→dashが自動で作成する配信対象外データファイルのため、事前準備は不要です。

❸ メールコンテンツの作成

メール配信設定の作成過程で配信するメールコンテンツを選択するため、b→dash管理画面上でメールコンテンツを作成する必要があります。

メールアプリ上でメールコンテンツの作成がまだ完了していない場合は以下をご参照の上、メールコンテンツを作成してください。

• テキストメールを作成したい場合：「テキストメールを作成したい」
• GUIでHTMLメールを作成したい場合：「HTMLメールを作成したい(GUI)」
• HTMLでHTMLメールを作成したい場合：「HTMLメールを作成したい(HTML)」
• APIでHTML/テキストメールを作成したい場合：「メールコンテンツ新規作成APIを実装したい」

❹ 送信元情報の設定

メール配信設定の作成過程で送信元となるメールアドレスを選択するため、事前に送信元情報の設定をする必要があります。

共通設定上で送信元設定のメールアドレスの登録がまだ完了していない場合は「送信元メールアドレスを設定したい」をご参照の上、登録を完了させてください。

共通仕様

メール配信設定新規作成APIでは、b→dash APIの共通仕様も参照する必要があります。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。

メール配信設定新規作成APIの仕様

処理フロー図

メール配信設定新規作成APIの処理フロー図は以下になります。

メール配信設定新規作成リクエスト

json形式のファイル(拡張子：.json)にリクエストボディパラメータを指定して、メール配信設定の内容を送信するためのリクエストボディを準備します

〇リクエストボディパラメータ

【リクエストボディサンプル】

{ 
  "mail_campaign_name": "メール配信設定Ａ", 
  "segment_id": "10001", 
  "s_mail_column_ids": [ 
    { 
      "datafile_id": "10001", 
      "d_mail_column_id": "COLUMN_1" 
    }, 
    { 
      "datafile_id": "10001", 
      "d_mail_column_id": "COLUMN_2" 
    }, 
    { 
      "datafile_id": "10001", 
      "d_mail_column_id": "COLUMN_3" 
    }, 
    { 
      "datafile_id": "10001", 
      "d_mail_column_id": "COLUMN_4" 
    }, 
    { 
      "datafile_id": "10001", 
      "d_mail_column_id": "COLUMN_5" 
    } 
  ], 
  "is_send_all": true, 
  "exclusion_datafile": [ 
    { 
      "datafile_id": "30001", 
      "d_mail_column_id": "COLUMN_1" 
    }, 
    { 
      "datafile_id": "50001", 
      "d_mail_column_id": "COLUMN_1" 
    } 
  ], 
  "contents_id": "70001", 
  "sender_info_id": "80001", 
  "timings": [ 
    { 
      "interval": "ONCE", 
      "year": 2021, 
      "month": 12, 
      "day": 31, 
      "hour": 23, 
      "minute": 0 
    }, 
    { 
      "interval": "WEEKLY", 
      "day_of_the_week": "FRI", 
      "hour": 23, 
      "minute": 0 
    } 
  ], 
  "is_delivery_segment_update": true, 
  "is_enabled_delivery_limit": true, 
  "is_auto_parameter": true, 
  "is_delivery_the_same_customer": true, 
  "delivery_start_date": "20210101", 
  "delivery_end_date": "20251231" 
} 

〇メール配信設定新規作成APIのURI

〇リクエスト形式

POST https://api.smart-bdash.com/api/v1/mail_deliveries 

メール配信設定新規作成レスポンス

リクエストの送信に成功すると、下記のレスポンス形式でメール配信設定新規作成APIからレスポンスが返されます

〇レスポンスボディパラメータ

〇リクエストエラー発生時のエラーメッセージ詳細

【レスポンスボディサンプル（成功レスポンス（201））】

{ 
  "result": { 
    "code": 201, 
    "mail_campaign_id": "12345" 
    "mail_campaign_name": "メール配信設定Ａ" 
  } 
}