Skip to main content

概要

配信系ツールでは、メール配信・LINE配信のアカウントとシナリオ(配信シーケンス)を管理できます。このページには配信アカウント・シナリオ、配信メッセージ(作成・更新・テスト送信)、配信統計、置き換え文字、読者、ラベル・共通読者に加え、配信アクション(管理画面「アクション管理」)、登録フォーム・読者項目、登録経路・登録経路グループのツールを掲載しています。LINE友だち・1対1チャット・テンプレート・リッチメニュー・自動応答・送信者など LINE 固有のツール(message_line_*)は LINEツール に分けて掲載しています。
配信アカウントの種類は3つあります。

アカウント操作

message_account_list

配信アカウントの一覧を取得します。種類や名前で絞り込みできます。 パラメータ: 指示例:
  • 「配信アカウント一覧を見せて」
  • 「LINE配信のアカウントを検索して」
  • 「“メルマガ”を含むアカウントを探して」

message_account_create

配信アカウントを新規作成します。 パラメータ: 指示例:
  • 「“新商品メルマガ”というメール配信アカウントを作成して」
  • 「LINE配信用のアカウントを作って」

シナリオ操作

message_scenario_list

指定アカウント配下のシナリオ一覧を取得します。タイトルで部分一致検索できます。 パラメータ: 指示例:
  • 「このアカウントのシナリオ一覧を見せて」
  • 「“セミナー”を含むシナリオを検索して」

message_scenario_create

シナリオを新規作成します。 パラメータ:
open_title はフォームの公開ページ等で表示されるタイトルです。未指定の場合は空(null)になります。
指示例:
  • 「“無料メール講座”というシナリオを作成して」
  • 「新しいステップメールのシナリオを追加して」

メッセージ操作

シナリオ配下の配信メッセージ(メール・LINE・SMS・アクション)を作成・編集・削除します。

message_list

指定シナリオ配下のメッセージ一覧を取得します。媒体・配信タイプ・ステータスで絞り込みできます。 パラメータ: 指示例:
  • 「このシナリオの配信メッセージ一覧を見せて」
  • 「下書きのメールだけ表示して」

message_create

メッセージを新規作成します。channel と type は作成後に変更できません。status=reserved(予約)にすると配信安全制御・DKIM/SMS前提チェックが実行されます。
channel=mail のメール本文には配信解除URL(%cancel% または %cancelall%)を必ず含めてください。含めないとバリデーションエラー(validation_error)になります。 また、メール本文・SMS本文に配信済みのメッセージから取得した置換URL、または rid パラメータ付きのURLを含めることはできません(validation_error)。元のURLを指定してください。 status=reserved かつ channel=mail では、mail.from_mail にフリーメール(Gmail・Yahoo!メール等)・携帯キャリアメールのアドレスは指定できません(validation_error)。
主要パラメータ: action_details(メッセージ直下・url_actions の要素)に type=google_spreadsheet を含むとき、Googleスプレッドシート連携が利用できない環境ではエラー bad_request になります。スプレッドシートのタブ名を解決できない場合はエラー validation_error です。いずれも保存前に判定され、失敗時は何も保存されません。 status=reserved で配信予約するときは配信安全制御が実行され、該当するとエラー safety_restriction になります(ステップ配信で step_send_type=immediately のまま予約した、同一シナリオ・同一媒体・同一配信条件で同時刻のステップ配信・リマインダ配信が予約済み、同一シナリオ内で同一配信条件の一斉送信が配信中・1時間以内に配信済み・1時間以内に配信予定)。同じシナリオで別の予約処理が実行中のとき・短時間に多くの配信予約を作成したときはエラー rate_limit_exceeded です(後者は details.retry_after に再試行可能になる日時)。 送信タイミングパラメータ(type 別): type=reminder では base_date・send_timing・send_day・send_hour・send_min が必須です(status=draft でも同じ)。 原稿オブジェクトの構造:
  • mail: {type: "plain_text"|"html", from_name, from_mail, subject, text(plain_text時), elements(html時), preview_text(最大150文字)}。HTMLメールの elements のプロパティ名は element_types_mail / element_types_mail_properties で確認してください。
  • line: {sender_id?, messages: [...](最大5件)}。メッセージタイプ別の項目と制約は message_types_line(リファレンスツール)を参照してください。ボタン(type=message / nothing)の action_details で、ボタンを押した際に実行するアクションをこのメッセージの中で直接作れます(形式・制約はメッセージ直下の action_details と同じ。作成ではボタンの action_id とは同時に指定できません)。type=image / imagemap の画像はサーバーが取り込んで保存し、message_get の original_content_url は保存先のURLに変わります(取り込めない場合はエラー validation_error で何も保存されません)。テキスト本文やボタン・イメージマップのURL・応答テキストに、配信済みのメッセージから取得した置換URL・rid パラメータ付きURLは指定できません(エラー validation_error)。詳細は REST の 配信メッセージ作成 の line(LineContent)の説明を参照してください。
  • sms: {message: "本文(最大360文字、絵文字不可)"}。message は status=reserved のとき必須です(draft では省略できます)。
