Files
google-apis-rs/google_analyticsadmin1_alpha_cli/properties_ios-app-data-streams-patch/index.html
2021-04-15 11:12:08 +08:00

609 lines
23 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Ios App Data Streams Patch - Google Analytics Admin v2.0.4+20210331</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> Google Analytics Admin v2.0.4+20210331</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Account Summaries</span>
<li class="toctree-l1 ">
<a class="" href="../account-summaries_list">List</a>
</li>
<span>Accounts</span>
<li class="toctree-l1 ">
<a class="" href="../accounts_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_get-data-sharing-settings">Get Data Sharing Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_provision-account-ticket">Provision Account Ticket</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_search-change-history-events">Search Change History Events</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-audit">User Links Audit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-batch-create">User Links Batch Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-batch-delete">User Links Batch Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-batch-get">User Links Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-batch-update">User Links Batch Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-create">User Links Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-delete">User Links Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-get">User Links Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-list">User Links List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_user-links-patch">User Links Patch</a>
</li>
<span>Properties</span>
<li class="toctree-l1 ">
<a class="" href="../properties_android-app-data-streams-create">Android App Data Streams Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_android-app-data-streams-delete">Android App Data Streams Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_android-app-data-streams-get">Android App Data Streams Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_android-app-data-streams-list">Android App Data Streams List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_android-app-data-streams-patch">Android App Data Streams Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_firebase-links-create">Firebase Links Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_firebase-links-delete">Firebase Links Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_firebase-links-list">Firebase Links List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_firebase-links-patch">Firebase Links Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_google-ads-links-create">Google Ads Links Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_google-ads-links-delete">Google Ads Links Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_google-ads-links-list">Google Ads Links List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_google-ads-links-patch">Google Ads Links Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_ios-app-data-streams-create">Ios App Data Streams Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_ios-app-data-streams-delete">Ios App Data Streams Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_ios-app-data-streams-get">Ios App Data Streams Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_ios-app-data-streams-list">Ios App Data Streams List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Ios App Data Streams Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-audit">User Links Audit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-batch-create">User Links Batch Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-batch-delete">User Links Batch Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-batch-get">User Links Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-batch-update">User Links Batch Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-create">User Links Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-delete">User Links Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-get">User Links Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-list">User Links List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_user-links-patch">User Links Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-create">Web Data Streams Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-delete">Web Data Streams Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-get">Web Data Streams Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-get-enhanced-measurement-settings">Web Data Streams Get Enhanced Measurement Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-get-global-site-tag">Web Data Streams Get Global Site Tag</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-list">Web Data Streams List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-patch">Web Data Streams Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../properties_web-data-streams-update-enhanced-measurement-settings">Web Data Streams Update Enhanced Measurement Settings</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Ios App Data Streams Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/analyticsadmin1_alpha-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates an iOS app stream on a property.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/analytics.edit</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/analytics.edit</em>.
You can set the scope for this method like this: <code>analyticsadmin1-alpha --scope &lt;scope&gt; properties ios-app-data-streams-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &#34;properties/1000/iosAppDataStreams/2000&#34;</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>GoogleAnalyticsAdminV1alphaIosAppDataStream:
bundle-id: string
create-time: string
display-name: string
firebase-app-id: string
name: string
update-time: 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 . bundle-id=gubergren</code><ul>
<li>Required. Immutable. The Apple App Store Bundle ID for the app Example: &#34;com.example.myiosapp&#34;</li>
</ul>
</li>
<li><code>create-time=et</code><ul>
<li>Output only. Time when this stream was originally created.</li>
</ul>
</li>
<li><code>display-name=accusam</code><ul>
<li>Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.</li>
</ul>
</li>
<li><code>firebase-app-id=voluptua.</code><ul>
<li>Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.</li>
</ul>
</li>
<li><code>name=dolore</code><ul>
<li>Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &#34;properties/1000/iosAppDataStreams/2000&#34;</li>
</ul>
</li>
<li><code>update-time=dolore</code><ul>
<li>Output only. Time when stream payload fields were last updated.</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-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 update-mask=string</strong><ul>
<li>Required. The list of fields to be updated. Field names must be in snake case (e.g., &#34;field_to_update&#34;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &#34;*&#34; to match all fields.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../properties_list" class="btn btn-neutral float-right" title="List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../properties_ios-app-data-streams-list" class="btn btn-neutral" title="Ios App Data Streams List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../properties_ios-app-data-streams-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../properties_list" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>