devtools-protocol 0.0.1682007 → 0.0.1683682

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -688,6 +688,23 @@
688
688
  }
689
689
  }
690
690
  ]
691
+ },
692
+ {
693
+ "id": "AdScript",
694
+ "description": "An ad script.\nNote: when the script is a transitive ad script, we only fill in the\nimmediate ancestor script in the provenance's adScriptAncestry field (as its\nfirst entry), rather than filling in the full ancestry. This saves work for\nthe backend, and the frontend can reconstruct the full ancestry if\nnecessary.",
695
+ "type": "object",
696
+ "properties": [
697
+ {
698
+ "name": "scriptId",
699
+ "description": "The script ID.",
700
+ "$ref": "Runtime.ScriptId"
701
+ },
702
+ {
703
+ "name": "provenance",
704
+ "description": "The ad provenance.",
705
+ "$ref": "Network.AdProvenance"
706
+ }
707
+ ]
691
708
  }
692
709
  ],
693
710
  "commands": [
@@ -700,6 +717,19 @@
700
717
  "$ref": "AdMetrics"
701
718
  }
702
719
  ]
720
+ },
721
+ {
722
+ "name": "getAdScripts",
723
+ "description": "Retrieves ad scripts for the current page. To minimize payload size, this\nonly returns the newly tracked ad scripts since the last call to\ngetAdScripts (i.e., the delta).",
724
+ "returns": [
725
+ {
726
+ "name": "newScripts",
727
+ "type": "array",
728
+ "items": {
729
+ "$ref": "AdScript"
730
+ }
731
+ }
732
+ ]
703
733
  }
704
734
  ]
705
735
  },
@@ -17632,7 +17662,7 @@
17632
17662
  },
17633
17663
  {
17634
17664
  "name": "adScriptAncestry",
17635
- "description": "The script ancestry that created the ad, if any.",
17665
+ "description": "The script ancestry that created the ad, if any.\nNote: depending on the context, this may represent the full ancestry up\nto the root script, or it may contain only one script representing the\nimmediate ancestor.",
17636
17666
  "optional": true,
17637
17667
  "$ref": "AdAncestry"
17638
17668
  }
@@ -24424,9 +24454,21 @@
24424
24454
  },
24425
24455
  {
24426
24456
  "name": "everyNthFrame",
24427
- "description": "Send every n-th frame.",
24457
+ "description": "Send every n-th frame. Must be a positive integer.",
24458
+ "optional": true,
24459
+ "type": "integer"
24460
+ },
24461
+ {
24462
+ "name": "maxFramesInFlight",
24463
+ "description": "Maximum number of frames sent until screencastFrameAck is required.\nDefaults to 3. Must be a positive integer.",
24428
24464
  "optional": true,
24429
24465
  "type": "integer"
24466
+ },
24467
+ {
24468
+ "name": "sendLastFrame",
24469
+ "description": "By default, after screencastFrameAck arrives, the next produced frame is sent.\nPassing this flag enables storing the last produced frame in memory, which is\nimmediately sent upon screencastFrameAck. This way, overall performance is\ntraded for a better latency.",
24470
+ "optional": true,
24471
+ "type": "boolean"
24430
24472
  }
24431
24473
  ]
24432
24474
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "devtools-protocol",
3
- "version": "0.0.1682007",
3
+ "version": "0.0.1683682",
4
4
  "description": "The Chrome DevTools Protocol JSON",
5
5
  "repository": "https://github.com/ChromeDevTools/devtools-protocol",
6
6
  "author": "The Chromium Authors",
@@ -48,3 +48,23 @@ experimental domain Ads
48
48
  command getAdMetrics
49
49
  returns
50
50
  AdMetrics metrics
51
+
52
+ # An ad script.
53
+ # Note: when the script is a transitive ad script, we only fill in the
54
+ # immediate ancestor script in the provenance's adScriptAncestry field (as its
55
+ # first entry), rather than filling in the full ancestry. This saves work for
56
+ # the backend, and the frontend can reconstruct the full ancestry if
57
+ # necessary.
58
+ type AdScript extends object
59
+ properties
60
+ # The script ID.
61
+ Runtime.ScriptId scriptId
62
+ # The ad provenance.
63
+ Network.AdProvenance provenance
64
+
65
+ # Retrieves ad scripts for the current page. To minimize payload size, this
66
+ # only returns the newly tracked ad scripts since the last call to
67
+ # getAdScripts (i.e., the delta).
68
+ command getAdScripts
69
+ returns
70
+ array of AdScript newScripts
@@ -1701,6 +1701,9 @@ domain Network
1701
1701
  # The filterlist rule that matched, if any.
1702
1702
  optional string filterlistRule
1703
1703
  # The script ancestry that created the ad, if any.
1704
+ # Note: depending on the context, this may represent the full ancestry up
1705
+ # to the root script, or it may contain only one script representing the
1706
+ # immediate ancestor.
1704
1707
  optional AdAncestry adScriptAncestry
1705
1708
 
1706
1709
  # Fired when additional information about a requestWillBeSent event is available from the
@@ -1170,8 +1170,16 @@ domain Page
1170
1170
  optional integer maxWidth
1171
1171
  # Maximum screenshot height.
1172
1172
  optional integer maxHeight
1173
- # Send every n-th frame.
1173
+ # Send every n-th frame. Must be a positive integer.
1174
1174
  optional integer everyNthFrame