URLアクションの要素: url_actions はリスト形式の配列で、各要素は本文中のURLを読者が開いた際に実行するアクションと、リンクの期限設定です。 scheduled_addition では expiration_day / expiration_hour / expiration_min のいずれか1つ以上を指定します。期限の種類に関係しない項目は null で保存されます。 指示例:
  • 「明日の10時に一斉送信するメールを作成して」
  • 「登録3日後に届くステップメールを下書きで作って」

message_get

メッセージの詳細情報を取得します。メール本文やHTMLメール要素構造、LINEメッセージ、URLアクションを含みます。 パラメータ: レスポンスの補足:
  • url_actions にはこのメッセージに設定した行のみが含まれます(送信時に自動生成される計測用の行は含まれません)。
  • action_details / url_actions[].action_details / line.messages[] のボタン(actions[]・columns[].actions[])の action_details は、メッセージの中で直接作ったアクション(画面の「新規にアクションを追加」、または message_create / message_update の action_details で作ったもの)が設定されているときだけ動作の配列になり、アクション管理のアクションを参照しているとき・未設定のときは null です。
  • 配列のときの action_id はその設定箇所専用で、message_action_get では取得できず、他のメッセージや他のURLの action_id には指定できません。ボタンの action_id は、取得応答で参照しているボタンの数まで指定できます(別のボタンに移してもよい)。
指示例:
  • 「このメッセージの内容を見せて」
  • 「メールの本文を確認したい」

message_update

既存メッセージを部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。 パラメータ: message_create と同じフィールド群を任意で指定できます。加えて以下が必須です。 注意事項:
  • channel / type は変更できません(既存と異なる値を指定するとエラー validation_error)。
  • 空のボディは何も変更せず、現在値を返します。
  • conditions / url_actions / line.messages は指定すると全件置換されます(省略時は既存維持)。url_actions の置換では、送信時に自動生成される計測用の行は削除されず残ります。
  • status を draft→reserved で予約実行、reserved→draft で予約解除。
  • reserved→draft にする更新では status の保存と配信予約の削除だけが行われ、同じリクエストの他の項目(title / mail / line / sms / conditions / url_actions / action_id / action_details / 送信タイミングなど)は反映されません。他の項目は下書きに戻した後に別のリクエストで更新してください。
  • draft→reserved への変更時と配信予約の再作成時は配信安全制御が実行され、該当するとエラー safety_restriction(条件は message_create と同じ)、同じシナリオで別の予約処理が実行中のとき・短時間に多くの配信予約を作成したときはエラー rate_limit_exceeded(後者は details.retry_after に再試行可能になる日時)になります。
  • 更新後の status が reserved のとき(draft→reserved の変更と reserved のままの更新)、更新後の mail.from_mail がフリーメール(Gmail・Yahoo!メール等)・携帯キャリアメールのアドレスだとエラー validation_error です。
  • reserved 状態で送信日時・条件・A/Bテストを変更すると配信予約が自動で再作成されます。再作成から5分間は再変更できず、エラー cooldown_active(details.retry_after に再試行可能になる日時)が返ります。
  • sending / completed のメッセージは更新できません(エラー conflict)。
  • メール本文・SMS本文に配信済みのメッセージから取得した置換URL、または rid パラメータ付きのURLを含めることはできません(validation_error)。
