1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="chromemanagement_v1.html">Chrome Management API</a> . <a href="chromemanagement_v1.customers.html">customers</a> . <a href="chromemanagement_v1.customers.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#countChromeBrowsersNeedingAttention">countChromeBrowsersNeedingAttention(customer, orgUnitId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Count of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity.</p>
<p class="toc_element">
<code><a href="#countChromeCrashEvents">countChromeCrashEvents(customer, filter=None, orderBy=None, orgUnitId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a count of Chrome crash events.</p>
<p class="toc_element">
<code><a href="#countChromeDevicesReachingAutoExpirationDate">countChromeDevicesReachingAutoExpirationDate(customer, maxAueDate=None, minAueDate=None, orgUnitId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).</p>
<p class="toc_element">
<code><a href="#countChromeDevicesThatNeedAttention">countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947</p>
<p class="toc_element">
<code><a href="#countChromeHardwareFleetDevices">countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947</p>
<p class="toc_element">
<code><a href="#countChromeVersions">countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate report of installed Chrome versions.</p>
<p class="toc_element">
<code><a href="#countChromeVersions_next">countChromeVersions_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#countInstalledApps">countInstalledApps(customer, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate report of app installations.</p>
<p class="toc_element">
<code><a href="#countInstalledApps_next">countInstalledApps_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#countPrintJobsByPrinter">countPrintJobsByPrinter(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, printerOrgUnitId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a summary of printing done by each printer.</p>
<p class="toc_element">
<code><a href="#countPrintJobsByPrinter_next">countPrintJobsByPrinter_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#countPrintJobsByUser">countPrintJobsByUser(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, printerOrgUnitId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a summary of printing done by each user.</p>
<p class="toc_element">
<code><a href="#countPrintJobsByUser_next">countPrintJobsByUser_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#enumeratePrintJobs">enumeratePrintJobs(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, printerOrgUnitId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a list of print jobs.</p>
<p class="toc_element">
<code><a href="#enumeratePrintJobs_next">enumeratePrintJobs_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#findInstalledAppDevices">findInstalledAppDevices(customer, appId=None, appType=None, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate report of managed Chrome browser devices that have a specified app installed.</p>
<p class="toc_element">
<code><a href="#findInstalledAppDevices_next">findInstalledAppDevices_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="countChromeBrowsersNeedingAttention">countChromeBrowsersNeedingAttention(customer, orgUnitId=None, x__xgafv=None)</code>
<pre>Count of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity.
Args:
customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required)
orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing counts for browsers that need attention.
"noRecentActivityCount": "A String", # Number of browsers that haven’t had any recent activity
"pendingBrowserUpdateCount": "A String", # Number of browsers that are pending an OS update
"recentlyEnrolledCount": "A String", # Number of browsers that have been recently enrolled
}</pre>
</div>
<div class="method">
<code class="details" id="countChromeCrashEvents">countChromeCrashEvents(customer, filter=None, orderBy=None, orgUnitId=None, x__xgafv=None)</code>
<pre>Get a count of Chrome crash events.
Args:
customer: string, Customer ID. (required)
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Supported filter fields: * major_browser_version * minor_browser_version * browser_channel * device_platform * past_number_days Example: `major_browser_version = 'M115' AND past_number_days = '28'`.
orderBy: string, Field used to order results. Supported order by fields: * browser_version * count * date
orgUnitId: string, If specified, only count the number of crash events of the devices in this organizational unit.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response contains a list of CrashEventCountByVersionPerDay which count the chrome crash at the certain date.
"crashEventCounts": [ # Crash event counts grouped by date and browser version.
{ # The `count` of the Chrome crash events at the `date`.
"browserVersion": "A String", # Browser version this is counting.
"count": "A String", # Total count of crash events.
"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date of the crash event.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="countChromeDevicesReachingAutoExpirationDate">countChromeDevicesReachingAutoExpirationDate(customer, maxAueDate=None, minAueDate=None, orgUnitId=None, x__xgafv=None)</code>
<pre>Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).
Args:
customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required)
maxAueDate: string, Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or earlier than the maximum date.
minAueDate: string, Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or later than the minimum date.
orgUnitId: string, Optional. The organizational unit ID, if omitted, will return data for all organizational units.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a list of devices expiring in each month of a selected time frame. Counts are grouped by model and Auto Update Expiration date.
"deviceAueCountReports": [ # The list of reports sorted by auto update expiration date in ascending order.
{ # Report for CountChromeDevicesPerAueDateResponse, contains the count of devices of a specific model and auto update expiration range.
"aueMonth": "A String", # Enum value of month corresponding to the auto update expiration date in UTC time zone. If the device is already expired, this field is empty.
"aueYear": "A String", # Int value of year corresponding to the Auto Update Expiration date in UTC time zone. If the device is already expired, this field is empty.
"count": "A String", # Count of devices of this model.
"expired": True or False, # Boolean value for whether or not the device has already expired.
"model": "A String", # Public model name of the devices.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="countChromeDevicesThatNeedAttention">countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None)</code>
<pre>Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947
Args:
customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required)
orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned.
readMask: string, Required. Mask of the fields that should be populated in the returned report.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing counts for devices that need attention.
"noRecentPolicySyncCount": "A String", # Number of ChromeOS devices have not synced policies in the past 28 days.
"noRecentUserActivityCount": "A String", # Number of ChromeOS devices that have not seen any user activity in the past 28 days.
"osVersionNotCompliantCount": "A String", # Number of devices whose OS version is not compliant.
"pendingUpdate": "A String", # Number of devices that are pending an OS update.
"unsupportedPolicyCount": "A String", # Number of devices that are unable to apply a policy due to an OS version mismatch.
}</pre>
</div>
<div class="method">
<code class="details" id="countChromeHardwareFleetDevices">countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None)</code>
<pre>Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947
Args:
customer: string, Required. The customer ID or "my_customer". (required)
orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned.
readMask: string, Required. Mask of the fields that should be populated in the returned report.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a list of devices with a specific type of hardware specification from the requested hardware type.
"cpuReports": [ # The DeviceHardwareCountReport for device cpu type (for example Intel(R) Core(TM) i7-10610U CPU @ 1.80GHz).
{ # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
"bucket": "A String", # Public name of the hardware specification.
"count": "A String", # Count of devices with a unique hardware specification.
},
],
"memoryReports": [ # The DeviceHardwareCountReport for device memory amount in gigabytes (for example 16).
{ # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
"bucket": "A String", # Public name of the hardware specification.
"count": "A String", # Count of devices with a unique hardware specification.
},
],
"modelReports": [ # The DeviceHardwareCountReport for device model type (for example Acer C7 Chromebook).
{ # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
"bucket": "A String", # Public name of the hardware specification.
"count": "A String", # Count of devices with a unique hardware specification.
},
],
"storageReports": [ # The DeviceHardwareCountReport for device storage amount in gigabytes (for example 128).
{ # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
"bucket": "A String", # Public name of the hardware specification.
"count": "A String", # Count of devices with a unique hardware specification.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="countChromeVersions">countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Generate report of installed Chrome versions.
Args:
customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required)
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
orgUnitId: string, The ID of the organizational unit.
pageSize: integer, Maximum number of results to return. Maximum and default are 100.
pageToken: string, Token to specify the page of the request to be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing requested browser versions details and counts.
"browserVersions": [ # List of all browser versions and their install counts.
{ # Describes a browser version and its install count.
"channel": "A String", # Output only. The release channel of the installed browser.
"count": "A String", # Output only. Count grouped by device_system and major version
"deviceOsVersion": "A String", # Output only. Version of the system-specified operating system.
"system": "A String", # Output only. The device operating system.
"version": "A String", # Output only. The full version of the installed browser.
},
],
"nextPageToken": "A String", # Token to specify the next page of the request.
"totalSize": 42, # Total number browser versions matching request.
}</pre>
</div>
<div class="method">
<code class="details" id="countChromeVersions_next">countChromeVersions_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="countInstalledApps">countInstalledApps(customer, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Generate report of app installations.
Args:
customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required)
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions * risk_score
orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions * risk_score
orgUnitId: string, The ID of the organizational unit.
pageSize: integer, Maximum number of results to return. Maximum and default are 100.
pageToken: string, Token to specify the page of the request to be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing details of queried installed apps.
"installedApps": [ # List of installed apps matching request.
{ # Describes an installed app.
"appId": "A String", # Output only. Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).
"appInstallType": "A String", # Output only. How the app was installed.
"appSource": "A String", # Output only. Source of the installed app.
"appType": "A String", # Output only. Type of the app.
"browserDeviceCount": "A String", # Output only. Count of browser devices with this app installed.
"description": "A String", # Output only. Description of the installed app.
"disabled": True or False, # Output only. Whether the app is disabled.
"displayName": "A String", # Output only. Name of the installed app.
"homepageUri": "A String", # Output only. Homepage uri of the installed app.
"osUserCount": "A String", # Output only. Count of ChromeOS users with this app installed.
"permissions": [ # Output only. Permissions of the installed app.
"A String",
],
"riskAssessment": { # Risk assessment data about an extension/app. # Output only. If available, the risk assessment data about this extension.
"entries": [ # Individual risk assessments.
{ # One risk assessment entry.
"provider": "A String", # The risk assessment provider from which this entry comes from.
"riskAssessment": { # Risk assessment for a Chrome extension. # The details of the provider's risk assessment.
"assessment": "A String", # Risk assessment for the extension. Currently, this is a numerical value, and its interpretation is specific to each risk assessment provider.
"detailsUrl": "A String", # A URL that a user can navigate to for more information about the risk assessment.
"version": "A String", # The version of the extension that this assessment applies to.
},
"riskLevel": "A String", # The bucketed risk level for the risk assessment.
},
],
"overallRiskLevel": "A String", # Overall assessed risk level across all entries. This will be the highest risk level from all entries.
},
},
],
"nextPageToken": "A String", # Token to specify the next page of the request.
"totalSize": 42, # Total number of installed apps matching request.
}</pre>
</div>
<div class="method">
<code class="details" id="countInstalledApps_next">countInstalledApps_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="countPrintJobsByPrinter">countPrintJobsByPrinter(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, printerOrgUnitId=None, x__xgafv=None)</code>
<pre>Get a summary of printing done by each printer.
Args:
customer: string, Required. Customer ID prefixed with "customers/" or "customers/my_customer" to use the customer associated to the account making the request. (required)
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Note: Only >= and <= comparators are supported in this filter. Supported filter fields: * complete_time
orderBy: string, Field used to order results. If omitted, results will be ordered in ascending order of the 'printer' field. Supported order_by fields: * printer * job_count * device_count * user_count
pageSize: integer, Maximum number of results to return. Maximum and default are 100.
pageToken: string, Token to specify the page of the response to be returned.
printerOrgUnitId: string, The ID of the organizational unit for printers. If specified, only data for printers from the specified organizational unit will be returned. If omitted, data for printers from all organizational units will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a summary printing report for each printer from the specified organizational unit for the requested time interval.
"nextPageToken": "A String", # Pagination token for requesting the next page.
"printerReports": [ # List of PrinterReports matching request.
{ # Report for CountPrintJobsByPrinter, contains statistics on printer usage. Contains the total number of print jobs initiated with this printer, the number of users and the number of devices that have initiated at least one print job with this printer.
"deviceCount": "A String", # Number of chrome devices that have been used to send print jobs to the specified printer.
"jobCount": "A String", # Number of print jobs sent to the printer.
"printer": "A String", # Printer name.
"printerId": "A String", # Printer API ID.
"printerModel": "A String", # Printer model.
"userCount": "A String", # Number of users that have sent print jobs to the printer.
},
],
"totalSize": "A String", # Total number of printers matching request.
}</pre>
</div>
<div class="method">
<code class="details" id="countPrintJobsByPrinter_next">countPrintJobsByPrinter_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="countPrintJobsByUser">countPrintJobsByUser(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, printerOrgUnitId=None, x__xgafv=None)</code>
<pre>Get a summary of printing done by each user.
Args:
customer: string, Required. Customer ID prefixed with "customers/" or "customers/my_customer" to use the customer associated to the account making the request. (required)
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Note: Only >= and <= comparators are supported in this filter. Supported filter fields: * complete_time
orderBy: string, Field used to order results. If omitted, results will be ordered in ascending order of the 'user_email' field. Supported order_by fields: * user_email * job_count * printer_count * device_count
pageSize: integer, Maximum number of results to return. Maximum and default are 100.
pageToken: string, Token to specify the page of the response to be returned.
printerOrgUnitId: string, The ID of the organizational unit for printers. If specified, only print jobs initiated with printers from the specified organizational unit will be counted. If omitted, all print jobs will be counted.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a summary printing report for each user that has initiated a print job with a printer from the specified organizational unit during the requested time interval.
"nextPageToken": "A String", # Pagination token for requesting the next page.
"totalSize": "A String", # Total number of users matching request.
"userPrintReports": [ # List of UserPrintReports matching request.
{ # Report for CountPrintJobsByUser, contains printing statistics for a user. Contains the number of printers, the number of devices used to initiate print jobs, and the number of print jobs initiated.
"deviceCount": "A String", # Number of chrome devices that have been used to initiate print jobs by the user.
"jobCount": "A String", # Number of print jobs initiated by the user.
"printerCount": "A String", # Number of printers used by the user.
"userEmail": "A String", # The primary e-mail address of the user.
"userId": "A String", # The unique Directory API ID of the user.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="countPrintJobsByUser_next">countPrintJobsByUser_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="enumeratePrintJobs">enumeratePrintJobs(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, printerOrgUnitId=None, x__xgafv=None)</code>
<pre>Get a list of print jobs.
Args:
customer: string, Required. Customer ID prefixed with "customers/" or "customers/my_customer" to use the customer associated to the account making the request. (required)
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Note: Only >= and <= comparators are supported for `complete_time`. Note: Only = comparator supported for `user_id` and `printer_id`. Supported filter fields: * complete_time * printer_id * user_id
orderBy: string, Field used to order results. If not specified, results will be ordered in descending order of the `complete_time` field. Supported order by fields: * title * state * create_time * complete_time * document_page_count * color_mode * duplex_mode * printer * user_email
pageSize: integer, The number of print jobs in the page from 0 to 100 inclusive, if page_size is not specified or zero, the size will be 50.
pageToken: string, A page token received from a previous `EnumeratePrintJobs` call. Provide this to retrieve the subsequent page. If omitted, the first page of results will be returned. When paginating, all other parameters provided to `EnumeratePrintJobs` must match the call that provided the page token.
printerOrgUnitId: string, The ID of the organizational unit for printers. If specified, only print jobs submitted to printers from the specified organizational unit will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a list of print jobs.
"nextPageToken": "A String", # A token, which can be used in a subsequent request to retrieve the next page. If this field is omitted, there are no subsequent pages.
"printJobs": [ # List of requested print jobs.
{ # Represents a request to print a document that has been submitted to a printer.
"colorMode": "A String", # Color mode.
"completeTime": "A String", # Print job completion timestamp.
"copyCount": 42, # Number of copies.
"createTime": "A String", # Print job creation timestamp.
"documentPageCount": 42, # Number of pages in the document.
"duplexMode": "A String", # Duplex mode.
"id": "A String", # Unique ID of the print job.
"printer": "A String", # Name of the printer used for printing.
"printerId": "A String", # API ID of the printer used for printing.
"state": "A String", # The final state of the job.
"title": "A String", # The title of the document.
"userEmail": "A String", # The primary e-mail address of the user who submitted the print job.
"userId": "A String", # The unique Directory API ID of the user who submitted the print job.
},
],
"totalSize": "A String", # Total number of print jobs matching request.
}</pre>
</div>
<div class="method">
<code class="details" id="enumeratePrintJobs_next">enumeratePrintJobs_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="findInstalledAppDevices">findInstalledAppDevices(customer, appId=None, appType=None, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Generate report of managed Chrome browser devices that have a specified app installed.
Args:
customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required)
appId: string, Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).
appType: string, Type of the app. Optional. If not provided, an app type will be inferred from the format of the app ID.
Allowed values
APP_TYPE_UNSPECIFIED - App type not specified.
EXTENSION - Chrome extension.
APP - Chrome app.
THEME - Chrome theme.
HOSTED_APP - Chrome hosted app.
ANDROID_APP - ARC++ app.
filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
orderBy: string, Field used to order results. Supported order by fields: * machine * device_id
orgUnitId: string, The ID of the organizational unit.
pageSize: integer, Maximum number of results to return. Maximum and default are 100.
pageToken: string, Token to specify the page of the request to be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a list of devices with queried app installed.
"devices": [ # A list of devices which have the app installed. Sorted in ascending alphabetical order on the Device.machine field.
{ # Describes a device reporting Chrome browser information.
"deviceId": "A String", # Output only. The ID of the device that reported this Chrome browser information.
"machine": "A String", # Output only. The name of the machine within its local network.
},
],
"nextPageToken": "A String", # Token to specify the next page of the request.
"totalSize": 42, # Total number of devices matching request.
}</pre>
</div>
<div class="method">
<code class="details" id="findInstalledAppDevices_next">findInstalledAppDevices_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|