mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
335 lines
19 KiB
HTML
335 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-firebase1_beta1-cli/projects_add-google-analytics/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Add Google Analytics - 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 = "Add Google Analytics";
|
|
var mkdocs_page_input_path = "projects_add-google-analytics.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-firebase1_beta1-cli/projects_add-google-analytics/";
|
|
</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 current"><a class="reference internal current" href="./">Add Google Analytics</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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"><a class="reference internal" href="../projects_ios-apps-patch/">Ios Apps Patch</a>
|
|
</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>Add Google Analytics</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_add-google-analytics.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>Links the specified FirebaseProject with an existing <a href="http://www.google.com/analytics/">Google Analytics account</a>. Using this call, you can either: - Specify an <code>analyticsAccountId</code> to provision a new Google Analytics property within the specified account and associate the new property with the <code>FirebaseProject</code>. - Specify an existing <code>analyticsPropertyId</code> to associate the property with the <code>FirebaseProject</code>. Note that when you call <code>AddGoogleAnalytics</code>: 1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in the <code>FirebaseProject</code> (based on the <code>packageName</code> or <code>bundleId</code> associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to <code>AndroidApps</code> and <code>IosApps</code>. 2. If no corresponding data streams are found for the Firebase Apps, new data streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the <a href="https://support.google.com/analytics/answer/9303323">Analytics documentation</a>. The result of this call is an <a href="../../v1beta1/operations"><code>Operation</code></a>. Poll the <code>Operation</code> to track the provisioning process by calling GetOperation until <a href="../../v1beta1/operations#Operation.FIELDS.done"><code>done</code></a> is <code>true</code>. When <code>done</code> is <code>true</code>, the <code>Operation</code> has either succeeded or failed. If the <code>Operation</code> succeeded, its <a href="../../v1beta1/operations#Operation.FIELDS.response"><code>response</code></a> is set to an AnalyticsDetails; if the <code>Operation</code> failed, its <a href="../../v1beta1/operations#Operation.FIELDS.error"><code>error</code></a> is set to a google.rpc.Status. To call <code>AddGoogleAnalytics</code>, a project member must be an Owner for the existing <code>FirebaseProject</code> and have the <a href="https://support.google.com/analytics/answer/2884495"><code>Edit</code> permission</a> for the Google Analytics account. If the <code>FirebaseProject</code> already has Google Analytics enabled, and you call <code>AddGoogleAnalytics</code> using an <code>analyticsPropertyId</code> that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying <code>timeZone</code> and <code>regionCode</code> in the call to <a href="../../v1beta1/projects/addFirebase"><code>AddFirebase</code></a>.</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 add-google-analytics ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the <code>FirebaseProject</code> <a href="../projects#FirebaseProject.FIELDS.name"><code>name</code></a> field for details about PROJECT_IDENTIFIER values.</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>AddGoogleAnalyticsRequest:
|
|
analytics-account-id: string
|
|
analytics-property-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 . analytics-account-id=magna</code><ul>
|
|
<li>The ID for the existing <a href="http://www.google.com/analytics/">Google Analytics account</a> that you want to link with the <code>FirebaseProject</code>. Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with the <code>FirebaseProject</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>analytics-property-id=no</code><ul>
|
|
<li>The ID for the existing Google Analytics property that you want to associate with the <code>FirebaseProject</code>.</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="../projects_add-firebase/" class="btn btn-neutral float-left" title="Add Firebase"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_android-apps-create/" class="btn btn-neutral float-right" title="Android Apps Create">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_add-firebase/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_android-apps-create/" 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>
|