配信後に実行するアクション(action_id / action_details):
  • action_id はアクション管理に登録済みのアクションを使う場合に指定します(message_action_list で取得。null で解除)。このメッセージだけで使うアクションは action_details で直接指定します。
  • action_details を指定すると、現在このメッセージの中で直接作ったアクション(message_get の action_details が配列)が設定されていればその動作を全件置換し、未設定・アクション管理のアクションを参照中なら新しく作って参照を切り替えます(参照中のアクション管理のアクションは変更されません)。
  • action_details と一緒に送る action_id は省略するか、取得応答の値のままにします(別のIDを指定するとエラー validation_error)。省略・null・空配列は指定なし(外すときは action_id に null)。
  • action_details を付けずに action_id へ指定できるのは、message_action_list の id と、取得応答でその設定箇所に現在設定されているIDだけです(それ以外はエラー validation_error)。
  • url_actions の各要素の action_details も同じ規則です(要素の action_id は省略するか、取得応答の同じ url の要素の値のまま)。本文のURLを変えた場合は、新しい url の要素に action_details を指定し直してください。
  • line.messages のボタンの action_details も同様で、既存のボタンの動作を書き換えるときは取得応答の action_id を付けたまま action_details を指定します(action_id を省略すると新しいアクションを作り、元のアクションはそのボタンから外れます)。項目の定義は message_types_line を参照してください。
  • line.messages を全件置換するとき、type=image / imagemap の画像は取り込み直され、message_get の original_content_url が変わります(message_get の保存先URLをそのまま送り返した画像は再取り込みされません。同じURLの audio は duration を省略でき、更新前の再生時間を引き継ぎます)。詳細は REST の 配信メッセージ更新 の line(LineContent)の説明を参照してください。
  • 動作の内容が検証に合わない(最大件数の超過、配信済みの置換URLを含む本文、解決できないスプレッドシートのタブ名など)ときはエラー validation_error、Googleスプレッドシート連携が利用できない環境で type=google_spreadsheet を含めるとエラー bad_request になります。
指示例:
  • 「このメールの件名を変更して」
  • 「予約を解除して下書きに戻して」

message_delete

メッセージを論理削除します。未送信の配信予約(キュー)は削除されますが、メール原稿・配信条件・URLアクションは保持されます。送信中のメッセージは削除できません。 パラメータ: 指示例:
  • 「このメッセージを削除して」

message_test_send

メッセージのテスト送信を実行します(channel=mail / line / sms のみ。channel=action は非対応でエラー validation_error)。
type=step / type=reminder のメッセージは、設定済みの日時指定を無視して即時テスト送信されます。本番配信のスケジュールはそのまま保持されます。
channel=mail / line では、保存済みの本文(メールは本文、LINEはテキスト・ボタンやイメージマップのURL・ボタン押下時の応答テキスト)に配信済みのメッセージから取得した置換URL、または rid パラメータ付きのURLが含まれていると、送信せずにエラー validation_error になります(channel=sms は対象外)。
パラメータ: 置き換え文字の扱い: 置き換え文字は読者の情報で置換されます。to がこのシナリオの読者として登録されていればその読者の項目で置換します(メール・SMSは配信解除されていない読者が対象。LINEは配信解除済みでも同じ友だちの読者で置換します)。未登録でも、同じ配信アカウント内に同じメールアドレス(SMSは電話番号、LINEは同じ友だち)の読者がいれば、その全シナリオ共通の読者項目とラベルで置換します(シナリオ固有の項目は空、配信基準日時は現在時刻)。該当する読者がいない置き換え文字は空になります。 指示例:
  • 「このメールを自分宛にテスト送信して」

配信統計

メッセージの送信数・開封率・クリック率・配信解除数を取得します。

message_scenario_stats_list

シナリオ内のメッセージごとの配信統計(送信数・開封数・開封率・クリック数・クリック率・解除数)を一覧で取得します。A/Bテスト(メール件名)のパターン別集計も含みます。 パラメータ: 指示例:
  • 「このシナリオのメッセージ別の開封率を一覧で見せて」
  • 「先月の配信成績をまとめて」

message_stats_get

指定したメッセージ単体の配信統計を取得します。date_from / date_to で期間指定できます。 パラメータ: 指示例:
  • 「このメールの開封率とクリック率を教えて」

置き換え文字

message_placeholder_list

シナリオで使用できる置き換え文字(書式は %name%)の一覧を取得します。カテゴリで絞り込みできます。 パラメータ: レスポンスの補足:
  • reader_item の項目には is_filterable(boolean)が付与されます。true の項目のみ message_reader_list / message_reader_list_all の conditions.rules[].key として使用できます。
  • reader_item の項目には field_group(scenario_fields | common_fields)が付与されます。common_fields を更新すると同一人物の全シナリオに波及します。
