サインアップフォーム:フォームを仕様として保存する
英語から自動翻訳されています。
英語で読むサインアップフォームの仕様は、フォームが何を求めるかを画面ごとに示します。各フィールドのフィールドカタログのセクション、ラベル、必須かどうか、テスト ID です。アプリで作成するか、説明やフォームのスクリーンショットからコーディングエージェントに作成させ、プロジェクトに保存します。保存時は、すでにフィールドを入力しているカスタムフィールドを使い、ないものは新たに作成します。これにより form_values は安全に入力できるすべてのフィールドを入力し、残りはテストに任せます。
1 つのプロジェクトには最大 20 個のサインアップフォームを保存できます。
エージェントで作成する
Section titled “エージェントで作成する”エージェントに build_signup_form_from_screenshot プロンプトを実行するよう頼み、フォームの各画面のスクリーンショットを共有します。エージェントがフィールドを読み取り、修正できるよう仕様を表で示し、あなたが承認してから保存します。
スクリーンショットはエージェントの手元にとどまります。Proxy Mail QA に送られるのは、あなたが承認した仕様だけです。
代わりにフォームを説明することもできます。例:「メール、パスワード、会社の規模、利用規約のチェックボックス、続いて 2 画面目に役職」。
アプリ内で作成する
Section titled “アプリ内で作成する”Project settings → Forms を開き、新しいフォーム を選びます。スターターまたは空のフォームから始めて、次の操作をします。
- カタログから各画面にフィールドを追加し、ラベルを変更し、必須かどうかを設定する
- フィールドのオプションボタンでオプションを設定する:パスワードの長さと必要な文字、最低年齢、国、ドロップダウンの選択肢など
- 画面を追加し、それぞれに見出しとページのパスを設定する
- プレビュー で表示を、コード でコードを、テスト でテストを確認する(それぞれコピーできます)
空のラベルはフォームの言語に従います。各フィールドには、Proxy Mail QA、既製のカスタムフィールド、テストのどれで入力されるかが表示されます。フォームを保存すると、カスタムフィールドで入力されるフィールドにはその名前と、Project settings → Custom fields で開く 開く が表示され、そのカスタムフィールドがオフの場合はそのことも表示されます。標準フィールド のいずれかでオフにされたフィールドにはその旨と、標準フィールドへのボタンが表示されます。電話番号、ID 番号、税番号のフィールド、選択肢、利用規約のチェックボックスは 既製フィールド で入力されます。フォームが作成したもの、テスト ID によるもの、またはその種類のフィールド用のプロジェクト独自のものです。電話番号フィールドには、テストが入力する場合にその旨が表示されます。プロジェクトの電話番号は、英国、オーストラリア、米国、カナダではフィクション用に確保された番号を、その他の国ではアプリのテスト用番号を入力し、どちらもない国では空のままにします。
カスタムフィールド では、フォームが作成した各カスタムフィールドにフォーム名の 作成元 タグが付き、そこからフォームを開けます。自分で作成したもので、フォームがそのまま使っているものには 使用元 タグが付きます。
フォームとカスタムフィールド
Section titled “フォームとカスタムフィールド”フォームはサインアップページを表します。コード、テスト、プレビューのための画面、フィールド、ラベル、テスト ID です。カスタムフィールドは、フォームの有無にかかわらず、毎回の入力でフィールドに何を入れるかを決めます。フォームが同じフィールドに 2 つ目のカスタムフィールドを必要とすることはありません。
- 既存のものを使います。 プロジェクトの既製の電話番号や、会社の規模を尋ねる質問用の独自ルールなど、カスタムフィールドがすでにフィールドを入力している場合、保存時にそれを使います。既製のものを作成するのは、そのフィールドを入力するものがない場合だけです。
- 黙ってあなたのものを上書きすることはありません。 フォームが作成した既製フィールドが自分のカスタムフィールドより優先される場合(フォームの保存後に独自ルールを追加した場合など)、フォームのフィールドの上とそのフィールドにその旨が表示されます。自分のものを使う を選ぶと、保存時にフォームのものを削除します。フォームのものを使う を選ぶとフォームのものを残し、以後は確認しません。カスタムフィールド では、自分のフィールドに 競合 タグが付き、そこからフォームのそのフィールドを開けます。
- 保存時に整理します。 フィールドを削除した、テスト ID を変更した、自分のものを選んだなどの理由で、フォームが作成したカスタムフィールドを使わなくなった場合、保存時にまず確認します。新しいテスト ID に移す、削除する、残すのいずれかを選びます。カスタムフィールドを変更できるのがリードだけの場合、メンバーはリードに削除を依頼します。
エージェントも save_signup_form で同じことをします。応答の fields_filled_by は各フィールドを何が入力するかを示し、clashes と leftovers はあなたの判断を待ちます。エージェントがあなたに確認し、choices または tidy で再度保存します。それまでは何も削除されません。
カスタムフィールドが答える質問
Section titled “カスタムフィールドが答える質問”チームに必要な席数など、自分のカスタムフィールドがすでに答えている独自の質問は、Add a field → Your custom fields から追加します。フォームはそのフィールドをコード、テスト、プレビューに含め、毎回の入力で何を入れるかは引き続きカスタムフィールドが決めます。フィールドにはカスタムフィールドの名前が付き、カスタムフィールドがテスト ID でフィールドを探す場合はそのテスト ID も付きます。テキストボックス、ドロップダウン、チェックボックスのどれにするかを選びます。フィールドには、カスタムフィールドがそれを見つけられるかどうかが表示され、ラベルやテスト ID を変えたために見つけられない場合は、カスタムフィールドが何を探しているかが表示されます。
エージェントは、セクション custom、list_custom_fields のカスタムフィールドの ID、ラベル、options.type を指定して追加します。fields_filled_by の finds は、カスタムフィールドがそれを見つけられるかどうかを示します。既製フィールドはこの方法では追加しません。そのフィールド専用のセクションを使ってください。
スクリーンショットがある場合は、プロンプトをコピー で、スクリーンショットと一緒にコーディングエージェントに貼り付ける 1 行を取得できます。エージェントがスクリーンショットを読み取り、Proxy Mail QA には送られません。開く を使うと、Qoder、Cursor、VS Code(1.140 以降)、または Claude がその行を入力済みの状態で開きます。そこでスクリーンショットを追加してから送信してください。送信するまで何も送られません。そのいずれかからこのプロジェクトに Proxy Mail QA を接続している場合は、Qoder で開く のような専用のボタンが表示されます。
空のフォームの代わりに、8 つの仕様のいずれかから始められます。エージェントは list_signup_starters で一覧を表示し、アプリでは 新しいフォーム で選べます。
| スターター | 求める内容 |
|---|---|
b2c |
一般消費者向けアプリ:名前、メール、パスワード、生年月日、利用規約、任意のマーケティング用チェックボックス |
b2b |
B2B SaaS:まずアカウント、次に会社名、ウェブサイト、役職、チームの規模、国、VAT 番号、会社登録番号 |
education |
中立的な年齢の質問(「13 歳以上ですか?」ではなく生年月日)と、年少の学習者向けの保護者のメールアドレス |
marketplace |
販売者のアカウント、次にその事業:種類、国、住所、生年月日、税番号、支払い先口座 |
travel |
航空会社が事前に送る乗客情報(APIS):ICAO の架空の国 Utopia のパスポートとその有効期限 |
fintech |
米国向けの本人確認に必要な情報:法的氏名、生年月日、電話番号、住所、国民 ID 番号 |
japan |
日本のフォーム:姓が先、カタカナの読み、続いてメール、パスワード、生年月日、電話番号、住所 |
china |
中国のフォーム:電話番号が先、続いてパスワード、氏名、実名制のための居民身分証番号 |
それぞれにメモが付いています。たとえば、Google や LINE でのサインインボタンをどこに置くか(これらはフィールドではありません)、どの値が決済プロバイダーのテストモードから来るかなどです。別の言語や国のものを求めると、ラベル、ドロップダウン、ID の形式もそれに合わせます。自分のバージョンを保存するまで何も保存されません。
フィンテックのフォームでは、スターターを KYC サンドボックスモードと組み合わせてください。form_values に kyc_sandbox を指定すると、ベンダー独自のサンドボックス値(Stripe、Plaid、Onfido、Veriff、Didit、Cashfree、Setu)を合格、不合格、審査用に返し、作成される新しいアドレスにはベンダーの氏名と生年月日が使われます。Proxy Mail QA が本人確認をすることはありません。値は各ベンダーのサンドボックスが想定するものと一致するだけです。国別のフィールド形式 を参照してください。
仕様に含まれるもの
Section titled “仕様に含まれるもの”{ "name": "Main sign-up", "site": "https://staging.example.com/*", "language": "en", "screens": [ { "path": "/signup", "fields": [ { "section": "email" }, { "section": "password", "options": { "min_length": 12, "classes": ["upper", "digit"] } }, { "section": "business.team_size", "options": { "choices": ["1-10", "11-50", "51-200"] } }, { "section": "consent.terms" } ] } ]}| 項目 | 内容 |
|---|---|
name |
フォームの名前。同じ名前でフォームを保存すると、そのフォームが変更されます |
site |
プロジェクトに登録されている、フォームがあるサイト。省略すると、すべてのサイトでフォームのフィールドに一致させます |
language |
デフォルトのラベルに使うフォームの言語:en、de、fr、es、it、pt、nl、zh、ja |
country |
国に依存するフィールド(ID、VAT 番号、電話番号、住所)のための 2 文字の国コード |
screens |
順番に並んだ最大 10 画面。それぞれに任意の title、path と最大 30 個のフィールドを持ち、全体で最大 60 フィールドです |
| フィールド | section、required(指定しない限り true)、label、testid、options。各セクションは 1 回ずつです |
フィールドのラベルは、既定ではフォームの言語でのセクションのラベルになります。テスト ID は既定で signup- にセクション ID をダッシュでつないだもの(例: signup-business-team-size)になります。
セクションが custom のフィールドは、代わりにカスタムフィールドの 1 つを指定します(例: { "section": "custom", "custom_field": "<its id>", "label": "Seats", "options": { "type": "select", "choices": ["1-5", "6-20"] } })。ラベルが必要で、テスト ID は既定で signup- にラベルをダッシュでつないだもの(例: signup-seats)になります。
オプションは、それを受け付けるセクションにだけ指定できます。パスワードには min_length、max_length、classes(lower、upper、digit、symbol)、生年月日には min_age、国によって変わるフィールドには country、ドロップダウンやラジオグループには choices です。
各フィールドの入力方法
Section titled “各フィールドの入力方法”get_signup_form と GET /v1/project/signup-forms/{id} は、各フィールドの値の入れ方を示します。
| 入力 | 意味 |
|---|---|
built_in |
form_values と Proxy Mail QA for Chrome はテスト人物の情報(名前、メール、パスワード)で入力します |
custom_field |
カスタムフィールドで入力します。既製のもの、またはセクション custom ではフィールドが指定するものです |
never |
Proxy Mail QA はテスト側に任せます |
カスタムフィールドが付くのは custom_field セクションだけで、既製のものです。電話番号、ID 番号、税番号、性別、言語、知ったきっかけ、役職、チームの規模、業種、規約のチェックボックスです。フォームは、プロジェクトに既製のものがあればそれを使います。たとえば、リードが Project settings → Custom fields で追加した ID 番号や税番号のフィールド、または update_project の fill_id_fields で 5 つまとめて追加したものです。フォームが作る各カスタムフィールドはテスト ID でフィールドを見つけるので、フォームに data-testid 属性を追加してください。フォームを削除しても、一緒に削除するよう指定しない限りカスタムフィールドは残ります。アプリでは「削除」ダイアログの 作成したカスタムフィールドも削除する にチェックが入っています。エージェントと API は remove_custom_fields を送ります。ほかのフォームがまだ使っているカスタムフィールドは残ります。カスタムフィールドをリードだけが変更できる場合、メンバーが削除すると、代わりにリードに削除を依頼します(作成したカスタムフィールドの削除もリードに依頼する)。依頼は 1 つずつで、リードは Project settings → Custom fields で対応します。それ以外の場合、ほかの人が追加したカスタムフィールドは残ります。
コードとして取得する
Section titled “コードとして取得する”エージェントは get_signup_form_code で、保存したフォームをアプリ用のコードに変換できます。種類は次の 3 つです。
| 形式 | 得られるもの |
|---|---|
react-hook-form |
react-hook-form と zod スキーマを使う React コンポーネント(既定) |
react |
ほかのパッケージを使わず、通常の state を使う React コンポーネント |
html |
スクリプトを含む 1 つの HTML ページ |
各フィールドは、仕様が求める内容をチェックします。パスワードのルール、生年月日の年齢、その国の ID 番号や VAT 番号の形式とチェックディジットです。メッセージとボタンはフォームの言語で表示されます。画面は「次へ」と「戻る」で順に表示されます。どのフィールドも data-testid を保つので、フォームのカスタムフィールドがそれを見つけられます。
ID のチェックは、入力中の手助けとしてブラウザで実行されます。サーバー側でもチェックしてください。
エージェントはコードをアプリに合わせます。テスト ID とルールはそのままに、あなたのコンポーネントとスタイルを使います。回答の notes には、確認すべき点が書かれています。たとえば、ドロップダウンがまだ標準の選択肢のままになっている場合などです。
テストを取得する
Section titled “テストを取得する”get_signup_form_test は、保存したフォームのテストを Playwright(既定)または Cypress 向けに出力します。各フィールドについて、ほかのフィールドを正しく入力したうえで、受け付けるべき値と拒否すべき値を 1 つずつ試します。
- 必須フィールドが空のとき
- @ がない、または @ の後にドットがないメールアドレス
- 1 文字足りないパスワードと、仕様が求める文字の種類をそれぞれ欠いたパスワード
- 明日最低年齢に達する人の生年月日と、今日達した人の生年月日
- チェックディジットが違う、1 文字足りない、数字の位置に文字がある ID 番号や VAT 番号
- アクセント記号やアポストロフィを含む名前と、別の書き方をした電話番号(フォームが受け付けるべきもの)
テストは開始前に、ペルソナとパスワード付きのテスト用アドレスを 1 つ作り、終了後に削除します。各フィールドはコードのエクスポートが書く data-testid で見つけ、拒否はフィールドの <test id>-error メッセージまたは aria-invalid="true" として表示されることを期待します。SIGNUP_URL にフォームのページを設定してください。フォームがコードのエクスポートから作られていない場合は、テスト ID とエラーメッセージが一致するか確認するか、テストのヘルパーを変更してください。
Proxy Mail QA が値を出さないフィールド(VAT 番号など)は notes に記載されます。テストの valid() に、フォームが受け付ける値を入れてください。
ロックされたプロジェクトでは
Section titled “ロックされたプロジェクトでは”カスタムフィールドをリードだけが変更できる場合、メンバーの保存(アプリでもエージェント経由でも)は、フォーム全体で 1 つの依頼としてリードに送られます。アプリではボタンが リードに依頼 になります。フォームは下書きとして待機し、その間も閲覧や変更ができます。リードは Project settings → Custom fields で承認または却下します。承認すると、フォームが保存され、そのカスタムフィールドも同時に作られます。
| 利用環境 | 対象 |
|---|---|
| MCP | list_signup_starters, list_signup_forms, get_signup_form, save_signup_form, delete_signup_form, get_signup_form_code, get_signup_form_test |
| REST API | GET /v1/signup-starters、GET と POST /v1/project/signup-forms、GET と DELETE /v1/project/signup-forms/{id}、GET /v1/project/signup-forms/{id}/code と /test |
| npm | signupStarters({ id?, language?, country? }), signupForms(), signupForm(id), saveSignupForm(spec, id?), deleteSignupForm(id, { removeCustomFields? }), signupFormCode(id, { format?, requested? }), signupFormTest(id, { framework? }) |
| Python | list_signup_starters(starter_id=None), list_signup_forms(), get_signup_form(form_id), save_signup_form(spec, form_id=None), delete_signup_form(form_id, remove_custom_fields=False), signup_form_code(form_id, format=...), signup_form_test(form_id, framework=...) |
このページについて質問がありますか?
質問はどの言語でもかまいません。ドキュメントからすぐに回答を得ることも、Proxy Mail QA チームに質問を送ることもできます。チームからの返信は英語です。