AXAndroidNode

FieldTypeRequiredDescription
classNamestringNo
viewIdResourceNamestringNo
packageNamestringNo
textstringNo
contentDescriptionstringNo
hintTextstringNo

AXAndroidWindow

FieldTypeRequiredDescription
packageNamestringNoThe package that owns the window, when known.
windowTypeintegerYesAccessibilityWindowInfo.getType().

AXNode

CDP’s AXNode plus bounds, windowId and actions. The role value, property names and actions are platform-scoped (“<platform>.button”, “<platform>.disabled”): controls on different platforms are different things with different capabilities. name, value and bounds are plain. nodeId is an opaque string, stable while the element lives. bounds are window pixels (the space screenshots use).
FieldTypeRequiredDescription
nodeIdstringYesOpaque; stable while the element lives. Never parse it.
ignoredbooleanYes
roleAXValueYes
nameAXValueNo
descriptionAXValueNo
valueAXValueNo
propertiesAXProperty[]No
parentIdstringNo
childIdsstring[]Yes
boundsBboxYes
windowIdstringYes
actionsstring[]YesPlatform-scoped actions the node supports, e.g. “<platform>.scroll”.
platformAXNodePlatformNoNative attributes, keyed by platform. Not portable. A phone session sets android, a computer session windows; a browser session omits the bag.

AXNodePlatform

Native attributes, keyed by platform. Not portable. A phone session sets android, a computer session windows; a browser session omits the bag.
FieldTypeRequiredDescription
androidAXAndroidNodeNo
windowsAXWindowsNodeNoA node’s UI Automation attributes: the automation id (what testId selectors match on a computer), the window class, the UI framework and the owning process.

AXProperty

FieldTypeRequiredDescription
namestringYesPlatform-scoped CDP property name, e.g. “<platform>.focusable”, “<platform>.disabled”, “<platform>.checked”.
valueAXValueYes

AXValue

FieldTypeRequiredDescription
typestringYesCDP AXValueType, e.g. “role”, “computedString”, “boolean”. A role value is platform-scoped (“<platform>.button”).
valueanyNoA string, boolean or number.

AXWindow

FieldTypeRequiredDescription
windowIdstringYes
titlestringNo
typestringYesPlatform-scoped window type. “<platform>.application” is a window showing app content; locators need one to resolve against the tree.
focusedbooleanYes
boundsBboxYes
rootIdstringNo
platformAXWindowPlatformNoA window’s native attributes, keyed by platform. Not portable.

AXWindowPlatform

A window’s native attributes, keyed by platform. Not portable.
FieldTypeRequiredDescription
androidAXAndroidWindowNo

AXWindowsNode

A node’s UI Automation attributes: the automation id (what testId selectors match on a computer), the window class, the UI framework and the owning process.
FieldTypeRequiredDescription
automationIdstringNo
classNamestringNo
frameworkIdstringNo
pidintegerNo

Bbox

FieldTypeRequiredDescription
xintegerYes
yintegerYes
widthintegerYes
heightintegerYes
FieldTypeRequiredDescription
namestringYes
valuestringYes
domainstringYes
pathstringYes
expiresMsintegerNoEpoch-ms; absent for a session cookie.
httpOnlybooleanYes
securebooleanYes
sameSitestringNoOne of strict, lax, none.
partitionKeyCookiePartitionKeyNoA partitioned (CHIPS) cookie’s partition, as the browser reports it.

CookiePartitionKey

A partitioned (CHIPS) cookie’s partition, as the browser reports it.
FieldTypeRequiredDescription
topLevelSitestringYes
hasCrossSiteAncestorbooleanYes

DOMNode

FieldTypeRequiredDescription
nodeIdstringYesOpaque DOM node id, scoped to the tab, frame and document. Never parse it. Fails with StaleNode once the node is gone, or when sent with another frame’s frameId; it never matches a different node.
nodeTypeintegerYesThe DOM nodeType (1 element, 3 text, 8 comment, 9 document, 11 fragment).
nodeNamestringYes
localNamestringNo
nodeValuestringNoThe value of a text or comment node.
attributesNameValue[]No
childCountintegerYesThe real child count, whatever the read returned.
childrenDOMNode[]No
contentFrameIdstringNoOn an iframe or frame element: the frame it shows, for frameId.
shadowRootsDOMNode[]NoThe element’s open shadow roots. Closed roots are never opened.
shadowRootTypestringNoSet on a shadow root node. One of open.