指示例:
  • 「このシナリオで使える置き換え文字を見せて」
  • 「読者の名前を差し込む置き換え文字を教えて」

読者操作

message_reader_list

シナリオ別の読者一覧を取得します。conditions で配信条件と同じ構造の絞り込みができます(JSON文字列でも可)。 パラメータ: conditions の key 制約: 特別キー(label / scenario / broadcast / tracking / status / base_date 等)に加え、該当シナリオの登録フォームに組み込まれた読者項目(message_placeholder_list で is_filterable=true の reader_item)のみ使用できます。base_datetime は配信条件専用で読者一覧では使用できません。各読者の読者項目は scenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返ります。 指示例:
  • 「このシナリオの読者一覧を見せて」
  • 「“見込み客”ラベルが付いた読者を抽出して」

message_reader_list_all

アカウント配下の全シナリオを横断して読者一覧を取得します。conditions で絞り込みができます(JSON文字列でも可)。 パラメータ: conditions の key 制約: シナリオ横断のため、読者項目で使用できるキーは name / mail のみです(特別キーは使用可)。シナリオ固有の読者項目で絞り込むには message_reader_list を使用してください。 指示例:
  • 「アカウント全体の読者一覧を見せて」
  • 「全シナリオから特定のメールアドレスの読者を探して」

message_reader_get

読者の詳細情報を取得します。読者項目は scenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返り、トップレベルはシステム情報のみです。 パラメータ: 指示例:
  • 「この読者の詳細を見せて」
  • 「読者の登録項目を確認したい」

message_reader_create

指定シナリオに読者を1件登録します。オプトインを取得済みのアドレスのみ登録してください。 パラメータ: 指示例:
  • 「このシナリオに読者を1件登録して」
  • 「メールアドレスと名前を指定して読者を追加して」
読者作成はバーストが発生するため分間レート制限の対象外で、作成上限(エラー hourly_limit_exceeded / monthly_limit_exceeded / total_limit_exceeded)で制御されます。

message_reader_update

読者を部分更新します。リクエストに含めたフィールドのみ変更し、省略したフィールドは既存値を維持します。 パラメータ: 指示例:
  • 「この読者の名前を変更して」
  • 「読者の配信基準日を更新して」

message_reader_label_list

読者に付与されているラベル一覧を取得します。 パラメータ: 指示例:
  • 「この読者に付いているラベルを見せて」

message_reader_label_create

読者にラベルを1件付与します。既に付与済みの場合は付与済みの情報を返します。配信アカウントに存在しないラベルIDはエラー validation_error です。 パラメータ: 指示例:
  • 「この読者に”購入者”ラベルを付けて」

message_reader_label_delete

読者からラベルを1件解除します。配信アカウントに存在しないラベルIDはエラー validation_error、読者に付与されていないラベルを指定するとエラー not_found です。 パラメータ: 指示例:
  • 「この読者から”見込み客”ラベルを外して」

message_reader_scenario_list

同じ読者が登録されている全シナリオの一覧を取得します(このシナリオを含みます)。 パラメータ: 指示例:
  • 「この読者が登録されている他のシナリオを見せて」

message_reader_queue_list

読者の配信予約(今後送信予定のメッセージ)一覧を取得します。 パラメータ: 指示例:
  • 「この読者に今後送信される予定のメッセージを見せて」

message_reader_sent_list

読者への配信済メッセージ一覧を取得します。 パラメータ: 指示例:
  • 「この読者に送信済みのメッセージ履歴を見せて」

message_reader_open_list

読者のメール開封履歴を取得します。 パラメータ: 指示例:
  • 「この読者のメール開封履歴を見せて」

message_reader_click_list

読者のクリック履歴を取得します。 パラメータ: 指示例:
  • 「この読者がクリックしたリンクの履歴を見せて」

ラベル操作

message_label_list

配信アカウント配下のラベル一覧を取得します。名前で部分一致検索できます。 パラメータ: 指示例:
  • 「このアカウントのラベル一覧を見せて」
  • 「“見込み客”を含むラベルを検索して」

message_label_create

ラベルを新規作成します。 パラメータ: 指示例:
  • 「“購入者”というラベルを作成して」

