Getting Started

Selenium Driver Setup (Optional)

GPAL works out of the box with PuppeteerPort, its default engine. No driver needed. This page only applies if you choose a Selenium-based engine, which requires a WebDriver binary matching your installed browser version.

Only Needed for Selenium-Based Engines

PuppeteerPort and OttoMagic do not use WebDriver, so most workflows need none of this. If you switch to a Selenium-based engine (Selenium, SeleniumJS, SeleniumHW), GPAL needs a WebDriver executable -- chromedriver.exe, msedgedriver.exe, or geckodriver.exe -- matching your installed browser version. By default, GPAL looks for it in the same directory as your executable.

Automatic vs Manual

GPAL can automatically download and unzip the correct WebDriver for your browser version using WithAutoUpdateWebDriver. Alternatively, download drivers manually. In both cases, point GPAL to their location with WithDriverLocation at the global or per-browser level.

// Auto-download matching driver on startup

GPAL.WithAutoUpdateWebDriver(true);

// Specify location manually - global

GPAL.WithDriverLocation(@"C:gpaldrivers");

// Override per browser instance

var browser = GPAL.Browser

.WithBrowserType(BrowserType.Chrome)

.WithDriverLocation(@"C:customdrivers")

.ToGPALObject();

TIP

Driver setup only applies to Selenium-based engines. OttoMagic uses a browser extension and GPALRestAPI. Puppeteer communicates directly via Chrome DevTools Protocol (using SDi's custom implementation).

Driver Location Resolution

GPAL resolves the driver location in this order: per-browser setting, global GPAL setting, GPAL.yaml file, then the executable directory. The first location containing a matching driver is used.

WARNING

When Chrome or Edge auto-updates, the existing driver may no longer match. Use WithAutoUpdateWebDriver(true) or update your driver manually after a browser update.

Documentation Example

Documentation

Showing off some plain text in these paragraphs eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Other formats

Here you can find different accents and emphasis sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

This is a link and how it could look like bestlinkinthebeautifulworld. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Here's just some classic bold text adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam notBoldSecondbestlinkinthebeautifulworld illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at adipisicing elit libero vel voluptas? Expedita, adipisicing facere dolores voluptatem ad ab rem assumenda soluta!

Other cuple of colors in case we want to emphasize several ways adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at voluptatem libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Adding Images to the content

Lorem ipsum dolor sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta! Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quod veniam, quam ad expedita laborum sed at voluptates culpa ipsam ut vel. Ullam temporibus a mollitia quod aliquam ratione exercitationem nesciunt.

Coding Blocks

Lorem ipsum dolor sit amet consectetur adipisicing elit. Repudiandae quas consequuntur illo numquam assumenda autem exercitationem distinctio perspiciatis in natus. Eius dicta similique ipsam ipsa minima, nemo quae enim tempore.

GPAL

.CallIfNotFound(GenericCallIfNotFound)

.WithPublishToConsole();

//System.Drawing.Rectangle windowSize = new System.Drawing.Rectangle(10, 10, 1500, 1024);

// NOTE: we have to set browser = before we execute any steps

// this is due to the 'GenericCallIfNotFound' which might throw an exception, and BankScraper will not have the browser set when it calls scraper.Close()

// until the complete fluent line gets executed (meaning every step, meaning browser is not set until everything else succeeds)

browser = GPAL.Browser

.WithBrowserType(Enums.BrowserType.Chrome)

.WithProfileDataDirectory(ChromeProfileLocation)

.WithUseAutomationEngine(AutomationEngine.Selenium)

.WithWindowSize(new System.Drawing.Rectangle(0,0,1920,1080))

.ToGPALObject();

Getting Started

Getting Started

Selenium Driver Setup (Optional)

Only Needed for Selenium-Based Engines

Automatic vs Manual

Driver Location Resolution

Documentation Example

Documentation

Category

Endpoint

Enpoint

Enpoint

Enpoint

Other formats

Adding Images to the content

Coding Blocks

On this page