Chrome DevTools Protocol

Methods

Browser.close

Close browser gracefully.

Browser.getVersion

Returns version information.

Return Object
protocolVersion
string

Protocol version.

product
string

Product name.

revision
string

Product revision.

userAgent
string

User-Agent.

jsVersion
string

V8 version.

Browser.cancelDownload Experimental

Cancel a download if in progress

parameters
guid
string

Global unique identifier of the download.

browserContextId
BrowserContextID

BrowserContext to perform the action in. When omitted, default browser context is used.

Browser.crash Experimental

Crashes browser on the main thread.

Browser.crashGpuProcess Experimental

Crashes GPU process.

Browser.executeBrowserCommand Experimental

Invoke custom browser commands used by telemetry.

parameters
commandId
BrowserCommandId

Browser.getBrowserCommandLine Experimental

Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.

Return Object
arguments
array[ string ]

Commandline parameters

Browser.getHistogram Experimental

Get a Chrome histogram by name.

parameters
name
string

Requested histogram name.

delta
boolean

If true, retrieve delta since last call.

Return Object
histogram
Histogram

Histogram.

Browser.getHistograms Experimental

Get Chrome histograms.

parameters
query
string

Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.

delta
boolean

If true, retrieve delta since last call.

Return Object
histograms
array[ Histogram ]

Histograms.

Browser.getWindowBounds Experimental

Get position and size of the browser window.

parameters
windowId
WindowID

Browser window id.

Return Object
bounds
Bounds

Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.

Browser.getWindowForTarget Experimental

Get the browser window that contains the devtools target.

parameters
targetId
Target.TargetID

Devtools agent host id. If called as a part of the session, associated targetId is used.

Return Object
windowId
WindowID

Browser window id.

bounds
Bounds

Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.

Browser.grantPermissions Experimental

Grant specific permissions to the given origin and reject all others.

parameters
permissions
array[ PermissionType ]
origin
string

Origin the permission applies to, all origins if not specified.

browserContextId
BrowserContextID

BrowserContext to override permissions. When omitted, default browser context is used.

Browser.resetPermissions Experimental

Reset all permission management for all origins.

parameters
browserContextId
BrowserContextID

BrowserContext to reset permissions. When omitted, default browser context is used.

Browser.setDockTile Experimental

Set dock tile details, platform-specific.

parameters
badgeLabel
string
image
string

Png encoded image. (Encoded as a base64 string when passed over JSON)

Browser.setDownloadBehavior Experimental

Set the behavior when downloading a file.

parameters
behavior
string

Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). |allowAndName| allows download and names files according to their dowmload guids.

Allowed Values: deny, allow, allowAndName, default
browserContextId
BrowserContextID

BrowserContext to set download behavior. When omitted, default browser context is used.

downloadPath
string

The default path to save downloaded files to. This is required if behavior is set to 'allow' or 'allowAndName'.

eventsEnabled
boolean

Whether to emit download events (defaults to false).

Browser.setPermission Experimental

Set permission settings for given origin.

parameters
permission
PermissionDescriptor

Descriptor of permission to override.

setting
PermissionSetting

Setting of the permission.

origin
string

Origin the permission applies to, all origins if not specified.

browserContextId
BrowserContextID

Context to override. When omitted, default browser context is used.

Browser.setWindowBounds Experimental

Set position and/or size of the browser window.

parameters
windowId
WindowID

Browser window id.

bounds
Bounds

New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.

Events

Browser.downloadProgress Experimental

Fired when download makes progress. Last call has |done| == true.

parameters
guid
string

Global unique identifier of the download.

totalBytes
number

Total expected bytes to download.

receivedBytes
number

Total bytes received.

state
string

Download status.

Allowed Values: inProgress, completed, canceled

Browser.downloadWillBegin Experimental

Fired when page is about to start a download.

parameters
frameId
Page.FrameId

Id of the frame that caused the download to begin.

guid
string

Global unique identifier of the download.

url
string

URL of the resource being downloaded.

suggestedFilename
string

Suggested file name of the resource (the actual name of the file saved on disk may differ).

Types

Browser.Bounds Experimental

Browser window bounds information

Type: object

properties
left
integer

The offset from the left edge of the screen to the window in pixels.

top
integer

The offset from the top edge of the screen to the window in pixels.

width
integer

The window width in pixels.

height
integer

The window height in pixels.

windowState
WindowState

The window state. Default to normal.

Browser.BrowserCommandId Experimental

Browser command ids used by executeBrowserCommand.

Allowed Values: openTabSearch, closeTabSearch

Type: string

Browser.BrowserContextID Experimental

Type: string

Browser.Bucket Experimental

Chrome histogram bucket.

Type: object

properties
low
integer

Minimum value (inclusive).

high
integer

Maximum value (exclusive).

count
integer

Number of samples.

Browser.Histogram Experimental

Chrome histogram.

Type: object

properties
name
string

Name.

sum
integer

Sum of sample values.

count
integer

Total number of samples.

buckets
array[ Bucket ]

Buckets.

Browser.PermissionDescriptor Experimental

Definition of PermissionDescriptor defined in the Permissions API: https://w3c.github.io/permissions/#dictdef-permissiondescriptor.

Type: object

properties
name
string
sysex
boolean

For "midi" permission, may also specify sysex control.

userVisibleOnly
boolean

For "push" permission, may specify userVisibleOnly. Note that userVisibleOnly = true is the only currently supported type.

allowWithoutSanitization
boolean

For "clipboard" permission, may specify allowWithoutSanitization.

panTiltZoom
boolean

For "camera" permission, may specify panTiltZoom.

Browser.PermissionSetting Experimental

Allowed Values: granted, denied, prompt

Type: string

Browser.PermissionType Experimental

Allowed Values: accessibilityEvents, audioCapture, backgroundSync, backgroundFetch, clipboardReadWrite, clipboardSanitizedWrite, displayCapture, durableStorage, flash, geolocation, midi, midiSysex, nfc, notifications, paymentHandler, periodicBackgroundSync, protectedMediaIdentifier, sensors, videoCapture, videoCapturePanTiltZoom, idleDetection, wakeLockScreen, wakeLockSystem

Type: string

Browser.WindowID Experimental

Type: integer

Browser.WindowState Experimental

The state of the browser window.

Allowed Values: normal, minimized, maximized, fullscreen

Type: string