message_label_get

指定したラベルの詳細を取得します。 パラメータ: 指示例:
  • 「このラベルの詳細を見せて」

message_label_update

ラベルを更新します。指定したフィールドのみ変更される部分更新です。 パラメータ: 指示例:
  • 「このラベルの名前を”VIP”に変更して」

message_label_delete

ラベルを削除します。読者へのラベル付与情報は連動して削除されません。 パラメータ: 指示例:
  • 「このラベルを削除して」

共通読者操作

message_common_reader_get

共通読者(同一人物としてまとめられた読者)の詳細を取得します。common_fields は全シナリオ共通の読者項目です。 パラメータ: 指示例:
  • 「この共通読者の情報を見せて」

message_common_reader_update

共通読者のメモと共通項目(common_fields)を更新します。指定したキーのみ変更される部分更新で、更新内容は同一人物が登録している全シナリオに反映されます。 パラメータ: 指示例:
  • 「この共通読者のメモを更新して」

message_common_reader_scenario_list

共通読者が登録している全シナリオの一覧を取得します。 パラメータ: 指示例:
  • 「この読者が登録しているシナリオを見せて」

message_common_reader_label_list

共通読者に付与されているラベルの一覧を取得します。 パラメータ: 指示例:
  • 「この読者に付いているラベルを見せて」

message_common_reader_label_create

共通読者にラベルを1件付与します。既に付与済みの場合は既存の付与情報を返します(冪等)。配信アカウントに存在しないラベルIDはエラー validation_error です。 パラメータ: 指示例:
  • 「この読者に”購入者”ラベルを付けて」

message_common_reader_label_delete

共通読者からラベルを解除します。配信アカウントに存在しないラベルIDはエラー validation_error、付与されていないラベルを指定するとエラー not_found になります。 パラメータ: 指示例:
  • 「この読者から”見込み客”ラベルを外して」

配信アクション

配信アカウント共通の「アクション管理」のアクションを作成・取得・更新・削除します。アクションは順序付きの動作(details)の集合で、配信メッセージの action_id 等から参照します。一覧は message_action_list で取得します。

message_action_list

配信アクション(配信後に実行するアクション。アクション管理に登録されているもの)の一覧を取得します。配信アクションは、配信メッセージ(アクション配信・URLアクション・LINEのボタン)などから実行する処理(シナリオ登録/解除・ラベル付与/解除・Webhook・LINE送信・リッチメニュー切替等)の集合で、ファネルアクション(funnel_action_list などの funnel_action_*)とは別のリソースです。ここで取得した id は配信メッセージの action_id に利用できます。名前の部分一致・グループ・アーカイブ状態で絞り込みでき、動作の内容(details)は message_action_get で取得します。メッセージの中で直接作ったアクション(action_details で作成したもの)は一覧に含まれません。 パラメータ: 指示例:
  • 「このアカウントのアクション一覧を見せて」
  • 「アーカイブしていないアクションを名前で探して」

message_action_create

アクションを作成します。details は動作の配列で、配列順が実行順です。作成したアクションの id は message_create / message_update の action_id に指定できます。 パラメータ: details の要素(type 別の項目。太字は必須。ID は各一覧ツールが返す文字列ID): type=google_spreadsheet は、Googleスプレッドシート連携が使えない環境ではエラー(bad_request)になります。タブ名をシートに解決できないときはエラー(validation_error)で、何も保存されません。 指示例:
  • 「“購入者”ラベルを付けてサンクスシナリオに登録するアクションを作って」
  • 「登録者の情報を Webhook で送るアクションを作成して」

message_action_get

アクションの詳細を動作(details)を含めて取得します。配信メッセージの編集画面内で作成した非表示のアクションは対象外(not_found)です。 パラメータ: 指示例:
  • 「このアクションの動作を見せて」

message_action_update

アクションを部分更新します。指定したフィールドのみ変更され、省略したフィールドは現在の値を維持します。details を指定すると動作は全件置き換えになります(空配列で全削除)。取得応答の details をそのまま送り返した場合、変更の無い動作は参照先の存在確認をせずに保持します。 パラメータ: 指示例:
  • 「このアクションに”見込み客”ラベルを外す動作を追加して」
  • 「使わなくなったアクションをアーカイブして」

message_action_delete

