mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
292 lines
12 KiB
HTML
292 lines
12 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-proximitybeacon1_beta1-cli/beacons_activate/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Activate - proximitybeacon v5.0.4+20200127</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 = "Activate";
|
|
var mkdocs_page_input_path = "beacons_activate.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-proximitybeacon1_beta1-cli/beacons_activate/";
|
|
</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"> proximitybeacon v5.0.4+20200127
|
|
</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">Beaconinfo</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beaconinfo_getforobserved/">Getforobserved</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Beacons</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Activate</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_attachments-batch-delete/">Attachments Batch Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_attachments-create/">Attachments Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_attachments-delete/">Attachments Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_attachments-list/">Attachments List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_deactivate/">Deactivate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_decommission/">Decommission</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_diagnostics-list/">Diagnostics List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_register/">Register</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../beacons_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Methods</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_get-eidparams/">Get Eidparams</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Namespaces</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../namespaces_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../namespaces_update/">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="..">proximitybeacon v5.0.4+20200127</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>Beacons »</li>
|
|
<li>Activate</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/proximitybeacon1_beta1-cli/edit/master/docs/beacons_activate.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>Activates a beacon. A beacon that is active will return information
|
|
and attachment data when queried via <code>beaconinfo.getforobserved</code>.
|
|
Calling this method on an already active beacon will do nothing (but
|
|
will return a successful response code).</p>
|
|
<p>Authenticate using an <a href="https://developers.google.com/identity/protocols/OAuth2">OAuth access
|
|
token</a> from a
|
|
signed-in user with <strong>Is owner</strong> or <strong>Can edit</strong> permissions in the Google
|
|
Developers Console project.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/userlocation.beacon.registry</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/userlocation.beacon.registry</em>.
|
|
You can set the scope for this method like this: <code>proximitybeacon1-beta1 --scope <scope> beacons activate ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><beacon-name></strong> <em>(string)</em><ul>
|
|
<li>Beacon that should be activated. A beacon name has the format
|
|
"beacons/N!beaconId" where the beaconId is the base16 ID broadcast by
|
|
the beacon and N is a code for the beacon's type. Possible values are
|
|
<code>3</code> for Eddystone-UID, <code>4</code> for Eddystone-EID, <code>1</code> for iBeacon, or <code>5</code>
|
|
for AltBeacon. For Eddystone-EID beacons, you may use either the
|
|
current EID or the beacon's "stable" UID.
|
|
Required.</li>
|
|
</ul>
|
|
</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-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p project-id=string</strong><ul>
|
|
<li>The project id of the beacon to activate. If the project id is not
|
|
specified then the project making the request is used. The project id
|
|
must match the project that owns the beacon.
|
|
Optional.</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="../beaconinfo_getforobserved/" class="btn btn-neutral float-left" title="Getforobserved"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../beacons_attachments-batch-delete/" class="btn btn-neutral float-right" title="Attachments Batch Delete">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/proximitybeacon1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../beaconinfo_getforobserved/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../beacons_attachments-batch-delete/" 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>
|