CLI
登録フォーム
登録フォームと、それに記入する人に関するすべてのコマンドと実例。
全体の仕組み
登録フォームは、記入した人をオーディエンスに追加します。下書きと公開中のコピーを持ち、update は下書きと設定を変更し、publish は下書きを公開します。読み取りには forms:read、変更には forms:write が必要です。resend-confirmation と、フォームにメールを送信させるすべての変更には、emails:send も必要です。
openemail forms create --name "Newsletter sign-up" --starter newsletter --publishopenemail forms list-submissions frm_3b9d2e7a1c4f80d56e2a9b14 --status pendingopenemail forms analytics frm_3b9d2e7a1c4f80d56e2a9b14 --days 30フォーム
| コマンド | 機能 |
|---|---|
| openemail forms list | フォームの 1 ページを新しい順に、ステータスと数値とともに表示します |
| openemail forms create --name <value> | --starter、--document のファイル、またはメールアドレスのフィールド 1 つから下書きを作ります。--publish を付けるとすぐに公開します |
| openemail forms get <id> | 1 つのフォームを、その下書き、公開中のコピー、設定とともに表示します |
| openemail forms update <id> | 名前、--document の下書き、または --settings-double-opt-in のような任意の設定を、1 回の呼び出しで変更します |
| openemail forms publish <id> | 下書きを公開します |
| openemail forms pause <id> | 公開済みのフォームの登録受付を止めます |
| openemail forms resume <id> | 一時停止中のフォームの受付を再開します |
| openemail forms duplicate <id> | フォームを、その登録を含めずに新しい下書きとしてコピーします |
| openemail forms delete <id> | 確認後にフォームとその登録を削除します。ブラウザでのサインインでは確認コードも求められます |
| openemail forms list-starters | 新しいフォームの出発点にできるひな形 |
| openemail forms get-starter <slug> | 1 つのひな形を、そのドキュメントとともに表示します |
| openemail forms analytics <id> | 表示回数、登録数、追加された人数を、--days か --minutes で指定しない限り 30 日間の期間で表示します |
回答
| コマンド | 機能 |
|---|---|
| openemail forms list-submissions <id> | 登録の 1 ページを新しい順に表示します。--q でメールアドレスを検索し、--status で pending か added を選びます |
| openemail forms get-submission <id> <submission-id> | 1 件の登録を、すべての回答内容とともに表示します |
| openemail forms delete-submission <id> <submission-id> | 確認後に登録を 1 件削除します。その人は連絡先に残ります |
| openemail forms delete-submissions <id> <submission-ids...> | 確認後に登録を最大 200 件削除します |
| openemail forms approve-submission <id> <submission-id> | 確認待ちの登録を、本人の確認なしで追加します。contacts:write も必要です |
| openemail forms resend-confirmation <id> <submission-id> | 直近 10 分以内に送られていなければ、確認待ちの登録に新しい確認リンクをメールで送ります。emails:send も必要です |
誰かを登録する
subscribe は、公開済みのフォームに、そのページと同じように送信します。キーもサインインも不要なので、サインアウトしたままでも動きます。ほかの回答は --data で JSON として渡し、フォームが置かれていたページは --oe-source で渡します。
openemail forms subscribe frm_3b9d2e7a1c4f80d56e2a9b14 --email [email protected] --data '{"first_name":"Ann","consent":true}'回答が欠けているか誤っている場合は終了コード 7 で終わり、各フィールドとその理由を一覧表示します。一時停止中のフォームは 6、1 つのネットワークからの登録が多すぎる場合は 8 で終わります。
