blob: 96d5f6d4d0a02b8e005e980974f0a6819d4380e3 [file] [log] [blame] [edit]
<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 &quot;my_customer&quot; 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 &quot;timestamp&quot; filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC &quot;Zulu&quot; format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: &quot;2014-10-02T15:01:23Z&quot;, &quot;2014-10-02T15:01:23.045123456Z&quot;, &quot;1679283943823&quot;.
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.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to specify next page in the list.
&quot;telemetryEvents&quot;: [ # Telemetry events returned in the response.
{ # Telemetry data reported by a managed device.
&quot;appInstallEvent&quot;: { # App installation data. # Output only. Payload for app install event. Present only when `event_type` is `APP_INSTALLED`.
&quot;appId&quot;: &quot;A String&quot;, # App id. For PWAs this is the start URL, and for extensions this is the extension id.
&quot;appInstallReason&quot;: &quot;A String&quot;, # App installation reason.
&quot;appInstallSource&quot;: &quot;A String&quot;, # App installation source.
&quot;appInstallTime&quot;: &quot;A String&quot;, # App installation time depending on the app lifecycle.
&quot;appType&quot;: &quot;A String&quot;, # Type of app.
},
&quot;appLaunchEvent&quot;: { # App launch data. # Output only. Payload for app launch event.Present only when `event_type` is `APP_LAUNCHED`.
&quot;appId&quot;: &quot;A String&quot;, # App id. For PWAs this is the start URL, and for extensions this is the extension id.
&quot;appLaunchSource&quot;: &quot;A String&quot;, # App launch source.
&quot;appType&quot;: &quot;A String&quot;, # Type of app.
},
&quot;appUninstallEvent&quot;: { # App uninstall data. # Output only. Payload for app uninstall event. Present only when `event_type` is `APP_UNINSTALLED`.
&quot;appId&quot;: &quot;A String&quot;, # App id. For PWAs this is the start URL, and for extensions this is the extension id.
&quot;appType&quot;: &quot;A String&quot;, # Type of app.
&quot;appUninstallSource&quot;: &quot;A String&quot;, # App uninstall source.
},
&quot;audioSevereUnderrunEvent&quot;: { # `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`.
},
&quot;device&quot;: { # Information about a device associated with telemetry data. * Granular Permission needed: TELEMETRY_API_DEVICE # Output only. Information about the device associated with the event.
&quot;deviceId&quot;: &quot;A String&quot;, # Output only. The unique Directory API ID of the device. This value is the same as the Admin Console&#x27;s Directory API ID in the ChromeOS Devices tab.
&quot;orgUnitId&quot;: &quot;A String&quot;, # Output only. Organization unit ID of the device.
},
&quot;eventType&quot;: &quot;A String&quot;, # The event type of the current event.
&quot;httpsLatencyChangeEvent&quot;: { # 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`.
&quot;httpsLatencyRoutineData&quot;: { # 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.
&quot;latency&quot;: &quot;A String&quot;, # Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY.
&quot;problem&quot;: &quot;A String&quot;, # Output only. HTTPS latency routine problem if a problem occurred.
},
&quot;httpsLatencyState&quot;: &quot;A String&quot;, # Current HTTPS latency state.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the event.
&quot;networkStateChangeEvent&quot;: { # `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`.
&quot;connectionState&quot;: &quot;A String&quot;, # Current connection state of the network.
&quot;guid&quot;: &quot;A String&quot;, # Unique identifier of the network.
},
&quot;osCrashEvent&quot;: { # OS crash data. # Output only. Payload for OS crash event. Present only when `event_type` is `OS_CRASH`.
&quot;crashId&quot;: &quot;A String&quot;, # Crash id.
&quot;crashType&quot;: &quot;A String&quot;, # Crash type.
&quot;sessionType&quot;: &quot;A String&quot;, # Session type.
},
&quot;reportTime&quot;: &quot;A String&quot;, # Timestamp that represents when the event was reported.
&quot;usbPeripheralsEvent&quot;: { # `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`.
&quot;usbPeripheralReport&quot;: [ # List of usb devices that were either added or removed.
{ # USB connected peripheral report.
&quot;categories&quot;: [ # Output only. Categories the device belongs to https://www.usb.org/defined-class-codes
&quot;A String&quot;,
],
&quot;classId&quot;: 42, # Output only. Class ID https://www.usb.org/defined-class-codes
&quot;firmwareVersion&quot;: &quot;A String&quot;, # Output only. Firmware version
&quot;name&quot;: &quot;A String&quot;, # Output only. Device name, model name, or product name
&quot;pid&quot;: 42, # Output only. Product ID
&quot;subclassId&quot;: 42, # Output only. Subclass ID https://www.usb.org/defined-class-codes
&quot;vendor&quot;: &quot;A String&quot;, # Output only. Vendor name
&quot;vid&quot;: 42, # Output only. Vendor ID
},
],
},
&quot;user&quot;: { # Information about a user associated with telemetry data. * Granular permission needed: TELEMETRY_API_USER # Output only. Information about the user associated with the event.
&quot;email&quot;: &quot;A String&quot;, # Output only. User&#x27;s email.
&quot;orgUnitId&quot;: &quot;A String&quot;, # Output only. Organization unit ID of the user.
},
&quot;vpnConnectionStateChangeEvent&quot;: { # `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`.
&quot;connectionState&quot;: &quot;A String&quot;, # Current connection state of the network.
&quot;guid&quot;: &quot;A String&quot;, # Unique identifier of the network.
},
&quot;wifiSignalStrengthEvent&quot;: { # `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`.
&quot;guid&quot;: &quot;A String&quot;, # Unique identifier of the network.
&quot;signalStrengthDbm&quot;: 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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>