blob: 443d10a9921701505ed1b404714527ae2d423e6b [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a FirebaseLink. Properties can have at most one FirebaseLink.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a FirebaseLink on a property</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a FirebaseLink on a property</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a FirebaseLink. Properties can have at most one FirebaseLink.
Args:
parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
body: object, The request body.
The object takes the form of:
{ # A link between an GA4 property and a Firebase project.
&quot;project&quot;: &quot;A String&quot;, # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
&quot;maximumUserAccess&quot;: &quot;A String&quot;, # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.
&quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A link between an GA4 property and a Firebase project.
&quot;project&quot;: &quot;A String&quot;, # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
&quot;maximumUserAccess&quot;: &quot;A String&quot;, # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.
&quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a FirebaseLink on a property
Args:
name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Args:
parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListFirebaseLinks RPC
&quot;firebaseLinks&quot;: [ # List of FirebaseLinks. This will have at most one value.
{ # A link between an GA4 property and a Firebase project.
&quot;project&quot;: &quot;A String&quot;, # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
&quot;maximumUserAccess&quot;: &quot;A String&quot;, # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.
&quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a FirebaseLink on a property
Args:
name: string, Output only. Example format: properties/1234/firebaseLinks/5678 (required)
body: object, The request body.
The object takes the form of:
{ # A link between an GA4 property and a Firebase project.
&quot;project&quot;: &quot;A String&quot;, # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
&quot;maximumUserAccess&quot;: &quot;A String&quot;, # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.
&quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
}
updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A link between an GA4 property and a Firebase project.
&quot;project&quot;: &quot;A String&quot;, # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
&quot;maximumUserAccess&quot;: &quot;A String&quot;, # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.
&quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
}</pre>
</div>
</body></html>