Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / analyticsadmin_v1alpha.properties.firebaseLinks.html
blob: 86aeb8870fc9bfb41981fcd60bb0906258280cee [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a FirebaseLink. Properties can have at most one FirebaseLink.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a FirebaseLink on a property</p>
86<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.</p>
89<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
100 <pre>Creates a FirebaseLink. Properties can have at most one FirebaseLink.
101
102Args:
103 parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
104 body: object, The request body.
105 The object takes the form of:
106
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]107{ # A link between an GA4 property and a Firebase project.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]108 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 &quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
110 &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;
111}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112
113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
117
118Returns:
119 An object of the form:
120
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121 { # A link between an GA4 property and a Firebase project.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]122 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]123 &quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
124 &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;
125}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126</div>
127
128<div class="method">
129 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
130 <pre>Deletes a FirebaseLink on a property
131
132Args:
133 name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
138
139Returns:
140 An object of the form:
141
142 { # 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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]143}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]144</div>
145
146<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]147 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 <pre>Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
149
150Args:
151 parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]152 pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
153 pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
162 { # Response message for ListFirebaseLinks RPC
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]163 &quot;firebaseLinks&quot;: [ # List of FirebaseLinks. This will have at most one value.
164 { # A link between an GA4 property and a Firebase project.
165 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this FirebaseLink was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]166 &quot;name&quot;: &quot;A String&quot;, # Output only. Example format: properties/1234/firebaseLinks/5678
167 &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;
168 },
169 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]170 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]171}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172</div>
173
174<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
183 A request object that you can call &#x27;execute()&#x27; on to request the next
184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]188</body></html>