1175
+ # Maximum number of frames sent until screencastFrameAck is required.
1176
+ # Defaults to 3. Must be a positive integer.
1177
+ optional integer maxFramesInFlight
1178
+ # By default, after screencastFrameAck arrives, the next produced frame is sent.
1179
+ # Passing this flag enables storing the last produced frame in memory, which is
1180
+ # immediately sent upon screencastFrameAck. This way, overall performance is
1181
+ # traded for a better latency.
1182
+ optional boolean sendLastFrame
1175
1183
 
1176
1184
  # Starts screencast video recording.
1177
1185
  experimental command startScreenRecording
@@ -1756,6 +1756,15 @@ export namespace ProtocolMapping {
1756
1756
  paramsType: [];
1757
1757
  returnType: Protocol.Ads.GetAdMetricsResponse;
1758
1758
  };
1759
+ /**
1760
+ * Retrieves ad scripts for the current page. To minimize payload size, this
1761
+ * only returns the newly tracked ad scripts since the last call to
1762
+ * getAdScripts (i.e., the delta).
1763
+ */
1764
+ 'Ads.getAdScripts': {
1765
+ paramsType: [];
1766
+ returnType: Protocol.Ads.GetAdScriptsResponse;
1767
+ };
1759
1768
  /**
1760
1769
  * Disables animation domain notifications.
1761
1770
  */
@@ -761,6 +761,13 @@ export namespace ProtocolProxyApi {
761
761
  */
762
762
  getAdMetrics(): Promise<Protocol.Ads.GetAdMetricsResponse>;
763
763
 
764
+ /**
765
+ * Retrieves ad scripts for the current page. To minimize payload size, this
766
+ * only returns the newly tracked ad scripts since the last call to
767
+ * getAdScripts (i.e., the delta).
768
+ */
769
+ getAdScripts(): Promise<Protocol.Ads.GetAdScriptsResponse>;
770
+
764
771
  }
765
772
 
766
773
  export interface AnimationApi {
@@ -809,6 +809,13 @@ export namespace ProtocolTestsProxyApi {
809
809
  */
810
810
  getAdMetrics(): Promise<{id: number, result: Protocol.Ads.GetAdMetricsResponse, sessionId: string}>;
811
811
 
812
+ /**
813
+ * Retrieves ad scripts for the current page. To minimize payload size, this
814
+ * only returns the newly tracked ad scripts since the last call to
815
+ * getAdScripts (i.e., the delta).
816
+ */
817
+ getAdScripts(): Promise<{id: number, result: Protocol.Ads.GetAdScriptsResponse, sessionId: string}>;
818
+
812
819
  }
813
820
 
814
821
  export interface AnimationApi {
@@ -3193,9 +3193,32 @@ export namespace Protocol {
3193
3193
  removeAdFrames: Page.FrameId[];
3194
3194
  }
3195
3195
 
3196
+ /**
3197
+ * An ad script.
3198
+ * Note: when the script is a transitive ad script, we only fill in the
3199
+ * immediate ancestor script in the provenance's adScriptAncestry field (as its
3200
+ * first entry), rather than filling in the full ancestry. This saves work for
3201
+ * the backend, and the frontend can reconstruct the full ancestry if
3202
+ * necessary.
3203
+ */
3204
+ export interface AdScript {
3205
+ /**
3206
+ * The script ID.
3207
+ */
3208
+ scriptId: Runtime.ScriptId;
3209
+ /**
3210
+ * The ad provenance.
3211
+ */
3212
+ provenance: Network.AdProvenance;
3213
+ }
3214
+
3196
3215
  export interface GetAdMetricsResponse {
3197
3216
  metrics: AdMetrics;
3198
3217
  }
3218
+
3219
+ export interface GetAdScriptsResponse {
3220
+ newScripts: AdScript[];
3221
+ }
3199
3222
  }
3200
3223
 
3201
3224
  /**
@@ -13899,6 +13922,9 @@ export namespace Protocol {
13899
13922
  filterlistRule?: string;
13900
13923
  /**
13901
13924
  * The script ancestry that created the ad, if any.
13925
+ * Note: depending on the context, this may represent the full ancestry up
13926
+ * to the root script, or it may contain only one script representing the
13927
+ * immediate ancestor.
13902
13928
  */
13903
13929
  adScriptAncestry?: AdAncestry;
13904
13930
  }
@@ -18179,9 +18205,21 @@ export namespace Protocol {
18179
18205
  */
18180
18206
  maxHeight?: integer;
18181
18207
  /**
18182
- * Send every n-th frame.
18208
+ * Send every n-th frame. Must be a positive integer.
18183
18209
  */
18184
18210
  everyNthFrame?: integer;
18211
+ /**
18212
+ * Maximum number of frames sent until screencastFrameAck is required.
18213
+ * Defaults to 3. Must be a positive integer.
18214
+ */
18215
+ maxFramesInFlight?: integer;
18216
+ /**
18217
+ * By default, after screencastFrameAck arrives, the next produced frame is sent.
18218
+ * Passing this flag enables storing the last produced frame in memory, which is
18219
+ * immediately sent upon screencastFrameAck. This way, overall performance is
18220
+ * traded for a better latency.
18221
+ */
18222
+ sendLastFrame?: boolean;
18185
18223
  }
18186
18224
 
18187
18225
  export interface StartScreenRecordingRequest {