data要素(配信予約) – アララメッセージ api v1

配信対象者の情報を指定するための要素です。

<send_list>
  <data id="1">
    <address device="3">xxx@example.com</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/xxxxxxxx</unsubscribe_url>
  </data>
</send_list>

構成要素(data)
差し込みデータ指定例

構成要素(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">xxx@example.com</address>

メールアドレス形式ではない値を設定してもエラーにはなりませんが、配信結果取得APIでそのアドレスの結果を取得できません。事前にメールアドレス形式であることを確認したうえで指定してください。

属性名	内容	数値/文字列	意味
device	デバイスコード	文字列	0:指定なし
			1:PC
			2:携帯
			3:iPhone
			4:Android
			5:WindowsPhone

メールアドレスごとにデバイス情報を保持している場合は、属性deviceを指定することで、各デバイスに最適化した配信を行えます。
例えばauのメールアドレスでは、アドレスだけからは携帯とiPhoneの区別がつきません。そのためあらかじめデバイス情報を取得しておき、配信時にdeviceを指定することで、画像の添付方法などを最適化できます。

int_txt

個別の差し込み用データを指定する要素です。メール本文内の差し込み文字列を、この値に置き換えることができます。

<int_txt id="0">XXXXXX</int_txt>

構成要素

文字列

属性名	内容	数値/文字列
id	個別テキストID	数値

ext_txt

要素textで定義された共通の差し込み用データを参照する要素です。メール本文内の差し込み文字列部分を、要素textで定義した値に置き換えることができます。

<ext_txt id="0">0</ext_txt>

構成要素

要素textに振られているID

属性名	内容	数値/文字列
id	共通テキストID	数値

ext_img

要素imageで定義された共通の差し込み用画像データを参照する要素です。メール本文内の差し込み文字列を、要素imageで定義した画像URLに置き換えることができます。

<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/xxxxxxxx</unsubscribe_url>

構成要素

文字列

注意
ワンクリック登録解除用のURLに「%00」という文字列を含めることはできません。URLを作成する際はご注意ください。

補足説明： <unsubscribe_url> を指定する場合

登録解除リクエストの受け付けとその後の処理は、リクエストを受け取るサーバー側で実装する必要があります。
ワンクリック登録解除設定API の呼び出しは不要です。
ワンクリック登録解除設定API でFromアドレスが登録済みの場合でも、<unsubscribe_url> に指定されたURLが優先して利用されます。
<unsubscribe_url>に文字列が指定されていない場合、ワンクリック登録解除用ヘッダは付与されません。

補足説明： <unsubscribe_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">https://example.com/晴れ.gif</image>
      <image id="2">https://example.com/雨.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">aaa@example.com</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">bbb@example.com</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人にメールが送信され、それぞれ次のような文面となります。

–	aaa@example.com宛	bbb@example.com宛
テキストメール	晴れ男さん今日のお天気は晴れです明日のお天気は雨です	雨女さん今日のお天気は雨です明日のお天気は晴れです
HTMLメール	晴れ男さん今日のお天気は☀ 明日のお天気は☂	雨女さん今日のお天気は☂ 明日のお天気は☀