mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 04:35:18 +01:00
390 lines
20 KiB
HTML
390 lines
20 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-firebase1_beta1-cli/projects_ios-apps-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Ios Apps Patch - Firebase Management 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 = "Ios Apps Patch";
|
|
var mkdocs_page_input_path = "projects_ios-apps-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-firebase1_beta1-cli/projects_ios-apps-patch/";
|
|
</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"> Firebase Management 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">Available Projects</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../available-projects_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_add-firebase/">Add Firebase</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_add-google-analytics/">Add Google Analytics</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-create/">Android Apps Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-get/">Android Apps Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-get-config/">Android Apps Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-list/">Android Apps List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-patch/">Android Apps Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-remove/">Android Apps Remove</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-sha-create/">Android Apps Sha Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-sha-delete/">Android Apps Sha Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-sha-list/">Android Apps Sha List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-undelete/">Android Apps Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_available-locations-list/">Available Locations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_default-location-finalize/">Default Location Finalize</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_get-admin-sdk-config/">Get Admin Sdk Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_get-analytics-details/">Get Analytics Details</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-create/">Ios Apps Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-get/">Ios Apps Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-get-config/">Ios Apps Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-list/">Ios Apps List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Ios Apps Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-remove/">Ios Apps Remove</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-undelete/">Ios Apps Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_remove-analytics/">Remove Analytics</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_search-apps/">Search Apps</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-create/">Web Apps Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-get/">Web Apps Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-get-config/">Web Apps Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-list/">Web Apps List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-patch/">Web Apps Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-remove/">Web Apps Remove</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-undelete/">Web Apps Undelete</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="..">Firebase Management 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>Projects »</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/edit/master/docs/projects_ios-apps-patch.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>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 <scope> projects ios-apps-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></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'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'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
|
|
etag: string
|
|
expire-time: string
|
|
name: string
|
|
project-id: string
|
|
state: 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=sed</code><ul>
|
|
<li>The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the <code>IosApp</code>. Be aware that this value is the UID of the API key, <em>not</em> the <a href="https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string"><code>keyString</code></a> of the API key. The <code>keyString</code> is the value that can be found in the App's <a href="../../rest/v1beta1/projects.iosApps/getConfig">configuration artifact</a>. If <code>api_key_id</code> is not set in requests to <a href="../../rest/v1beta1/projects.iosApps/create"><code>iosApps.Create</code></a>, then Firebase automatically associates an <code>api_key_id</code> with the <code>IosApp</code>. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, <code>api_key_id</code> cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated <code>IosApp</code>. We recommend using the <a href="https://console.cloud.google.com/apis/credentials">Google Cloud Console</a> to manage API keys.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>app-id=duo</code><ul>
|
|
<li>Output only. 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=dolore</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=et</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=voluptua.</code><ul>
|
|
<li>The user-assigned display name for the <code>IosApp</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>etag=amet.</code><ul>
|
|
<li>This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about <code>etag</code> in Google's <a href="https://google.aip.dev/154#declarative-friendly-resources">AIP-154 standard</a>. This etag is strongly validated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>expire-time=consetetur</code><ul>
|
|
<li>Output only. Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the <code>DELETED</code> state.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=diam</code><ul>
|
|
<li>The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'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'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=dolor</code><ul>
|
|
<li>Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the <code>IosApp</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=et</code><ul>
|
|
<li>Output only. The lifecycle state of the App.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>team-id=et</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 of the IosApp to update. Note that the following fields are immutable: <code>name</code>, <code>app_id</code>, <code>project_id</code>, and <code>bundle_id</code>. To update <code>state</code>, use any of the following endpoints: RemoveIosApp or UndeleteIosApp.</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="../projects_ios-apps-list/" class="btn btn-neutral float-left" title="Ios Apps List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_ios-apps-remove/" class="btn btn-neutral float-right" title="Ios Apps Remove">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/firebase1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_ios-apps-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_ios-apps-remove/" 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>
|