DeviceInfo

FieldTypeRequiredDescription
deviceIdstringYes
platformstringYesOS family of the session.
formFactorstringYesPhysical class of the session.
inputModalitiesstring[]YesInteraction classes the session accepts, e.g. [“keyboard”, “pointer”]. A client sizes behavior from this, not from platform.
modelstringNoBest-effort; empty when the descriptor lookup has not succeeded.
osVersionstringNoBest-effort; empty when unknown.
screenWidthintegerYesWidth of the live-view frame: the space screenshots, Screen.observe boxes and window-pixel coordinates use. In a browser session that is Chrome’s window.
screenHeightintegerYesHeight of the live-view frame. screenWidth by screenHeight and frame are the same numbers.
viewportSizeNoThe page’s viewport in CSS pixels, as measured; a request can be clamped. Browser sessions only.
devicePixelRationumberNoDevice pixels per CSS pixel, fixed for the session. Browser sessions only.
windowBboxNoChrome’s visible window on the monitor, exactly what the live view shows (not the OS window bounds, which include invisible resize borders), in monitor pixels. Browser sessions only.
frameSizeNoThe live-view frame’s size: the size of window, and the same numbers as screenWidth by screenHeight. Browser sessions only.
monitorSizeNoThe display Chrome runs on, in pixels; pages see it as screen.width and screen.height. Browser sessions only.

DisplayMode

FieldTypeRequiredDescription
widthintegerYes
heightintegerYes

ElementPosition

Where on the target to act, in CSS pixels from its padding box’s top-left, as Playwright’s position. Omitted means the center.
FieldTypeRequiredDescription
xintegerYes
yintegerYes

FileInfo

FieldTypeRequiredDescription
namestringYes
pathstringYes
isDirbooleanYes
sizeintegerYes
modifiedMsintegerYes

FrameInfo

FieldTypeRequiredDescription
frameIdstringYesOpaque frame id for frameId on the envelope.
parentFrameIdstringNoAbsent for the main frame.
targetIdstringYesOpaque tab id, stable while the tab is open. Never parse it.
urlstringYes
namestringNo
crossOriginbooleanYesThe frame is from another origin than its parent.

NameValue

FieldTypeRequiredDescription
namestringYes
valuestringYes

NetworkAction

What a rule does, tagged by type. Each type takes only its own fields; setRules refuses any other, so a rule never silently does something else. No action may set or remove host, any HTTP/2 pseudo-header (:path, :method, :scheme, :authority) or the hop-by-hop and framing headers (x-dcp-network-forbidden-headers), and header names must be HTTP tokens: the destination, path and method change only through url and method, and a rewritten url must be an absolute http or https URL. continue sends the request on, optionally with url and method changed (request stage only) and headers set or removed (request headers at the request stage, response headers at the response stage). A rewritten url is checked against egress policy again and matched against the request rules once more, never in a loop. fulfill answers without the origin (at the response stage it replaces the body): status, headers, and one of body, bodyBase64 and fileId. abort refuses: mode forbidden answers 403, reset resets the stream. pause holds the request, or the response before its body is forwarded, until Network.continuePaused or timeoutMs (10 s by default), then runs defaultAction. record is continue plus storing the request and response bodies in Files, up to 10 MiB each, counted against the organization’s Files quota; it is a request-stage action.
FieldTypeRequiredDescription
typestringYesOne of continue, fulfill, abort, pause, record.
urlstringNo
methodstringNo
setHeadersNameValue[]No
removeHeadersstring[]No
statusintegerNo
headersNameValue[]No
bodystringNo
bodyBase64stringNo
fileIdstringNo
modestringNoOne of forbidden, reset.
timeoutMsintegerNo
defaultActionNetworkActionNoWhat a rule does, tagged by type. Each type takes only its own fields; setRules refuses any other, so a rule never silently does something else. No action may set or remove host, any HTTP/2 pseudo-header (:path, :method, :scheme, :authority) or the hop-by-hop and framing headers (x-dcp-network-forbidden-headers), and header names must be HTTP tokens: the destination, path and method change only through url and method, and a rewritten url must be an absolute http or https URL. continue sends the request on, optionally with url and method changed (request stage only) and headers set or removed (request headers at the request stage, response headers at the response stage). A rewritten url is checked against egress policy again and matched against the request rules once more, never in a loop. fulfill answers without the origin (at the response stage it replaces the body): status, headers, and one of body, bodyBase64 and fileId. abort refuses: mode forbidden answers 403, reset resets the stream. pause holds the request, or the response before its body is forwarded, until Network.continuePaused or timeoutMs (10 s by default), then runs defaultAction. record is continue plus storing the request and response bodies in Files, up to 10 MiB each, counted against the organization’s Files quota; it is a request-stage action.

