mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
18 lines
8.0 KiB
HTML
18 lines
8.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_chromeuxreport1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_chromeuxreport1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_chromeuxreport1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class="location"><a href="../index.html">google_chromeuxreport1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_chromeuxreport1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_chromeuxreport1/api.rs.html#1-590" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Bin.html" title="google_chromeuxreport1::api::Bin struct">Bin</a></td><td class="docblock-short"><p>A bin is a discrete portion of data spanning from start to end, or if no end is given, then from start to +inf. A bin's start and end values are given in the value type of the metric it represents. For example, "first contentful paint" is measured in milliseconds and exposed as ints, therefore its metric bins will use int32s for its start and end types. However, "cumulative layout shift" is measured in unitless decimals and is exposed as a decimal encoded as a string, therefore its metric bins will use strings for its value type.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChromeUXReport.html" title="google_chromeuxreport1::api::ChromeUXReport struct">ChromeUXReport</a></td><td class="docblock-short"><p>Central instance to access all ChromeUXReport related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Key.html" title="google_chromeuxreport1::api::Key struct">Key</a></td><td class="docblock-short"><p>Key defines all the dimensions that identify this record as unique.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Metric.html" title="google_chromeuxreport1::api::Metric struct">Metric</a></td><td class="docblock-short"><p>A <code>metric</code> is a set of user experience data for a single web performance metric, like "first contentful paint". It contains a summary histogram of real world Chrome usage as a series of <code>bins</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Percentiles.html" title="google_chromeuxreport1::api::Percentiles struct">Percentiles</a></td><td class="docblock-short"><p>Percentiles contains synthetic values of a metric at a given statistical percentile. These are used for estimating a metric's value as experienced by a percentage of users out of the total number of users.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.QueryRequest.html" title="google_chromeuxreport1::api::QueryRequest struct">QueryRequest</a></td><td class="docblock-short"><p>Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.QueryResponse.html" title="google_chromeuxreport1::api::QueryResponse struct">QueryResponse</a></td><td class="docblock-short"><p>Response payload sent back to a physical web client. This response contains the record found based on the identiers present in a <code>QueryRequest</code>. The returned response will have a record, and sometimes details on normalization actions taken on the request that were necessary to make the request successful.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Record.html" title="google_chromeuxreport1::api::Record struct">Record</a></td><td class="docblock-short"><p>Record is a single Chrome UX report data record. It contains use experience statistics for a single url pattern and set of dimensions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RecordMethods.html" title="google_chromeuxreport1::api::RecordMethods struct">RecordMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>record</em> resources.
|
||
It is not used directly, but through the <code>ChromeUXReport</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RecordQueryRecordCall.html" title="google_chromeuxreport1::api::RecordQueryRecordCall struct">RecordQueryRecordCall</a></td><td class="docblock-short"><p>Queries the Chrome User Experience for a single <code>record</code> for a given site. Returns a <code>record</code> that contains one or more <code>metrics</code> corresponding to performance data about the requested site.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UrlNormalization.html" title="google_chromeuxreport1::api::UrlNormalization struct">UrlNormalization</a></td><td class="docblock-short"><p>Object representing the normalization actions taken to normalize a url to achieve a higher chance of successful lookup. These are simple automated changes that are taken when looking up the provided <code>url_patten</code> would be known to fail. Complex actions like following redirects are not handled.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_chromeuxreport1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |