Unsubscribe
メモ
本APIは、有償の「ワンクリック購読解除」オプションのご契約者向けのAPIとなります。オプションのご契約や費用のお見積等につきましては、管理コンソール内のお問い合わせフォームよりご連絡ください。
また、本機能の概要についてはユーザーガイドの「ワンクリック購読解除」をご覧ください。
購読解除ダウンロードAPI
「購読解除ダウンロードAPI」を利用すると、Customers Mail Cloud上の購読解除リストをCSV形式でダウンロードできます。「購読解除リスト」の登録データは、日次バッチにより更新処理が実行されます。どの配信メールが購読解除されたか、については「購読解除フィルタ」のフィルタ名から識別が可能です。
リクエスト
/transaction/v2/unsubscribes/download.[json|xml]
アクセス制御
| 項目 | 値 |
|---|---|
| ロール | APIグループ管理者、APIユーザ |
| 権限 | ダウンロード許可 |
パラメータ
| パラメータ | 必須 | データ型 | 説明 |
|---|---|---|---|
| api_user | Yes | ASCII | |
| api_key | Yes | ASCII | |
| server_composition | Yes | UTF-8 | |
| No | ASCII | このパラメータが指定された場合、部分一致するメールアドレスを検索します。 | |
| start_date | No | DATE | 購読解除となった日を基準とした期間検索を行うために検索開始日(yyyy-mm-dd)を指定します。検索開始日は検索期間に含まれます。 制約：start_dateはend_dateと等しいか過去日を指定する必要があります。 |
| end_date | No | DATE | 購読解除となった日を基準とした期間検索を行うために検索終了日(yyyy-mm-dd)を指定します。検索終了日は検索期間に含まれます。 |
| filter_name | No | UTF-8 | フィルタ名。完全一致とします。 |
レスポンス
リクエストが成功した場合、Content-Type に application/octet-stream を指定し、以下フォーマットのCSVファイルをZIP圧縮してダウンロードします。データ暗号化を設定している場合、パスワード付き暗号化ZIPファイルをダウンロードします。
ファイル名
unsubscribes-yyyyMMdd_HHmmss.zip
ファイルフォーマット
"created","email",”filtername”
"2015-12-14 08:46:00","from1@example.com","配信リストA"
"2015-12-14 12:19:00","from2@example.com","配信リストB"
| プロパティ | 説明 |
|---|---|
| created | 購読解除状態とした日時 |
| 購読解除状態にあるメールアドレス | |
| filtername | フィルタ名 |
エラーメッセージ
| フィールド | エラーコード | メッセージ |
|---|---|---|
| server_composition | 10-002 | 指定されたサーバ構成 {0} は存在しません。 |
| start_date | 10-003 | 開始日には終了日以前の日付を指定してください。 |
| 12-002 | 指定されたデータにアクセスする権限がありません。 |
購読解除取り消しAPI
「購読解除取り消しAPI」を利用すると、Customers Mail Cloud上に蓄積されたユーザーの「購読解除」の状態を取り消し、配信可能な状態（購読再開）とします。なお、このAPIへのデータのPOSTは随時受け取りますが、状態取り消しの実行は日次のバッチ処理で実施されます。
リクエスト
/transaction/v2/unsubscribes/cancel.[json|xml]
アクセス制御
| 項目 | 値 |
|---|---|
| ロール | APIグループ管理者 |
| 権限 | なし |
パラメータ
| パラメータ | 必須 | データ型 | 説明 |
|---|---|---|---|
| api_user | Yes | ASCII | |
| api_key | Yes | ASCII | |
| server_composition | Yes | UTF-8 | |
| Yes | ASCII | 購読解除リストから取消する対象のメールアドレスを指定します。 制約：削除対象のメールアドレスは大文字小文字無視の完全一致で検索します。 |
|
| filter_name | No | UTF-8 | フィルタ名。完全一致とする |
レスポンス
{
"message" : "success"
}
<success>
<message>success</message>
</success>
エラーメッセージ
| フィールド | エラーコード | メッセージ |
|---|---|---|
| server_composition | 10-002 | 指定されたサーバ構成 {0} は存在しません。 |
| 12-001 | emailで指定されたデータは存在しません。 | |
| 12-002 | 指定されたデータにアクセスする権限がありません。 |
メモ
任意のフィールド "filter_name" で値の不一致によるエラーが発生した場合は、フィールド "email" でのエラーと同内容となります。