mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
371 lines
19 KiB
HTML
371 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-fitness1-cli/users_data-sources-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Data Sources Create - fitness v5.0.4+20240304</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Data Sources Create";
|
|
var mkdocs_page_input_path = "users_data-sources-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-fitness1-cli/users_data-sources-create/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> fitness v5.0.4+20240304
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Users</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Data Sources Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-data-point-changes-list/">Data Sources Data Point Changes List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-datasets-delete/">Data Sources Datasets Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-datasets-get/">Data Sources Datasets Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-datasets-patch/">Data Sources Datasets Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-delete/">Data Sources Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-get/">Data Sources Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-list/">Data Sources List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_data-sources-update/">Data Sources Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_dataset-aggregate/">Dataset Aggregate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_sessions-delete/">Sessions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_sessions-list/">Sessions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_sessions-update/">Sessions Update</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">fitness v5.0.4+20240304</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Users »</li>
|
|
<li>Data Sources Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/fitness1-cli/edit/master/docs/users_data-sources-create.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Creates a new data source that is unique across all data sources belonging to this user. A data source is a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point in every dataset inserted into or read from the Fitness API has an associated data source. Each data source produces a unique stream of dataset updates, with a unique data source identifier. Not all changes to data source affect the data stream ID, so that data collected by updated versions of the same application/device can still be considered to belong to the same data source. Data sources are identified using a string generated by the server, based on the contents of the source being created. The dataStreamId field should not be set when invoking this method. It will be automatically generated by the server with the correct format. If a dataStreamId is set, it must match the format that the server would generate. This format is a combination of some fields from the data source, and has a specific order. If it doesn't match, the request will fail with an error. Specifying a DataType which is not a known type (beginning with "com.google.") will create a DataSource with a <em>custom data type</em>. Custom data types are only readable by the application that created them. Custom data types are <em>deprecated</em>; use standard data types instead. In addition to the data source fields included in the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/fitness.activity.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.blood_glucose.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.blood_pressure.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.body.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.body_temperature.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.heart_rate.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.location.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.nutrition.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.oxygen_saturation.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.reproductive_health.write</em></li>
|
|
<li><em>https://www.googleapis.com/auth/fitness.sleep.write</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/fitness.activity.write</em>.
|
|
You can set the scope for this method like this: <code>fitness1 --scope <scope> users data-sources-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><user-id></strong> <em>(string)</em><ul>
|
|
<li>Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>DataSource:
|
|
application:
|
|
details-url: string
|
|
name: string
|
|
package-name: string
|
|
version: string
|
|
data-quality-standard: [string]
|
|
data-stream-id: string
|
|
data-stream-name: string
|
|
data-type:
|
|
name: string
|
|
device:
|
|
manufacturer: string
|
|
model: string
|
|
type: string
|
|
uid: string
|
|
version: string
|
|
name: string
|
|
type: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .application details-url=et</code><ul>
|
|
<li>An optional URI that can be used to link back to the application.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=magna</code><ul>
|
|
<li>The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>package-name=no</code><ul>
|
|
<li>Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>version=ipsum</code></p>
|
|
<ul>
|
|
<li>Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. data-quality-standard=voluptua.</code></p>
|
|
<ul>
|
|
<li>DO NOT POPULATE THIS FIELD. It is never populated in responses from the platform, and is ignored in queries. It will be removed in a future version entirely.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-stream-id=at</code><ul>
|
|
<li>A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that make up the data stream ID are absent, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number and device UID are obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. This means a client will see a different set of data_stream_ids than another client with different credentials.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-stream-name=sanctus</code><ul>
|
|
<li>The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>data-type name=sed</code></p>
|
|
<ul>
|
|
<li>Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..device manufacturer=amet.</code></p>
|
|
<ul>
|
|
<li>Manufacturer of the product/hardware.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>model=takimata</code><ul>
|
|
<li>End-user visible model name for the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=amet.</code><ul>
|
|
<li>A constant representing the type of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>uid=duo</code><ul>
|
|
<li>The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form. The obfuscation preserves equality; that is, given two IDs, if id1 == id2, obfuscated(id1) == obfuscated(id2).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>version=ipsum</code></p>
|
|
<ul>
|
|
<li>Version string for the device hardware/software.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. name=gubergren</code></p>
|
|
<ul>
|
|
<li>An end-user visible name for this data source.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=lorem</code><ul>
|
|
<li>A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../users_data-sources-data-point-changes-list/" class="btn btn-neutral float-right" title="Data Sources Data Point Changes List">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/fitness1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href=".." style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../users_data-sources-data-point-changes-list/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|