NetworkMatch

Every field given must match. url is a glob as in Playwright (* within a path segment, ** across segments, ? one character, {a,b} either), urlRegex an RE2 expression; give at most one. Both match the full URL, query included, fragment excluded. A redirect is two requests: response rules see the 3xx (its status and Location), and the follow-up request is matched again at the request stage; both hops share one requestId in records.
FieldTypeRequiredDescription
urlstringNo
urlRegexstringNo
methodstringNo
resourceTypesstring[]NoOne of document, iframe, script, style, image, font, media, manifest, worker, fetch, websocket, other.
stagestringNoOne of request, response. Default "request".
statusMinintegerNoResponse stage only.
statusMaxintegerNoResponse stage only.

NetworkRecord

FieldTypeRequiredDescription
requestIdstringYesOpaque; the same for every hop of one redirect chain.
methodstringYes
urlstringYes
resourceTypestringYesThe browser’s own resource type: a document in the main frame is document and in a child frame iframe; stylesheets are style; images image; fonts font; media and text tracks media; scripts script, or worker for a worker’s main script; XHR, fetch and event-source requests fetch; WebSocket handshakes websocket; manifests manifest; anything else (preflights, pings, prefetches, reports, signed exchanges) other. One of document, iframe, script, style, image, font, media, manifest, worker, fetch, websocket, other.
requestHeadersNameValue[]Yes
statusintegerNo
responseHeadersNameValue[]No
timestampMsintegerYesWhen the browser sent it, epoch-ms.
ruleIdstringNo
pauseSkippedbooleanNoA pause rule matched while 50 requests were already held.
requestBodyFileIdstringNo
responseBodyFileIdstringNo
requestBodyTruncatedbooleanNo
responseBodyTruncatedbooleanNo

NetworkRecordEntry

FieldTypeRequiredDescription
seqintegerYes
kindstringYesOne of request, response.
recordNetworkRecordYes

NetworkRule

FieldTypeRequiredDescription
idstringNoYour own label, echoed as ruleId in records.
matchNetworkMatchYesEvery field given must match. url is a glob as in Playwright (* within a path segment, ** across segments, ? one character, {a,b} either), urlRegex an RE2 expression; give at most one. Both match the full URL, query included, fragment excluded. A redirect is two requests: response rules see the 3xx (its status and Location), and the follow-up request is matched again at the request stage; both hops share one requestId in records.
actionNetworkActionYesWhat a rule does, tagged by type. Each type takes only its own fields; setRules refuses any other, so a rule never silently does something else. No action may set or remove host, any HTTP/2 pseudo-header (:path, :method, :scheme, :authority) or the hop-by-hop and framing headers (x-dcp-network-forbidden-headers), and header names must be HTTP tokens: the destination, path and method change only through url and method, and a rewritten url must be an absolute http or https URL. continue sends the request on, optionally with url and method changed (request stage only) and headers set or removed (request headers at the request stage, response headers at the response stage). A rewritten url is checked against egress policy again and matched against the request rules once more, never in a loop. fulfill answers without the origin (at the response stage it replaces the body): status, headers, and one of body, bodyBase64 and fileId. abort refuses: mode forbidden answers 403, reset resets the stream. pause holds the request, or the response before its body is forwarded, until Network.continuePaused or timeoutMs (10 s by default), then runs defaultAction. record is continue plus storing the request and response bodies in Files, up to 10 MiB each, counted against the organization’s Files quota; it is a request-stage action.

Observation

The page right after the action, for a call with observe. It is read once the DOM has gone 300 ms unchanged, or after 1.5 s at most.
FieldTypeRequiredDescription
urlstringYes
titlestringYes
snapshotstringNoPage.ariaSnapshot with refs and compact, its first 20000 characters (observe snapshot).
totalCharsintegerNoThe whole snapshot’s length in characters.
nextOffsetintegerNoWhere the rest of the snapshot starts, for Page.ariaSnapshot offset; absent when it is whole.
settledbooleanYesFalse when the page was still changing when it was read: read it again, or call Page.waitForSettled.

ObserveIcon

FieldTypeRequiredDescription
bboxBboxNo
confidencenumberNo

