mailing-list(配信予約)
要素delivery内のmailing-listについて説明します。
"mailing-list":[
{
"to":{"address":"xxxxxxxx@xxxx.xx","device":0},
"substitutions":{
"sashikomi1":"差し込みデータ",
"sashikomi2":"差し込みデータ",
"sashikomi3":"差し込みデータ"
},
"unsubscribe_url": "https://ocu.example.com/somepath/"
},
{
"to":{"address":"xxxxxxxx@xxxx.xx","device":0},
"substitutions":{
"sashikomi1":"差し込みデータ",
"sashikomi2":"差し込みデータ",
"sashikomi3":"差し込みデータ"
},
"unsubscribe_url": "https://ocu.example.com/somepath/"
}
]
配信予約処理、deliveryについては、こちらをご参照ください。
構成
mailing-listは、3つの要素で構成されます。
mailing-list
- to送信先のメールアドレス情報を設定します。
- substitutions メールアドレスごとの差し込みデータを設定します。
- unsubscribe_url ワンクリック登録解除でList-Unsubscribeヘッダに設定する(登録解除リクエストを受理する)httpsリクエストURLを設定します。
to
"to":{"address":"xxxxxxxx@xxxx.xx","device":0}
address
宛先のメールアドレスを指定します。
注意事項 宛先メールアドレスは、以下を満たす必要があります。
- 256Byte以下
- (半角英文字・数字が1文字以上)@(半角英文字・数字が1文字以上)のフォーマット
device
配信先のデバイスが特定できている場合に、以下の値を数値で指定できます。
設定数値 | 説明 |
0 | 指定なし |
1 | PC |
2 | フィーチャーフォン |
3 | iPhone |
4 | Android |
補足説明 デバイスを指定した場合、キャリアとデバイスの組み合わせによって、配信時に最適化がおこなわれます。
substitutions
"substitutions":{
"text_1" : "アララ 太郎"
}
差し込みキーワード
指定したキーワードをkeyとして、差し込みたい文字列をvalueに指定します。
注意事項
- 利用可能な文字は、0-9、a-z、-(ハイフン)、_(アンダースコア)。
- 文字長は10文字まで。
- 一つの宛先に設定可能なのは、最大200個までです。
unsubscribe_url
ワンクリック登録解除機能で、登録解除リクエストを受理するためのURLを指定することができます。ここに設定されたURLを、List-Unsubscribeヘッダに設定します。
"unsubscribe_url":"https://ocu.example.com/somepath/"
補足説明: <unsubscribe_url> を指定する場合
- 登録解除リクエストの受理およびその後の処理は、リクエストを受け取ったサーバー側で行う必要があります。
- ワンクリック登録解除設定API の呼び出しは不要です。
- ワンクリック登録解除設定API でFromアドレスが登録済みの場合であっても <unsubscribe_url> に指定されたURLが優先して利用されます。
補足説明: <unsubscribe_url> を指定しない場合
- ワンクリック登録解除設定API でワンクリック登録解除システムにFromアドレスを登録し、そのFromアドレスでメール配信をおこなった場合、登録解除リクエストの受理は本システムでおこなわれます。
- 本システムで登録解除リクエストを受理したメールアドレスは ワンクリック登録解除者リスト取得API で取得できます。
- 以降の運用において、上記APIで取得したデータを基に、お客様で該当メールアドレスを配信リストから除外する必要があります。
差し込みキーワードの利用方法
差し込みキーワードは以下の形式で、件名およびテキストパート、HTMLパートに設定可能です。 差し込みキーワードを「##」で囲みます。 例) 差し込みキーワードが「text_1」の場合、差し込みたい箇所に「##text_1##」と記載します。
"contents":{
"subject":"##text_1##",
"body":{
"text":"xxxxxxxxxxx##text_1##xxxxxxxxxxxxxxxx",
"html":"xxxxxxxxxxx##text_1##xxxxxxxxxxxxxxxx"
}
補足説明 件名やメール本文は、配信時に利用される文字エンコードにて、1行が1,000Byte以下である必要があります。
注意事項
- 差し込みキーワードを変換した結果、件名や、本文の1行(改行コードまで)が1,000Byteを超えると配信が失敗します。
- 上記を回避するため、件名・本文の1行共に上限値が指定されているので、ご注意ください。
- HTMLメールの場合、見た目の改行と改行の文字コードが一致しない場合があるため、必ず改行コードを設定してください。