アクションを動作ごと削除します。 パラメータ: 指示例:
  • 「このアクションを削除して」

message_action_group_list

アクショングループ(「アクション管理」の「グループ管理」で作成するグループ)の一覧を表示順で取得します。message_action_create / message_action_update の action_group_id と message_action_list の絞り込みに使います。グループの作成・更新・削除は API では行えません。 パラメータ: 指示例:
  • 「このアカウントのアクショングループ一覧を見せて」

登録フォーム・読者項目

シナリオで使える読者項目の定義(「登録フォーム・読者項目」画面の項目)と、シナリオの登録フォームに組み込む項目を管理します。読者の値ではなく項目の定義を扱います。

message_reader_item_list

シナリオで使える読者項目(全シナリオ共通の項目と、このシナリオ固有の項目)の定義を取得します。各項目は data_type(データ形式)・reserved_word(キー)・field_group(他シナリオ連携)・is_deletable(false は固定項目)を含みます。 パラメータ: 指示例:
  • 「このシナリオの読者項目一覧を見せて」

message_reader_item_create

読者項目を作成します。キー(reserved_word)は free + 連番で自動採番されます。他シナリオ連携(field_group)は作成後に変更できません。 パラメータ: 指示例:
  • 「“会社名”という文字列の読者項目をこのシナリオ固有で作って」

message_reader_item_get

読者項目の定義を取得します。 パラメータ: 指示例:
  • 「この読者項目の定義を見せて」

message_reader_item_update

読者項目を部分更新します。変更できるのは name と data_type だけで、field_group と reserved_word は変更できません(送っても無視)。メールアドレス項目(reserved_word=mail)の data_type は text 固定、既に値が登録されている項目の data_type は変更できません(いずれも validation_error)。 パラメータ: 指示例:
  • 「この読者項目の名称を”勤務先”に変えて」

message_reader_item_delete

読者項目を削除します(論理削除)。固定項目(is_deletable=false)は削除できません(bad_request)。 パラメータ: 指示例:
  • 「この読者項目を削除して」

message_form_item_list

シナリオの登録フォームに組み込まれている項目を表示順で取得します。LINE の配信アカウントでも取得できます。 パラメータ: 指示例:
  • 「このシナリオの登録フォームの項目を見せて」

message_form_item_create

既存の読者項目をシナリオの登録フォームに組み込みます。表示順は末尾になります。「お名前(シナリオ固有)」(reserved_word=reader_name)は組み込めず not_found になります(名前欄は全シナリオ共通の「お名前」を組み込みます)。同じ読者項目を2回組み込むとエラー(conflict)、LINE の配信アカウントではエラー(bad_request)です。 パラメータ: 指示例:
  • 「“会社名”の読者項目を登録フォームに必須で追加して」

message_form_item_bulk_create

複数の項目を登録フォームに一括で組み込みます。items の各要素は、読者項目を新しく作って組み込む(name / data_type / field_group / input_type / is_required / default_value)か、既存の読者項目を組み込む(reader_item_id / input_type / is_required / default_value)のどちらかです。1件でもエラーがあると何も作成されません(エラーの details のキーは items.{位置}.{項目})。表示順は末尾から配列順に採番されます。条件は message_form_item_create と同じで、LINE の配信アカウントではエラー(bad_request)です。 パラメータ: 指示例:
  • 「登録フォームに”会社名”と”部署”の項目をまとめて追加して」

message_form_item_reorder

登録フォーム項目の表示順を一括で変更します。message_form_item_list で取得できる全項目の ID を表示順に並べて指定します(過不足があるとエラー validation_error)。LINE の配信アカウントではエラー(bad_request)です。 パラメータ: 指示例:
  • 「登録フォームの”会社名”を名前の次に移動して」

message_form_item_get

登録フォーム項目を取得します。 パラメータ: 指示例:
  • 「この登録フォーム項目の設定を見せて」

message_form_item_update

登録フォーム項目を部分更新します。変更できるのは input_type / is_required / default_value で、reader_item_id は変更できません(送っても無視)。表示順は message_form_item_reorder で変更します。LINE の配信アカウントではエラー(bad_request)です。 パラメータ: 指示例:
  • 「登録フォームの”電話番号”を必須にして」

message_form_item_delete

