Browser

ブラウザアクションの一覧です。 ブラウザアクションは、ブラウザの起動から、ブラウザ内のクリックなどの操作に対応しております。ブラウザ内の要素を操作するには、CSSセレクタをセットします。CSSセレクタをセットされたアクションは、セレクタがドキュメント内に読み込まれるのを最大30秒待つように設定されております。
ただし、以下のアクションについては、セレクタの出現だけではなく画面上に見える要素として出現することを待つようになっています。
Click
Hover
TakeElementShot
これらの要素は、セレクタが読み込まれていても表示されていなければ操作できません。
OpenBrowser
概要
OpenBrowserは、ほぼすべてのワークフローで利用されるアクションです。ブラウザ（Chromium）を起動して、指定されたウェブサイトを開きます。アウトプットは、起動したブラウザのウェブソケットアドレスになります。
OpenBrowserは、指定したURLのDOM要素のレンダリングが開始されるまで待機します（document の load イベント発火まで待機）。30秒経過してもページが開かない場合は、Timeoutエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
url*
文字列
最初に開くウェブサイトのURL
​https://yahoo.co.jp​
lang
文字列
ブラウザの言語設定、ISO 639言語コード。
en (default)
timeZone
文字列
ブラウザの場所設定、タイムゾーン。
Etc/GMT (default)
userAgent
文字列
ブラウザのユーザーエージェント設定。
HeadlessChrome (default)
windowSize
文字列
ブラウザ起動時の画面サイズ。「横 x 縦 @ スケールファクター」で設定します。
1280 x 720 @ 2
plugins
配列
利用するプラグインを設定
-
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
1
+open_browser_1:
2
  action>: OpenBrowser
3
  url: 'https://yahoo.co.jp'
4
  lang: 'ja-JP'
5
  timeZone: 'Asia/Tokyo'
6
  userAgent: 'Robotic Crowd Agent'
7
  windowSize: 800 x 600
Copied!
GoTo
概要
GoToは、ブラウザのアドレスバーに直接URLを入力して遷移させます。セッションを保ったままページ遷移させたり、URLを指定することで、サイト内の深い階層まで一気に遷移させるときなどに利用できます。
GoToは、指定したURLのDOM要素のレンダリングが開始されるまで次のアクションに進むのを待機します。30秒経過してもページが開かない場合は、Timeoutエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
url*
文字列
遷移先URL
​https://yahoo.co.jp​
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。実行前待機時間を短くして、実行後待ち時間を2秒に設定したもの。
1
+go_to_1:
2
  action>: GoTo
3
  browser: +open_browser_1
4
  url: 'https://yahoo.co.jp'
5
  waitBefore: 10
6
  waitAfter: 2000
Copied!
CloseBrowser
概要
CloseBrowserは、ブラウザを閉じます。ブラウザを閉じてセッションも切っておきたいときに使います。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Boolean
真理値
完了するとtrueとなる（エラーがなければ、常にtrue）
true
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。実行前待機時間を短くして、実行後待ち時間を2秒に設定したもの。
1
+close_browser_1:
2
  action>: CloseBrowser
3
  browser: +open_browser_1
4
  waitBefore: 10
5
  waitAfter: 2000
