参照ツールでは、メッセージ・ページの作成/更新時に指定する要素タイプやメッセージタイプ、配信条件の定義を取得できます。element_types_mail でHTMLメールの要素タイプ、message_types_line でLINEメッセージタイプ、message_condition_types で配信条件・読者絞り込みの条件キーを参照し、各ツールの elements / messages / conditions パラメータを組み立てる際の手がかりにします。
すべての要素・タイプリファレンスツールは認証不要(APIキー不要)で利用できます。
HTMLメール要素リファレンス
element_types_mail
HTMLメールの要素タイプ一覧を取得します。デフォルトは基本カテゴリ(layout, content)のみを返す軽量レスポンスです。
パラメータ:
| パラメータ | 型 | 必須 | 説明 |
|---|
include | string | - | 拡張カテゴリのカンマ区切り。HTMLメールで有効なのは template(お気に入りテンプレート用要素)のみ |
includeの値:
| 値 | 説明 |
|---|
template | お気に入りテンプレート用の要素(デフォルトでは返りません) |
// テンプレート要素も含めて取得
include=template
ファネル用の payment / event などのカテゴリはHTMLメールには存在しません。HTMLメールで指定できる拡張カテゴリは template のみです。
指示例:
- 「HTMLメールで使える要素の種類を見せて」
- 「テンプレート要素も含めて取得して」
element_types_mail_properties
指定したHTMLメール要素タイプのプロパティ定義を取得します。要素に設定可能なプロパティ(色・サイズ・配置等)の詳細仕様を返します。
パラメータ:
| パラメータ | 型 | 必須 | 説明 |
|---|
types | string | 必須 | 要素タイプ名のカンマ区切り(例: text,button,image)。空または未対応タイプを含む場合は422 |
// テキストとボタンのプロパティを取得
types=text,button
レスポンス構造:
| フィールド | 説明 |
|---|
data.global_common_properties | 全要素共通のプロパティ |
data.content_common_properties | コンテンツ要素共通のプロパティ |
data.element_types | 指定した各要素タイプのプロパティ定義 |
レスポンスは各プロパティを properties 配列にメタ情報付きで返しますが、これは「そのタイプに存在するプロパティの一覧」です。実際にメッセージ作成・更新で elements を指定する際は、properties キーで包まず各プロパティをフラットに記述してください(properties キーを付けると400エラーになります)。
指示例:
- 「メールのボタン要素で設定できるプロパティを教えて」
- 「テキスト要素と画像要素のプロパティ定義を取得して」
LINE・配信条件リファレンス
message_types_line
**プレビュー機能。**仕様は今後変更される可能性があります。
LINEメッセージの作成・更新時に使用可能なメッセージタイプとパラメータ定義を取得します。テキスト・スタンプ・画像・イメージマップ・ボタン・カルーセル・音声・動画の8タイプの定義と、ボタン/カルーセルで使えるアクションタイプの定義を含みます。
パラメータ: なし
レスポンス構造:
| フィールド | 説明 |
|---|
data.max_messages | 1メッセージに含められるLINEメッセージの最大件数(5) |
data.sender_id | 送信者ID指定の定義 |
data.message_types | メッセージタイプ定義(text / sticker / image / imagemap / button / carousel / audio / video) |
data.action_types | アクションタイプ定義(url / friendmessage / message / template / nothing) |
data.action_common_options | アクション共通オプション定義(action_id / add_label_id / del_label_id / reserved_word / update_value) |
指示例:
- 「LINEメッセージで使えるタイプを教えて」
- 「カルーセルのボタンに設定できるアクションを確認したい」
message_condition_types
**プレビュー機能。**仕様は今後変更される可能性があります。
配信条件・読者絞り込みで使用可能な条件キー・演算子・値の型を取得します。メッセージ作成/更新の conditions パラメータや、読者一覧の conditions パラメータを組み立てる際に参照します。
パラメータ: なし
レスポンス構造:
| フィールド | 説明 |
|---|
data.structure | 条件構造の説明(conditions[].rules[].{key,condition,value} 形式) |
data.condition_keys | 条件キー定義(label / scenario / status / broadcast / tracking / base_date / base_datetime) |
data.reader_item_conditions | 読者項目(置き換え文字)による条件指定の定義 |
各条件キーには利用可能な場面(available_in)が含まれます。delivery は配信条件、reader は読者一覧で使用可能です。base_datetime は配信条件専用で、読者一覧では使用できません。
指示例:
- 「配信条件に使える項目を教えて」
- 「ラベルで絞り込む条件の書き方を知りたい」