| <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.events.html">events</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List telemetry events.</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="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> |
| <pre>List telemetry events. |
| |
| Args: |
| parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) |
| filter: string, Optional. Only include resources that match the filter. Although this parameter is currently optional, this parameter will be required- please specify at least 1 event type. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC "Zulu" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", "1679283943823". |
| pageSize: integer, Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000. |
| pageToken: string, Optional. Token to specify next page in the list. |
| readMask: string, Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event - external_displays_event |
| 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 events for a customer. |
| "nextPageToken": "A String", # Token to specify next page in the list. |
| "telemetryEvents": [ # Telemetry events returned in the response. |
| { # Telemetry data reported by a managed device. |
| "appInstallEvent": { # App installation data. # Output only. Payload for app install event. Present only when `event_type` is `APP_INSTALLED`. |
| "appId": "A String", # App id. For PWAs this is the start URL, and for extensions this is the extension id. |
| "appInstallReason": "A String", # App installation reason. |
| "appInstallSource": "A String", # App installation source. |
| "appInstallTime": "A String", # App installation time depending on the app lifecycle. |
| "appType": "A String", # Type of app. |
| }, |
| "appLaunchEvent": { # App launch data. # Output only. Payload for app launch event.Present only when `event_type` is `APP_LAUNCHED`. |
| "appId": "A String", # App id. For PWAs this is the start URL, and for extensions this is the extension id. |
| "appLaunchSource": "A String", # App launch source. |
| "appType": "A String", # Type of app. |
| }, |
| "appUninstallEvent": { # App uninstall data. # Output only. Payload for app uninstall event. Present only when `event_type` is `APP_UNINSTALLED`. |
| "appId": "A String", # App id. For PWAs this is the start URL, and for extensions this is the extension id. |
| "appType": "A String", # Type of app. |
| "appUninstallSource": "A String", # App uninstall source. |
| }, |
| "audioSevereUnderrunEvent": { # `TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds. * Granular permission needed: TELEMETRY_API_AUDIO_REPORT # Output only. Payload for audio severe underrun event. Present only when the `event_type` field is `AUDIO_SEVERE_UNDERRUN`. |
| }, |
| "device": { # Information about a device associated with telemetry data. * Granular Permission needed: TELEMETRY_API_DEVICE # Output only. Information about the device associated with the event. |
| "deviceId": "A String", # Output only. 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. |
| "orgUnitId": "A String", # Output only. Organization unit ID of the device. |
| }, |
| "eventType": "A String", # The event type of the current event. |
| "httpsLatencyChangeEvent": { # Https latency routine is run periodically and `TelemetryHttpsLatencyChangeEvent` is triggered if a latency problem was detected or if the device has recovered from a latency problem. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT # Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`. |
| "httpsLatencyRoutineData": { # Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites. # HTTPS latency routine data that triggered the event. |
| "latency": "A String", # Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY. |
| "problem": "A String", # Output only. HTTPS latency routine problem if a problem occurred. |
| }, |
| "httpsLatencyState": "A String", # Current HTTPS latency state. |
| }, |
| "name": "A String", # Output only. Resource name of the event. |
| "networkStateChangeEvent": { # `TelemetryNetworkConnectionStateChangeEvent` is triggered on network connection state changes. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT # Output only. Payload for network connection state change event. Present only when `event_type` is `NETWORK_STATE_CHANGE`. |
| "connectionState": "A String", # Current connection state of the network. |
| "guid": "A String", # Unique identifier of the network. |
| }, |
| "osCrashEvent": { # OS crash data. # Output only. Payload for OS crash event. Present only when `event_type` is `OS_CRASH`. |
| "crashId": "A String", # Crash id. |
| "crashType": "A String", # Crash type. |
| "sessionType": "A String", # Session type. |
| }, |
| "reportTime": "A String", # Timestamp that represents when the event was reported. |
| "usbPeripheralsEvent": { # `TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed. * Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT # Output only. Payload for usb peripherals event. Present only when the `event_type` field is either `USB_ADDED` or `USB_REMOVED`. |
| "usbPeripheralReport": [ # List of usb devices that were either added or removed. |
| { # 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 |
| }, |
| ], |
| }, |
| "user": { # Information about a user associated with telemetry data. * Granular permission needed: TELEMETRY_API_USER # Output only. Information about the user associated with the event. |
| "email": "A String", # Output only. User's email. |
| "orgUnitId": "A String", # Output only. Organization unit ID of the user. |
| }, |
| "vpnConnectionStateChangeEvent": { # `TelemetryNetworkConnectionStateChangeEvent` is triggered on network connection state changes. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT # Output only. Payload for VPN connection state change event. Present only when `event_type` is `VPN_CONNECTION_STATE_CHANGE`. |
| "connectionState": "A String", # Current connection state of the network. |
| "guid": "A String", # Unique identifier of the network. |
| }, |
| "wifiSignalStrengthEvent": { # `TelemetryNetworkSignalStrengthEvent` is triggered on WiFi signal strength events. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT # Output only. Payload for WiFi signal strength events. Present only when `event_type` is `WIFI_SIGNAL_STRENGTH_LOW` or `WIFI_SIGNAL_STRENGTH_RECOVERED`. |
| "guid": "A String", # Unique identifier of the network. |
| "signalStrengthDbm": 42, # Signal strength RSSI value. |
| }, |
| }, |
| ], |
| }</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> |
