メルマガを取得する
このピースでできること
- ferret One のメルマガに関する情報を取得します。
- 取得対象を選ぶだけで、配信メール一覧・1通の配信結果・URL別クリック結果のいずれかを取得できます。
- 配信実績の集計や、スプレッドシートへの転記などに使えます。
ferret Oneの接続方法
- 「webhookを受信する」のピースではAPI keyは不要です。
- ferret OneのAPI管理画面のサイドバーから 設定・管理>外部連携設定>API/他 を選択する。画面真ん中の「APIキーを作成」をクリックします。
- API keyの名前をつけます。
- API keyが表示されるのでメモします。二度と表示されないのでメモを忘れないようにしてください。
- workrunのferret Oneピースの接続でAPI keyを貼り付ける。
ピースの設定項目
1. 取得対象（必須）
- 何を取得するかを選びます。ここの選択によって、次の「条件」の入力欄が切り替わります。
- 配信メール一覧：条件に合うメルマガを一覧で取得します
- 1通の配信結果：メールIDを指定して、その1通の配信結果を取得します
- URL別クリック結果：メール内のURLごとのクリック実績を取得します
- 1通の配信結果＋URL別クリック結果：上記2つをまとめて取得します
[設定例]
2. 条件（任意）
「取得対象」で選んだ内容に応じて、入力欄が自動的に切り替わります。
「配信メール一覧」を選んだ場合
- メールID：特定のメルマガのみに絞り込む場合に指定します
- メールタイトル(管理用)：入力内容で部分一致検索します
- 件名：入力内容で部分一致検索します
- 配信ステータス：下書き・配信予約・配信中・配信済み・エラー・停止 から選びます
- 配信対象セグメント：複数選択できます
- 配信日時 開始／終了：指定した期間に配信されたメールに絞り込みます
- 送信日時で並び替える：オンにすると送信日時順で並びます
- 並び順：昇順または降順（初期値は降順）
- 取得データ上限：1〜100まで。未入力の場合は50件です
- 取得データページ：1以上の整数。例えば2を指定すると2ページ目を取得します
「1通の配信結果」「URL別クリック結果」「1通の配信結果＋URL別クリック結果」を選んだ場合
- メールID（必須）：「配信メール一覧」の実行結果に表示される id、またはメルマガ管理画面のURL内にある 以降の文字列から確認できます
⚠️ 「URL別クリック結果」は、まだ配信されていないメール（下書き・配信予約中など）に対して実行するとエラーになります。配信済みのメールを指定してください。
[設定例]