Copied!
Click
概要
Clickは、ブラウザの内の指定の要素をクリックします。クリックに付随したダウンロードやダイアログの処理についてもここで設定します。ブラウザの接続先をアウトプットします。
Clickでクリック可能な要素は、表示されているという条件が必要です。Clickは、実際のブラウザの画面上の点をクリックするようになっているので、HTML内に要素があっても見える状態（visible）でないとエラーとなります。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ
#submitBtn
confirm
真理値
ダイアログが表示されたらOKをクリックする。
true (default)
type_to_confirm
文字列
confirmがtrueの時、ダイアログに文字を入力してから、OKをクリックする。
null (default)
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
waitForDownload
真理値
このクリックでダウンロードが始まるので、ダウンロードの完了までこのアクション内で待機する。最大3分間待機する。
false (default)
highResolution
真理値
ウィンドウを1280x720まで拡大してからクリックする。
false (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。クリックで確認ダイアログが表示され、CSVダウンロードが始まることがわかっているので、そのダウンロードまで待つ。また、セレクタが見つからない場合は、エラーとして途中で終了するようにする。
1
+click_1:
2
  action>: Click
3
  browser: +open_browser_1
4
  selector: 'input#download'
5
  ingnoreError: false
6
  waitForDownload: true
7
  highResolution: true
Copied!
Hover
概要
Hoverは、ブラウザの内の指定の要素にマウスをあわせます。Hoverで表示される要素をクリックしたり、取得したりする際に利用します。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ
#submitBtn
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
highResolution
真理値
ウィンドウを1280x720まで拡大してからクリックする。
false (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。
1
+hover_1:
2
  action>: Hover
3
  browser: +open_browser_1
4
  selector: 'i#hint'
5
  ingnoreError: true
6
  highResolution: true
Copied!
TypeText
概要
TypeTextは、ブラウザの内の指定の要素に文字を入力します。インプットフィールドに値をセットするのではなく、人間が入力するように一文字ずつテキストを入力していく操作となります。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ
#submitBtn
text*
文字列
入力する文字列
ミーアキャット
clearValue
真理値
trueの時、すでに入力されている値を消去します。falseの時、追記します。
false (default)
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
delay
整数
1文字ずつ入力する際のタイプ遅延（ms）。例えば、'abcd' と入力する際に20セットされていると、a (20ms) b (20ms) c (20ms) d と入力するので、60ms以上時間がかかる。
0 (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。検索フィールドにミーアキャットと入力する。事前に入力されている文字があれば消去。タイピングのスピードは、5msとする。
1
+type_text_1:
2
  action>: TypeText
3
  browser: +open_browser_1
4
  selector: 'input#srchtxt'
5
  text: ミーアキャット
6
  clearValue: true
7
  ingnoreError: false
8
  delay: 5
Copied!
SetFileToUpload
概要
SetFileToUploadは、ブラウザの内のフォーム要素にファイルをセットします。ファイルをアップロードする際に利用します。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ
#submitBtn
file*
文字列
fileがあるpathを指定します。指定できるpathは、実行中のロボットの一時フォルダ内に限定されます。アップロードするファイルは、事前にGetFileなどで取得する必要があるので、GetFileアクションのアウトプットを指定することが通常です。
+get_file_1
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。フォーム内のファイル要素にGetFileで事前に取得してきたファイルをセットする。
1
+set_file_to_upload_1:
2
  action>: SetFileToUpload
3
  browser: +open_browser_1
4
  selector: 'form input[type=file]'
5
  file: +get_file_1
6
  ingnoreError: false
Copied!
TypePassword
概要
TypePasswordは、TypeTextと同じ動作をしますが、パスワードがマスクされたり、input[type=password] 以外要素には使えないなどのいくつかの制限があります。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ。input[type=password]となっている要素のみ設定可能。
#password
password*
文字列
入力するパスワード。パスワードは、ワークフロー保存時にマスクされ*****という表示になる。
true (default)
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
delay
整数
1文字ずつ入力する際のタイプ遅延（ms）。例えば、'abcd' と入力する際に20セットされていると、a (20ms) b (20ms) c (20ms) d と入力するので、60ms以上時間がかかる。
0 (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。パスワードにthisispasswordと入力する。
1
+type_password_1:
2
  action>: TypePassword
3
  browser: +open_browser_1
4
  selector: 'input#password'
5
  password: thisispassword      # => 保存後は、 '******' となりマスクされます。
6
  ingnoreError: false
Copied!
SelectOption
概要
選択肢型のUIを操作して、その値（value）または、表示名（innerText）により選択肢を選択します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ
#optionSelect
value*(1)
文字列
選択する値（value）で選択する
okinawa
text*(1)
文字列
選択肢の表示名（innerText）で選択する
沖縄
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
(*1) どちらか必須
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。選択肢で8を選択する。
1
+select_option_1:
2
  action>: SElectOption
3
  browser: +open_browser_1
4
  selector: '#startHour'
5
  value: 8
6
  ingnoreError: false
Copied!
GetText
概要
GetTextは、ブラウザの内の指定の要素内の文字をすべて取得します。取得した文字列をアウトプットします。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ
#submitBtn
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Text
文字列
取得した文字列
"明日の江東区の天気は、晴れです。"
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。
1
+get_text_1:
2
  action>: GetText
3
  browser: +open_browser_1
4
  selector: 'p#detail'
5
  ingnoreError: false
Copied!
SendKeys
概要
SendKeysは、キーボードを操作する低水準のアクションです。メタキーを含めて送信可能です。ロボットは、LinuxOS上で動作していることを前提にしてください。
表示確認用に、セレクターをセットすることができますが、SendKeys自体は、セレクタの指定は不要です。現在のブラウザの状態のままキーボードを押して離すことをエミュレートします。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、デフォルトでは、そのまま次のアクションに進みます。ただし、ignoreErrorにfalseがセットされている場合は、要素が出現しない場合にエラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
keys
配列
キーの名前を要素とした配列を入力します。使えるキーの名前一覧は、こちらを参照してください。
["ArrowLeft", "Enter"]
selector
文字列
操作対象のCSSセレクタ。必須ではありません。
body (default)
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。左矢印とエンターキーをほぼ同時に送信する。
1
+send_keys_1:
2
  action>: SendKeys
3
  browser: +open_browser_1
4
  keys: ["ArrowLeft", "Enter"]
Copied!
SubmitForm
概要
SubmitFormは、クリックやキーの送信ではなく、プログラム的にフォームを送信したい場合に利用します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
操作対象のCSSセレクタ。
form#entry
ignoreError
真理値
CSSセレクタが見つからないなどのエラーが発生しても次のタスクへ進む。
true (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
アウトプット
タイプ
型
概要
例
Browser
文字列
起動したブラウザのWebSocketアドレス
ws://127.0.0.1:52582/devtools/browser/be5e7b6e-ce64-4040-a7af-15ecc7b125f0
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。入力フォームをプログラム的に送信する。
1
+submit_form_1`:
2
  action>: SubmitForm
3
  browser: +open_browser_1
4
  selector: 'form#entry'
Copied!
TakeScreenshot
概要
TakeScreenshotは、ブラウザの画面を画像として保存するアクションです。画像ファイルのパスをアウトプットします。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
full_page
真理値
trueの時、スクロール可能な領域を含めて全体をスクリーンショットします。falseのときは、ウィンドウサイズのみ撮影します。
false (default)
highResolution
真理値
ウィンドウを1280x720まで拡大してからクリックする。
false (default)
device
文字列
モバイル端末をエミュレートしてスクリーンショットをとります。利用できるデバイスは、こちらを参照ください。
iPhone X
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
*注意: デバイスのサイズに合わせて画像等をリサイズしているWebサイトの場合にページ全体のスクリーンショットで表示が乱れることがあります。
アウトプット
タイプ
型
概要
例
Image
文字列
撮影した画面のpngファイルのパス。
/tmp/fb4edcb2/screenshots/1.png
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。高解像度モードで全ページを撮影する。
1
+take_screenshot_1:
2
  action>: TakeScreenshot
3
  browser: +open_browser_1
4
  full_page: true
5
  device: iPhone X
6
  hightResolution: true
Copied!
TakeElementShot
概要
TakeElementShotは、ブラウザに表示されている一部の要素のみ撮影します。
このアクションは、30秒間要素の出現をまちます。30秒たっても要素が出現しない場合、エラーとなります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
selector*
文字列
撮影する要素のCSSセレクター
p > img
highResolution
真理値
ウィンドウを1280x720まで拡大してからクリックする。
false (default)
waitBefore
整数
実行前待機時間（ms）
100 (default)
waitAfter
整数
実行後待機時間（ms）
100 (default)
marginTop
整数
スクリーンショットを撮る範囲を、指定したピクセル数だけ上側に拡張します。なお、拡張できる上限はページの上端までです。
0 (default)
marginRight
整数
スクリーンショットを撮る範囲を、指定したピクセル数だけ右側に拡張します。ページの右端を超えても撮影できます。
0 (default)
marginBottom
整数
スクリーンショットを撮る範囲を、指定したピクセル数だけ下側に拡張します。ページの下端を超えても撮影できます。
0 (default)
marginLeft
整数
スクリーンショットを撮る範囲を、指定したピクセル数だけ左側に拡張します。なお、拡張できる上限はページの左端までです。
0 (default)
*注意: marginによる拡張範囲を大きくしすぎると（数千〜数万ピクセル）正常にスクリーンショットを撮影できないことがあります。その場合は拡張範囲を小さくして再度お試しください。
アウトプット
タイプ
型
概要
例
Image
文字列
撮影した画面のpngファイルのパス。
/tmp/fb4edcb2/screenshots/1.png
使用例
ブラウザの接続先は、OpenBrowserアクションのアウトプットを再利用する。高解像度モードで画像要素のみ撮影する。
1
+take_element_shot_1:
2
  action>: TakeElementShot
3
  browser: +open_browser_1
4
  selector: 'p > img'
5
  hightResolution: true
Copied!
PagePDF
概要
PagePDFは、表示中のページを印刷用のPDFに出力するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
browser*
文字列
ブラウザの接続先
+open_browser_1
format
文字列
印刷する用紙サイズです。
A4 (default)