| <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.telemetry.html">telemetry</a> . <a href="chromemanagement_v1.customers.telemetry.users.html">users</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="#get">get(name, readMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get telemetry user.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List all telemetry users.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_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="get">get(name, readMask=None, x__xgafv=None)</code> |
| <pre>Get telemetry user. |
| |
| Args: |
| name: string, Required. Name of the `TelemetryUser` to return. (required) |
| readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report - user_device.app_report |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Telemetry data collected from a managed user. * Granular permission needed: TELEMETRY_API_USER |
| "customer": "A String", # G Suite Customer whose enterprise enrolled the device. |
| "name": "A String", # Resource name of the user. |
| "orgUnitId": "A String", # Organization unit of the user. |
| "userDevice": [ # Telemetry data collected from a managed user and device. |
| { # Telemetry data collected for a managed user and device. * Granular permission needed: TELEMETRY_API_DEVICE |
| "appReport": [ # Output only. App reports collected periodically sorted in a decreasing order of report_time. |
| { # App report. |
| "reportTime": "A String", # Timestamp when the report was collected. |
| "usageData": [ # App usage data. |
| { # App usage data. |
| "appId": "A String", # App id. |
| "appInstanceId": "A String", # Application instance id. This will be unique per window/instance. |
| "appType": "A String", # Type of app. |
| "runningDuration": "A String", # App foreground running time. |
| }, |
| ], |
| }, |
| ], |
| "audioStatusReport": [ # Output only. Audio reports collected periodically sorted in a decreasing order of report_time. |
| { # Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceAudioStatus](https://chromeenterprise.google/policies/#ReportDeviceAudioStatus) * Data Collection Frequency: 10 minutes * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_AUDIO_REPORT |
| "inputDevice": "A String", # Output only. Active input device's name. |
| "inputGain": 42, # Output only. Active input device's gain in [0, 100]. |
| "inputMute": True or False, # Output only. Is active input device mute or not. |
| "outputDevice": "A String", # Output only. Active output device's name. |
| "outputMute": True or False, # Output only. Is active output device mute or not. |
| "outputVolume": 42, # Output only. Active output device's volume in [0, 100]. |
| "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device. |
| }, |
| ], |
| "deviceActivityReport": [ # Output only. Device activity reports collected periodically sorted in a decreasing order of report_time. |
| { # Device activity report. * Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT |
| "deviceActivityState": "A String", # Output only. Device activity state. |
| "reportTime": "A String", # Output only. Timestamp of when the report was collected. |
| }, |
| ], |
| "deviceId": "A String", # The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab. |
| "networkBandwidthReport": [ # Output only. Network bandwidth reports collected periodically sorted in a decreasing order of report_time. |
| { # Network bandwidth report. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT |
| "downloadSpeedKbps": "A String", # Output only. Download speed in kilobits per second. |
| "reportTime": "A String", # Output only. Timestamp of when the report was collected. |
| }, |
| ], |
| "peripheralsReport": [ # Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time. |
| { # Peripherals report. * Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT |
| "reportTime": "A String", # Output only. Timestamp of when the report was collected. |
| "usbPeripheralReport": [ # Reports of all usb connected devices. |
| { # USB connected peripheral report. |
| "categories": [ # Output only. Categories the device belongs to https://www.usb.org/defined-class-codes |
| "A String", |
| ], |
| "classId": 42, # Output only. Class ID https://www.usb.org/defined-class-codes |
| "firmwareVersion": "A String", # Output only. Firmware version |
| "name": "A String", # Output only. Device name, model name, or product name |
| "pid": 42, # Output only. Product ID |
| "subclassId": 42, # Output only. Subclass ID https://www.usb.org/defined-class-codes |
| "vendor": "A String", # Output only. Vendor name |
| "vid": 42, # Output only. Vendor ID |
| }, |
| ], |
| }, |
| ], |
| }, |
| ], |
| "userEmail": "A String", # Email address of the user. |
| "userId": "A String", # Directory ID of the user. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> |
| <pre>List all telemetry users. |
| |
| Args: |
| parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) |
| filter: string, Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id |
| pageSize: integer, Maximum number of results to return. Default value is 100. Maximum value is 1000. |
| pageToken: string, Token to specify next page in the list. |
| readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report - user_device.app_report |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for listing telemetry users for a customer. |
| "nextPageToken": "A String", # Token to specify next page in the list. |
| "telemetryUsers": [ # Telemetry users returned in the response. |
| { # Telemetry data collected from a managed user. * Granular permission needed: TELEMETRY_API_USER |
| "customer": "A String", # G Suite Customer whose enterprise enrolled the device. |
| "name": "A String", # Resource name of the user. |
| "orgUnitId": "A String", # Organization unit of the user. |
| "userDevice": [ # Telemetry data collected from a managed user and device. |
| { # Telemetry data collected for a managed user and device. * Granular permission needed: TELEMETRY_API_DEVICE |
| "appReport": [ # Output only. App reports collected periodically sorted in a decreasing order of report_time. |
| { # App report. |
| "reportTime": "A String", # Timestamp when the report was collected. |
| "usageData": [ # App usage data. |
| { # App usage data. |
| "appId": "A String", # App id. |
| "appInstanceId": "A String", # Application instance id. This will be unique per window/instance. |
| "appType": "A String", # Type of app. |
| "runningDuration": "A String", # App foreground running time. |
| }, |
| ], |
| }, |
| ], |
| "audioStatusReport": [ # Output only. Audio reports collected periodically sorted in a decreasing order of report_time. |
| { # Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceAudioStatus](https://chromeenterprise.google/policies/#ReportDeviceAudioStatus) * Data Collection Frequency: 10 minutes * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_AUDIO_REPORT |
| "inputDevice": "A String", # Output only. Active input device's name. |
| "inputGain": 42, # Output only. Active input device's gain in [0, 100]. |
| "inputMute": True or False, # Output only. Is active input device mute or not. |
| "outputDevice": "A String", # Output only. Active output device's name. |
| "outputMute": True or False, # Output only. Is active output device mute or not. |
| "outputVolume": 42, # Output only. Active output device's volume in [0, 100]. |
| "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device. |
| }, |
| ], |
| "deviceActivityReport": [ # Output only. Device activity reports collected periodically sorted in a decreasing order of report_time. |
| { # Device activity report. * Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT |
| "deviceActivityState": "A String", # Output only. Device activity state. |
| "reportTime": "A String", # Output only. Timestamp of when the report was collected. |
| }, |
| ], |
| "deviceId": "A String", # The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab. |
| "networkBandwidthReport": [ # Output only. Network bandwidth reports collected periodically sorted in a decreasing order of report_time. |
| { # Network bandwidth report. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT |
| "downloadSpeedKbps": "A String", # Output only. Download speed in kilobits per second. |
| "reportTime": "A String", # Output only. Timestamp of when the report was collected. |
| }, |
| ], |
| "peripheralsReport": [ # Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time. |
| { # Peripherals report. * Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT |
| "reportTime": "A String", # Output only. Timestamp of when the report was collected. |
| "usbPeripheralReport": [ # Reports of all usb connected devices. |
| { # USB connected peripheral report. |
| "categories": [ # Output only. Categories the device belongs to https://www.usb.org/defined-class-codes |
| "A String", |
| ], |
| "classId": 42, # Output only. Class ID https://www.usb.org/defined-class-codes |
| "firmwareVersion": "A String", # Output only. Firmware version |
| "name": "A String", # Output only. Device name, model name, or product name |
| "pid": 42, # Output only. Product ID |
| "subclassId": 42, # Output only. Subclass ID https://www.usb.org/defined-class-codes |
| "vendor": "A String", # Output only. Vendor name |
| "vid": 42, # Output only. Vendor ID |
| }, |
| ], |
| }, |
| ], |
| }, |
| ], |
| "userEmail": "A String", # Email address of the user. |
| "userId": "A String", # Directory ID of the user. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_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> |
