Variations (A/B Testing)

このエンドポイントで作成中のマーケティングメールに新しいバリエーションを追加します。これらのバリエーションはA/Bテストで使用されます(スプリットテストと呼ばれることもあります)。


add

新しいバリエーションを作成します。

URI引数 必須 条件 説明
name Yes ドラフトモードの作成済みのマーケティングメール バリエーションを追加するマーケティングメールの名前
variation Yes なし 追加するバリエーションの名前
subject Yes なし 追加するバリエーションで使用する件名
text Yes なし 追加するバリエーションで使用する本文のテキストパート
html Yes なし 追加するバリエーションで使用する本文のHTMLパート
type Yes “text”または”html” バリエーションのタイプ。プレーンテキストまたはmultipart alternativeのテキストとHTML
identity_name No 作成済みのマーケティングメールのアイデンティティ 作成済みのマーケティングメールが存在しない場合、アイデンティティの名前が必要です。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/add.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&type=html&variation=variation_name&subject=variation_subject&html=variation_body

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/add.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&type=html&variation=variation_name&subject=variation_subject&html=variation_body

Response

1
2
3
<result>
   <message>success</message>
</result>

edit

作成済みのバリエーションを編集します。

URI引数 必須 条件 説明
name Yes バリエーションを追加する作成済みのマーケティングメール バリエーションを編集するマーケティングメールの名前
variation Yes 作成済みのバリエーション 編集するバリエーションの名前。Variations List APIで取得できるnameの値
newvariation No なし バリエーションの新しい名前
subject No なし バリエーションの新しい件名
text No なし バリエーションの新しい本文のテキストパート
html No なし バリエーションの新しい本文のHTMLパート
type No “text”または”html” バリエーションのタイプ
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/edit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&type=html&variation=existing_variation_name&newvariation=new_variation_name&subject=variation_subject&html=variation_body

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/edit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&type=html&variation=existing_variation_name&newvariation=new_variation_name&subject=variation_subject&html=variation_body

Response

1
2
3
<result>
   <message>success</message>
</result>

get

作成済みのバリエーションのコンテンツを取得します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール マーケティングメールの名前
variation Yes 作成済みのバリエーション 取得したいバリエーションの名前。Variations List APIで取得できるnameの値
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/get.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=existing_variation_name

Response

1
2
3
4
5
6
7
8
9
10
11
12
{
  "name": "existing_variation_name",
  "timezone_id": null,
  "text": null,
  "is_winner": 0,
  "nl_type": 2,
  "html": null,
  "schedule_status": 3,
  "type": "html",
  "id": 2256144,
  "subject": "variation_subject"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/get.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=existing_variation_name

Response

1
2
3
4
5
6
7
8
9
10
11
<variation>
   <name>existing_variation_name</name>
   <timezone_id/>
   <text/>
   <is_winner>0</is_winner>
   <nl_type>2</nl_type>
   <schedule_status>3</schedule_status>
   <type>html</type>
   <id>2256144</id>
   <subject>variation_subject</subject>
</variation>

cancel

送信処理中のバリエーションをキャンセルします。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール キャンセルしたいマーケティングメールの名前。バリエーションをキャンセルします。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/cancel.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/cancel.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft

Response

1
2
3
<result>
   <message>success</message>
</result>

delete

作成済みのバリエーションのコンテンツを削除します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール バリエーションが追加されている作成済みのマーケティングメールの名前
variation No 作成済みのバリエーション 削除するバリエーションの名前。Variations List APIで取得できるnameの値
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/delete.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_to_delete

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/delete.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_to_delete

Response

1
2
3
<result>
   <message>success</message>
</result>

list

マーケティングメールに追加された全てのバリエーションのリストを取得します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール バリエーションのリストを取得するマーケティングメール
variation No 作成済みのバリエーション チェックしたいバリエーションの名前
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/list.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_to_find

Response

1
[{"name": "copy of SUZ5PT"},{"name": "5XZyGo"}]

Call

POST https://api.sendgrid.com/api/newsletter/variations/list.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_to_find

Response

1
2
3
<result>
   <message>success</message>
</result>

pickwinner

送信したいバリエーションを選択します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール バリエーションを選択するマーケティングメールの名前
variation Yes 作成済みのバリエーション バリエーションの指定。Variations List APIで取得できるnameの値
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/pickwinner.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_that_wins

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/pickwinner.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_that_wins

Response

1
2
3
<result>
   <message>success</message>
</result>

schedule

送信時刻のスケジュールとバリエーションの割合を指定します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール バリエーションのテストをスケジュールするマーケティングメールの名前
percent Yes 0-100 このテストでメール送信する全受信者に対する割合
delay No 数字 遅延時間。delay_typeで指定する単位の値
delay_type No “minutes”, “hours”, または “days” delayで使用される単位
date No ISO8601フォーマット(YYYY-mm-ddTHH:MM:SS+-HH:MM)で指定した日時 マーケティングメールを送信する日時
timezone No Must be an existing Variation dateで指定した日付のタイムゾーン(オルソンデータベース形式フォーマット)
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/variations/schedule.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&percent=50

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/variations/schedule.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&percent=50

Response

1
2
3
<result>
   <message>success</message>
</result>