登録フォーム項目を削除します(登録フォームから外します。読者項目の定義は残ります)。LINE の配信アカウントではエラー(bad_request)です。 パラメータ: 指示例:
  • 「登録フォームから”部署”の項目を外して」

登録経路

シナリオの登録経路と、登録経路グループ(「登録経路」の「グループ管理」で作成するグループ)を作成・取得・更新・削除します。一覧は message_tracking_list、登録経路分析は message_tracking_stats で取得します。

message_tracking_list

シナリオに紐づく登録経路の一覧を取得します。各登録経路には登録用の url・種類(type: mail/line)・所属するグループ(tracking_group_id)・広告連携設定(ads_setting_id / ads_event)・登録時のラベル自動付与の設定(auto_label_type / auto_label_name)を含みます。配信条件の tracking や message_reader_update の message_tracking_id など、登録経路IDを指定する操作のID取得元です。作成・更新・削除は message_tracking_create / message_tracking_update / message_tracking_delete で行います。 パラメータ: 指示例:
  • 「このシナリオの登録経路一覧を見せて」

message_tracking_stats

登録経路別のアクセス数・登録数を取得します。 パラメータ: 指示例:
  • 「登録経路ごとの登録数を見せて」
  • 「今月の流入経路別の実績を確認したい」

message_tracking_create

登録経路を作成し、登録用の url を発行します。type(種類)はメールの配信アカウントでは mail、LINE の配信アカウントでは line が既定で、他の値はエラー(bad_request)。メール・LINE併用の配信アカウントでは必須です。広告連携は ads_setting_id と ads_event で指定し、省略するとコンバージョンを送信しません。コンバージョンを送信するのは type=line の登録経路で LINE 登録されたときだけで、type=mail の登録経路に指定しても保存されるだけで送信されません。登録時のラベル自動付与(auto_label_type)は、この登録経路で登録された読者に、このシナリオの配信アカウントで同じ名前(完全一致)のラベルを探して付与し、無ければ新規に作成して付与します。 パラメータ: 指示例:
  • 「このシナリオに”Instagram広告”という登録経路を作って URL を教えて」
  • 「登録時に”セミナー経由”ラベルが付く登録経路を作成して」

message_tracking_get

登録経路の詳細を登録用の url を含めて取得します。 パラメータ: 指示例:
  • 「この登録経路の URL を見せて」

message_tracking_update

登録経路を部分更新します。送った項目のみ更新されます。type と広告連携は現在の値から変わるときだけ検証するため、取得応答をそのまま送り返せます。広告連携を外すときは ads_setting_id と ads_event の両方に null を送ります。コンバージョンを送信するのは type=line の登録経路で LINE 登録されたときだけで、type=mail の登録経路に指定しても保存されるだけで送信されません。auto_label_type を custom 以外に変えると auto_label_name は null になり、custom に変えるときは auto_label_name も同じリクエストで指定します(省略するとエラー validation_error)。 パラメータ: 指示例:
  • 「この登録経路を”広告”グループに移して」
  • 「この登録経路の広告連携を外して」

message_tracking_delete

登録経路を削除します。この登録経路を参照している読者・アクセス記録・配信条件は変更されません。 パラメータ: 指示例:
  • 「この登録経路を削除して」

message_tracking_group_list

登録経路グループの一覧を表示順で取得します。message_tracking_create / message_tracking_update の tracking_group_id に使います。 パラメータ: 指示例:
  • 「このシナリオの登録経路グループ一覧を見せて」

message_tracking_group_create

登録経路グループを作成します。表示順は末尾になります。登録経路の所属は message_tracking_create / message_tracking_update の tracking_group_id で指定します。 パラメータ: 指示例:
  • 「“広告”という登録経路グループを作って」

message_tracking_group_get

登録経路グループの詳細を取得します。 パラメータ: 指示例:
  • 「この登録経路グループの詳細を見せて」

message_tracking_group_update

登録経路グループを部分更新します。name に null を送ると名称なしになります(画面で名称を空にして保存したグループの取得応答をそのまま送り返せます)。 パラメータ: 指示例:
  • 「この登録経路グループの名前を”SNS”に変えて」

message_tracking_group_delete

登録経路グループを削除します。登録経路が1件でも所属しているグループは削除できません(conflict)。先に message_tracking_update の tracking_group_id で所属する登録経路を未分類か別のグループに移してください。 パラメータ: 指示例:
  • 「使っていない登録経路グループを削除して」