配信対象者の情報を指定する構成要素です。
<send_list>
<data id="1">
<address device="3">xxxx@xxx.jp</address>
<int_txt id="0">XXXXXXXX</int_txt>
<ext_txt id="0">0</ext_txt>
<ext_img id="0">0</ext_img>
<key_field id="0">XXXXXXXXXXXX</key_field>
<unsubscribe_url>https://example.com/exampleexample</unsubscribe_url>
</data>
</send_list>
構成要素(data)
以下の要素で構成されます。
- data
- address
- int_txt
- ext_txt
- ext_img
- key_field
- unsubscribe_url
data
XML内に配信先の情報を指定する要素です。複数定義する場合は、要素dataを複数回繰り返すことで指定します。
<data id="0"></data>
構成要素 | address・int_txt・ext_txt・ext_img・key_field・unsubscribe_url |
属性名 | 内容 | 数値/文字列 |
id | アドレスID | 数値 |
address
配信先のメールアドレスを指定する要素です。
<address device="3">xxxx@xxx.jp</address>
メールアドレス形式ではないデータを設定してもエラーにはなりませんが、配信結果取得で対象の結果を取得することができません。事前にメールアドレス形式であるかを確認のうえ指定してください
属性名 | 内容 | 数値/文字列 | 意味 |
device | デバイスコード | 文字列 | 0:指定なし |
1:PC | |||
2:携帯 | |||
3:iPhone | |||
4:Android | |||
5:WindowsPhone |
メールアドレスに対しデバイス情報を保有している場合は、属性deviceを指定することでデバイスへの配信を最適化します。
例えばauの場合、メールアドレスからは携帯とiPhoneの区別がつかないため、デバイス情報を取得しておき、配信時デバイスを指定すると、画像の添付方法などが最適化されます。
int_txt
個別の差込用データを指定する要素です。メール本文に指定された差込文字列部分に置き換えることができます。
<int_txt id="0">XXXXXX</int_txt>
構成要素 | 文字列 |
属性名 | 内容 | 数値/文字列 |
id | 個別テキストID | 数値 |
ext_data
要素textで指定された共通の差込用データを指定する要素です。メール本文に指定された差込文字列部分に、置き換えることができます。
<ext_txt id="0">0</ext_txt>
構成要素 | 要素textに振られているID |
属性名 | 内容 | 数値/文字列 |
id | 共通テキストID | 数値 |
ext_img
要素imageで指定された共通の差込用データを指定する要素です。メール本文に指定された差込文字列部分に、置き換えることができます。
<ext_txt id="0">0</ext_txt>
構成要素 | 要素imageに振られているID |
属性名 | 内容 | 数値/文字列 |
id | 共通画像ID | 数値 |
【指定可能な差込データとbody本文内への指定方法との関連性について】
要素 | body内の差込文字列 | 差込対象データ | データの指定方法 |
int_txt | ##int_txt_<id>## | 要素int_txtに指定された文字列 | 要素int_txtの属性idに、##int_txt_<id>##の<id>を指定する。 |
ext_txt | ##ext_txt_<id>## | 要素textに指定された文字列 | 要素ext_txtの属性idに##ext_txt_<id>##の<id>を指定し、要素ext_txtに定義した数値で、要素textの属性idを指定する。 |
ext_img | ##ext_img_<id>## | 要素imageに指定されたURL | 要素ext_imgの属性idに##ext_img_<id>##の<id>を指定し、要素ext_imgに定義した数値で、要素imageの属性idを指定する。 |
差込文字列を定義する際に複数の差込文字列を指定する場合、並べて指定してすると正しく変換されません。
必ず半角以上のスペースを入れてください。
(例)##int_txt_1####int_txt_2## にした場合、正しく変換箇所が分割できません。
key_field
配信先ごとに取得したい情報を指定する要素です。配信リスト取得API等で、この情報を合わせて取得することができます。
<key_field>XXXXXXXXX</key_field>
構成要素 | 文字列 ※127Byteが上限となります。 |
unsubscribe_url
ワンクリック登録解除機能で、登録解除リクエストを受理するためのURLを指定することができます。ここに設定されたURLを、List-Unsubscribeヘッダに設定します。
<unsubscribe_url>https://example.com/exampleexample</unsubscribe_url>
構成要素 | 文字列 |
ワンクリック登録解除URLに「%00」という文字列を含むことはできません。URLを作成する際はご注意ください。
- 登録解除リクエストの受理およびその後の処理は、リクエストを受け取ったサーバー側で行う必要があります。
- ワンクリック登録解除設定API の呼び出しは不要です。
- ワンクリック登録解除設定API でFromアドレスが登録済みの場合であっても <unsubscribe_url> に指定されたURLが優先して利用されます。
- ワンクリック登録解除設定API でワンクリック登録解除システムにFromアドレスを登録し、そのFromアドレスでメール配信をおこなった場合、登録解除リクエストの受理は本システムでおこなわれます。
- 本システムで登録解除リクエストを受理したメールアドレスは ワンクリック登録解除者リスト取得API で取得できます。
- 以降の運用において、上記APIで取得したデータを基に、お客様で該当メールアドレスを配信リストから除外する必要があります。
差し込みデータ指定例
<?xml version="1.0" encoding="UTF-8" ?>
<mail>
<auth>
省略
</auth>
<delivery id="0">
<action>reserve</action>
省略
<contents>
<image id="1">http://xxxxxxxx/晴れ.gif</image>
<image id="2">http://xxxxxxxx/雨.gif</image>
<text id="1"><![CDATA[晴れです]]></text>
<text id="2"><![CDATA[雨です]]></text>
<subject><![CDATA[サンプルメルマガ]]><subject>
<body part="text">
<![CDATA[##int_txt_1## ##int_txt_2##さん
今日のお天気は##ext_txt_1##
明日のお天気は##ext_txt_2##]]>
</body>
<body part="html">
<![CDATA[
<html>
<head></head>
<body>
##int_txt_1## ##int_txt_2##さん
今日のお天気は<img src="##ext_img_1##">
明日のお天気は<img src="##ext_img_2##">
</body>
</html>
]]>
</body>
</contents>
<send_list>
<data id="1">
<address device="0">a@xxx.jp</address>
<int_txt id="1">晴れ</int_txt>
<int_txt id="2">男</int_txt>
<ext_txt id="1">1</ext_txt>
<ext_txt id="2">2</ext_txt>
<ext_img id="1">1</ext_img>
<ext_img id="2">2</ext_img>
</data>
<data id="2">
<address device="0">b@xxx.jp</address>
<int_txt id="1">雨</int_txt>
<int_txt id="2">女</int_txt>
<ext_txt id="1">2</ext_txt>
<ext_txt id="2">1</ext_txt>
<ext_img id="1">2</ext_img>
<ext_img id="2">1</ext_img>
</data>
</send_list>
</delivery>
</mail>
- ##int_txt_1##に対応するデータは、int_txtのid=1となる
- ##ext_txt_1##に対応するデータは、ext_txtのid=1で、そこに、textの1を指定
2人にメールが送信され、それぞれ次のような文面となります。
– | a@xxx.jp宛 | b@xxx.jp宛 |
テキストメール | 晴れ男さん 今日のお天気は晴れです 明日のお天気は雨です |
雨女さん 今日のお天気は雨です 明日のお天気は晴れです |
HTMLメール | 晴れ男さん 今日のお天気は☀ 明日のお天気は☂ |
雨女さん 今日のお天気は☂ 明日のお天気は☀ |
テンプレートを利用した場合、テンプレート上に差込文字列(##ext_txt_1##等)を指定しておくことで、同様の差込が実施されます。