Files
google-apis-rs/google_firebase1_beta1_cli/projects_ios-apps-patch/index.html
2022-03-08 15:36:16 +08:00

483 lines
19 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 Apps Patch - Firebase Management v3.0.0+20220304</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"> Firebase Management v3.0.0+20220304</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Available Projects</span>
<li class="toctree-l1 ">
<a class="" href="../available-projects_list">List</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_add-firebase">Add Firebase</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_add-google-analytics">Add Google Analytics</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-create">Android Apps Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-get">Android Apps Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-get-config">Android Apps Get Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-list">Android Apps List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-patch">Android Apps Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-sha-create">Android Apps Sha Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-sha-delete">Android Apps Sha Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_android-apps-sha-list">Android Apps Sha List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_available-locations-list">Available Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_default-location-finalize">Default Location Finalize</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get-admin-sdk-config">Get Admin Sdk Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get-analytics-details">Get Analytics Details</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_ios-apps-create">Ios Apps Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_ios-apps-get">Ios Apps Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_ios-apps-get-config">Ios Apps Get Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_ios-apps-list">Ios Apps List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Ios Apps 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="../projects_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_remove-analytics">Remove Analytics</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_search-apps">Search Apps</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_web-apps-create">Web Apps Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_web-apps-get">Web Apps Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_web-apps-get-config">Web Apps Get Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_web-apps-list">Web Apps List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_web-apps-patch">Web Apps Patch</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 Apps Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firebase1_beta1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates the attributes of the specified IosApp.</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/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/firebase</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>firebase1-beta1 --scope &lt;scope&gt; projects ios-apps-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#39;s <a href="../../projects#FirebaseProject.FIELDS.project_number"><code>ProjectNumber</code></a> <strong><em>(recommended)</em></strong> or its <a href="../../projects#FirebaseProject.FIELDS.project_id"><code>ProjectId</code></a>. Learn more about using project identifiers in Google&#39;s <a href="https://google.aip.dev/cloud/2510">AIP 2510 standard</a>. Note that the value for PROJECT_IDENTIFIER in any response body will be the <code>ProjectId</code>. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see <a href="../../projects.iosApps#IosApp.FIELDS.app_id"><code>appId</code></a>).</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>IosApp:
api-key-id: string
app-id: string
app-store-id: string
bundle-id: string
display-name: string
name: string
project-id: string
team-id: 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 . api-key-id=rebum.</code><ul>
<li>The key_id of the GCP ApiKey associated with this App. If set must have no restrictions, or only have restrictions that are valid for the associated Firebase App. Cannot be set in create requests, instead an existing valid API Key will be chosen, or if no valid API Keys exist, one will be provisioned for you. Cannot be set to an empty value in update requests.</li>
</ul>
</li>
<li><code>app-id=est</code><ul>
<li>Immutable. The globally unique, Firebase-assigned identifier for the <code>IosApp</code>. This identifier should be treated as an opaque token, as the data format is not specified.</li>
</ul>
</li>
<li><code>app-store-id=ipsum</code><ul>
<li>The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.</li>
</ul>
</li>
<li><code>bundle-id=ipsum</code><ul>
<li>Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.</li>
</ul>
</li>
<li><code>display-name=est</code><ul>
<li>The user-assigned display name for the <code>IosApp</code>.</li>
</ul>
</li>
<li><code>name=gubergren</code><ul>
<li>The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#39;s <a href="../../projects#FirebaseProject.FIELDS.project_number"><code>ProjectNumber</code></a> <strong><em>(recommended)</em></strong> or its <a href="../../projects#FirebaseProject.FIELDS.project_id"><code>ProjectId</code></a>. Learn more about using project identifiers in Google&#39;s <a href="https://google.aip.dev/cloud/2510">AIP 2510 standard</a>. Note that the value for PROJECT_IDENTIFIER in any response body will be the <code>ProjectId</code>. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see <a href="../../projects.iosApps#IosApp.FIELDS.app_id"><code>appId</code></a>).</li>
</ul>
</li>
<li><code>project-id=ea</code><ul>
<li>Immutable. A user-assigned unique identifier of the parent FirebaseProject for the <code>IosApp</code>.</li>
</ul>
</li>
<li><code>team-id=dolor</code><ul>
<li>The Apple Developer Team ID associated with the App in the App Store.</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>Specifies which fields to update. Note that the fields <code>name</code>, <code>appId</code>, <code>projectId</code>, and <code>bundleId</code> are all immutable.</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="../projects_list" class="btn btn-neutral float-right" title="List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_ios-apps-list" class="btn btn-neutral" title="Ios Apps 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="../projects_ios-apps-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_list" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>