ObserveText

FieldTypeRequiredDescription
textstringNo
bboxBboxNo
confidencenumberNo

Point

A position in window pixels (the space screenshots use), (0, 0) at the top-left of the browser window. A point outside the window (negative, x at or past screenWidth, or y at or past screenHeight, from Device.info) fails with InvalidArgs.
FieldTypeRequiredDescription
xintegerYes
yintegerYes

ProcessInfo

FieldTypeRequiredDescription
pidintegerYes
parentPidintegerYes
namestringYes

ScriptException

FieldTypeRequiredDescription
messagestringYes
stackstringNo

Selector

One way of finding a target, tagged by kind. Each kind reads only its own fields. The DOM kinds (css, xpath, role, text, label, testId, placeholder, altText, title, playwright) resolve with Playwright’s selector engine at x-dcp-playwright-version, matching as page.locator and the getBy methods do there; playwright reads selector, a Playwright selector string taken verbatim (text=…, :has-text(), >>, nth=) using only the engines in x-dcp-playwright-engines. Any other engine answers StrategyUnavailable naming it: internal:control=enter-frame (frames are chosen with frameId), and _react and _vue (the engine runs in an isolated world and can’t read framework internals). css and xpath read selector. role reads role, name and states (exact applies to name). text, label, testId, placeholder, altText and title read value (substring and case-insensitive unless exact); testId matches data-testid unless the session configures another attribute. domNode and axNode read nodeId, an opaque reference from an earlier read that fails with StaleNode once gone and never matches a different element. query reads query, natural language for the model resolver; no other kind ever becomes a model prompt. and and or read selectors. within (inside a match), has (containing a match) and nth (zero-based in reading order, or -1 for the last match) refine any kind. Actions are strict: a selector that matches more than one target fails unless nth picks one. A kind the executor does not serve answers StrategyUnavailable, never an approximate match. role and states are platform-scoped: qualified (“<platform>.button”) or bare (“button”, the tree’s own platform). ref reads ref, a ref from the latest Page.ariaSnapshot with refs (“e5”); one whose element left the page, or that no snapshot gave, fails at once with StaleNode, so take a new snapshot.
FieldTypeRequiredDescription
kindstringYesHow a Selector finds its target. One of css, xpath, role, text, label, testId, placeholder, altText, title, domNode, axNode, query, and, or, playwright, ref.
selectorstringNoThe CSS or XPath query, or the Playwright selector string (kinds css, xpath and playwright).
rolestringNoAccessibility role, qualified (“<platform>.button”) or bare (“button”).
namestringNoAccessible name (kind role).
statesstring[]NoRequired element states (kind role).
valuestringNoThe text, label, test id, placeholder, alt text or title to match.
exactbooleanNo
nodeIdstringNoAn opaque DOM or accessibility node reference (kinds domNode and axNode); never parse it.
querystringNoNatural-language description of the target (kind query).
selectorsSelector[]NoThe selectors an and / or combines.
withinSelectorNoWhich element: a selector object tagged by kind. See Selectors.
hasSelectorNoWhich element: a selector object tagged by kind. See Selectors.
nthintegerNoPick the nth match in reading order, zero-based; -1 is the last. From -1 to 2147483647.
refstringNoA ref from Page.ariaSnapshot with refs, such as “e5”, or on a computer a node id from Accessibility.getFullAXTree, such as “u16.2t8q.4” (kind ref).

Size

FieldTypeRequiredDescription
widthintegerYes
heightintegerYes

TargetInfo

FieldTypeRequiredDescription
targetIdstringYesOpaque tab id, stable while the tab is open. Never parse it.
urlstringYes
titlestringYes
activebooleanYesThe tab is in front.
currentbooleanYesTarget-scoped calls without a targetId go to this tab.
openerIdstringNoThe tab whose page opened this one, for popups and target=_blank links.

TextMatch

One Page.findText match, with the text around it.
FieldTypeRequiredDescription
offsetintegerYesWhere the match starts in the whole text, in characters; Page.getText’s offset.
textstringYesThe match with contextChars characters either side, cut at a word, ”…” marking a cut.

WindowInfo

FieldTypeRequiredDescription
windowIdstringYesOpaque; valid while the window exists.
titlestringYes
processstringYesThe image name, such as notepad.exe.
pidintegerYes
boundsBboxYesThe visible frame in screen pixels, without the invisible resize borders.
statestringYesOne of normal, minimized, maximized.
focusedbooleanYes