もくじ
基本機能
以下の機能が利用可能です。
配信先リスト登録
指定されたCSVファイルの内容で、配信先リストへ登録を行います。
登録方法をパラメーター「mode」にて指定します。
指定できる内容は以下の通りです。
- 新規登録やレコード更新、削除にて一度削除・更新されたデータは復元できません。事前にGUIでダウンロードしておくことをおすすめします。
- 登録するCSVファイルは、サービスやテーブルセットアップの設定内容と連動しています。必ずGUIにて最新のCSVテンプレートを取得し、CSVファイルを作成してください。
- メールアドレスの指定は必須です。
新規登録
現在登録されているデータを全て削除し、新しくデータをインポートします。インポートするCSVファイルにデータIDが未設定だった場合は、前回登録したデータIDからの続き番号で自動的に採番し、登録されます。
追加登録
現在登録されているデータに対し、追加でデータをインポートします。後述するパラメーター「key」に指定されたデータが登録済みの場合、対象のデータは登録されません。
レコード更新
現在登録されているデータに対し、メールアドレスとkeyパラメーターに指定された値に合致する行がある場合、その行を上書きします。合致するメールアドレスがない場合、またはkeyパラメーターに指定されたデータが存在しない場合は、新たに対象のデータが追加登録されます。
サービス固定モードで利用する場合、サービス欄に記載されたサービスフラグのみONとなり、未指定のサービスフラグはOFFとなります。
削除
現在登録されているデータに対し、メールアドレスとkeyパラメーターに指定された値に合致する行がある場合、その行のデータを削除します。
サービス更新有効のみ・サービス更新無効のみ
サービス項目固定モードでのみ利用できます。データ更新対象の指定方法はレコード更新と同様ですが、サービス更新対象の指定方法が異なります。
レコード更新では、サービス固定モードの場合、サービス欄に記載されたサービスのみONとし、それ以外はOFFに設定します。しかし、このモードの場合、指定されたサービスだけをONもしくはOFFに設定することが可能です。
- サービス更新有効のみ → 指定されたサービスだけをON
- サービス更新無効のみ → 指定されたサービスだけをOFF
サービス以外の項目は、レコード更新と同様、全て上書きされます。
カラム更新
現在登録されているデータに対し、メールアドレスとkeyパラメーターに指定された値に合致する行がある場合、その行のカラムを上書きします。
CSVファイルには、データIDカラムとメールアドレスカラム、更新したいカラムのデータを設定し、更新しないカラムには何も指定しません。削除したいカラムには「##DELETE##」と指定します。
サービス項目固定
パラメーター「sv_mode」を「1」に指定すると利用可能となります。サービス項目を固定することで、サービスの追加・削除に伴うCSVフォーマットの変更が不要となります。
サービス指定項目を、後述するCSVフォーマットのカラムNo.6に固定し、サービスIDを入力することで、加盟サービスを指定します。
複数指定する場合は、コロン（:）にてサービスIDを区切ってください。
例）1:3:5
サービス固定モードで利用する場合、GUIからダウンロードしたフォーマットをそのまま利用する事はできません。
CSVフォーマットから、６カラム目のサービス項目以外のサービス項目を削除してご利用ください。
重複処理抑止・ジョブID発行
パラメーター「request_id」を指定することで、レスポンス時にジョブIDが返却されます。
また、同一の値によるリクエストが行われると、その処理は実施せず、登録済みのrequest_idに紐づけられているジョブIDを返却します。
ジョブIDは登録状況確認を行うために必要となります。
登録状況確認をご利用になる場合には、必ずrequest_idパラメーターを設定してください。
リクエスト
リクエスト方法などのサンプルについては、以下の記載を参考にしてください。
リクエスト仕様
| 項目 | データ |
| プロトコル | HTTPS |
| メソッド | POST |
| Content-Type | multipart/form-data ※zipファイルを利用する場合は「application/x-zip-compressed」とする。 |
| URL | https://{ご利用環境のHOST名}/reditor/kanri/http_upload.php |
リクエストパラメータ
ファイルをアップロードするため、リクエスト内容はFORM形式で指定します。
| No | name | 必須 | 説明 | ||||||||||||||||
| 1 | site_id | 〇 | 管理画面 site_id（弊社にて発行します） | ||||||||||||||||
| 2 | user_id | 〇 | 管理画面user_id（弊社にて発行します） | ||||||||||||||||
| 3 | password | 〇 | 管理画面 password（弊社にて発行します） encodeに「1」を指定することで、パスワードをMD5エンコードして指定することが可能です。 |
||||||||||||||||
| 4 | encode | passwordが平文の場合は「0」または指定なし、MD5エンコードの場合は「1」を指定 | |||||||||||||||||
| 5 | job | 〇 | import ※固定文字列 | ||||||||||||||||
| 6 | mode | 〇 | 登録モードを数値で指定。各モードと値は以下の通り。
※詳細はGUIマニュアルの「配信先リスト」を参照してください。 |
||||||||||||||||
| 7 | key | 〇 | 重複チェックするキーとなる列番号 1列目（id）=1、2列目（メールアドレス）=2、… |
||||||||||||||||
| 8 | request_id | リクエストを判別するためのID。 半角で32文字以内で設定可能。 |
|||||||||||||||||
| 9 | upload_file | 〇 | アップロードするCSVファイルへのパスを指定。 zip形式でのアップロードも可能。 |
||||||||||||||||
| 10 | sv_mode | 複数のサービスを利用している場合に、サービス項目固定の機能を有効にする。 設定値は以下の通り。
|
|||||||||||||||||
| 11 | list_id | 〇 ※1 |
CSVファイルのアップロード先の対象とするリスト番号を指定する。リスト番号はGUIでご確認ください。 |
※1 複数リスト利用時、必須
※記載されているリクエストパラメータ以外をリクエストした場合、処理が正常におこなわれない可能性があります
アップロードするCSVの仕様
| ファイル名 | 英数記号[-_].<拡張子> 拡張子： csv、zip（zipの場合はパスワードなしzip圧縮形式） |
| ファイル形式 | CSV(Comma Separated Values) |
| 引用符 | なし（データの前後に「”」をつけない） |
| 文字コード | Shift_JIS |
| 行末コード | CR+LF (0x0D+0x0A) |
| 禁則文字 | カンマ「,」、タブ「\t」、改行「\r/\n」、機種依存文字（①など） |
| ヘッダ行 | 任意 ヘッダ行を入れる場合は、必ずヘッダ行に文字列「メールアドレス」が必要 |
CSVフォーマット
| カラムNo. | 列名 | データ形式 | 説明 |
| 1 | データID | 数値(0～4G) | 通常指定しない 指定しない場合は、自動的にユニークとなるIDが採番される。 |
| 2 | メールアドレス | 文字列(255文字まで) | メールアドレス（必須） |
| 3 | バウンス回数 | 数値(0～2G) | 通常指定しない。 |
| 4 | デバイスフラグ | 数値(0～5) | 0: 設定なし 1: PC 2: フィーチャーフォン 3: iPhone 4: Androidスマートフォン 5: Windows Phone デバイスコード不明の場合は「0」を指定して下さい。 |
| 5 | 携帯キャリアフラグ | 数値(0～8) | 通常指定しない 強制指定することも可能 0: PC or Others 1: docomo 2: SoftBank 3: au 4: Disney(SoftBank) 5: WILLCOM 6: EMOBILE 7: iPhone(i.softbank.jp) 8: WILLCOM(スマホ) |
| 6 | サービス | 数値 (1または0) |
対象サービスの加入・非加入。 1:該当するサービスに加入。 0: 該当するサービスに非加入。 補足説明
|
※7列目以降はサービス設定の追加またはテーブル定義により変動
レスポンス
レスポンス仕様
| 項目 | データ |
| Content-Type | text/plain |
| データ形式 | TSV |
| 改行コード | LF(0x0A) |
レスポンスデータ仕様
| 行数 | 列 | 型 | 列名 | 内容 |
| 1 | 1 | varchar(4) | ステータスコード | 処理結果は、「ステータスコード一覧」を参照してください。 |
| 1 | 2 | varchar(32) | リクエストID | リクエスト時に指定したrequest_id リクエスト時に、指定しなかった場合は本カラム自体出力されない。 同一のrequest_idを複数リクエストした場合、重複登録処理とみなし、CSV登録処理は行わず、0402エラーを返却する。 |
| 1 | 3 | char(8) | ジョブID | ジョブID リクエスト時にrequest_idを指定した場合に一意に割り当てられたジョブIDを返却する。 リクエスト時にrequest_idを指定しなかった場合はカラム自体出力されない。 |
