Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.bigQueryLinks.html">bigQueryLinks</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 BigQueryLink.</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 BigQueryLink on a property.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lookup for a single BigQuery Link.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists BigQuery Links on a property.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a BigQueryLink.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
106 <pre>Creates a BigQueryLink.
107
108 Args:
109 parent: string, Required. Example format: properties/1234 (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A link between a Google Analytics property and BigQuery project.
114 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the link was created.
115 &quot;dailyExportEnabled&quot;: True or False, # If set true, enables daily data export to the linked Google Cloud project.
116 &quot;datasetLocation&quot;: &quot;A String&quot;, # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
117 &quot;excludedEvents&quot;: [ # The list of event names that will be excluded from exports.
118 &quot;A String&quot;,
119 ],
120 &quot;exportStreams&quot;: [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [&#x27;properties/1000/dataStreams/2000&#x27;]
121 &quot;A String&quot;,
122 ],
123 &quot;freshDailyExportEnabled&quot;: True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
124 &quot;includeAdvertisingId&quot;: True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
125 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27;
126 &quot;project&quot;: &quot;A String&quot;, # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
127 &quot;streamingExportEnabled&quot;: True or False, # If set true, enables streaming export to the linked Google Cloud project.
128 }
129
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135 Returns:
136 An object of the form:
137
138 { # A link between a Google Analytics property and BigQuery project.
139 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the link was created.
140 &quot;dailyExportEnabled&quot;: True or False, # If set true, enables daily data export to the linked Google Cloud project.
141 &quot;datasetLocation&quot;: &quot;A String&quot;, # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
142 &quot;excludedEvents&quot;: [ # The list of event names that will be excluded from exports.
143 &quot;A String&quot;,
144 ],
145 &quot;exportStreams&quot;: [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [&#x27;properties/1000/dataStreams/2000&#x27;]
146 &quot;A String&quot;,
147 ],
148 &quot;freshDailyExportEnabled&quot;: True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
149 &quot;includeAdvertisingId&quot;: True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
150 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27;
151 &quot;project&quot;: &quot;A String&quot;, # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
152 &quot;streamingExportEnabled&quot;: True or False, # If set true, enables streaming export to the linked Google Cloud project.
153 }</pre>
154 </div>
155
156 <div class="method">
157 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
158 <pre>Deletes a BigQueryLink on a property.
159
160 Args:
161 name: string, Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678 (required)
162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167 Returns:
168 An object of the form:
169
170 { # 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); }
171 }</pre>
172 </div>
173
174 <div class="method">
175 <code class="details" id="get">get(name, x__xgafv=None)</code>
176 <pre>Lookup for a single BigQuery Link.
177
178 Args:
179 name: string, Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456 (required)
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185 Returns:
186 An object of the form:
187
188 { # A link between a Google Analytics property and BigQuery project.
189 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the link was created.
190 &quot;dailyExportEnabled&quot;: True or False, # If set true, enables daily data export to the linked Google Cloud project.
191 &quot;datasetLocation&quot;: &quot;A String&quot;, # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
192 &quot;excludedEvents&quot;: [ # The list of event names that will be excluded from exports.
193 &quot;A String&quot;,
194 ],
195 &quot;exportStreams&quot;: [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [&#x27;properties/1000/dataStreams/2000&#x27;]
196 &quot;A String&quot;,
197 ],
198 &quot;freshDailyExportEnabled&quot;: True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
199 &quot;includeAdvertisingId&quot;: True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
200 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27;
201 &quot;project&quot;: &quot;A String&quot;, # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
202 &quot;streamingExportEnabled&quot;: True or False, # If set true, enables streaming export to the linked Google Cloud project.
203 }</pre>
204 </div>
205
206 <div class="method">
207 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
208 <pre>Lists BigQuery Links on a property.
209
210 Args:
211 parent: string, Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234 (required)
212 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)
213 pageToken: string, A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token.
214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219 Returns:
220 An object of the form:
221
222 { # Response message for ListBigQueryLinks RPC
223 &quot;bigqueryLinks&quot;: [ # List of BigQueryLinks.
224 { # A link between a Google Analytics property and BigQuery project.
225 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the link was created.
226 &quot;dailyExportEnabled&quot;: True or False, # If set true, enables daily data export to the linked Google Cloud project.
227 &quot;datasetLocation&quot;: &quot;A String&quot;, # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
228 &quot;excludedEvents&quot;: [ # The list of event names that will be excluded from exports.
229 &quot;A String&quot;,
230 ],
231 &quot;exportStreams&quot;: [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [&#x27;properties/1000/dataStreams/2000&#x27;]
232 &quot;A String&quot;,
233 ],
234 &quot;freshDailyExportEnabled&quot;: True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
235 &quot;includeAdvertisingId&quot;: True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
236 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27;
237 &quot;project&quot;: &quot;A String&quot;, # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
238 &quot;streamingExportEnabled&quot;: True or False, # If set true, enables streaming export to the linked Google Cloud project.
239 },
240 ],
241 &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.
242 }</pre>
243 </div>
244
245 <div class="method">
246 <code class="details" id="list_next">list_next()</code>
247 <pre>Retrieves the next page of results.
248
249 Args:
250 previous_request: The request for the previous page. (required)
251 previous_response: The response from the request for the previous page. (required)
252
253 Returns:
254 A request object that you can call &#x27;execute()&#x27; on to request the next
255 page. Returns None if there are no more items in the collection.
256 </pre>
257 </div>
258
259 <div class="method">
260 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
261 <pre>Updates a BigQueryLink.
262
263 Args:
264 name: string, Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27; (required)
265 body: object, The request body.
266 The object takes the form of:
267
268 { # A link between a Google Analytics property and BigQuery project.
269 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the link was created.
270 &quot;dailyExportEnabled&quot;: True or False, # If set true, enables daily data export to the linked Google Cloud project.
271 &quot;datasetLocation&quot;: &quot;A String&quot;, # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
272 &quot;excludedEvents&quot;: [ # The list of event names that will be excluded from exports.
273 &quot;A String&quot;,
274 ],
275 &quot;exportStreams&quot;: [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [&#x27;properties/1000/dataStreams/2000&#x27;]
276 &quot;A String&quot;,
277 ],
278 &quot;freshDailyExportEnabled&quot;: True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
279 &quot;includeAdvertisingId&quot;: True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
280 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27;
281 &quot;project&quot;: &quot;A String&quot;, # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
282 &quot;streamingExportEnabled&quot;: True or False, # If set true, enables streaming export to the linked Google Cloud project.
283 }
284
285 updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
286 x__xgafv: string, V1 error format.
287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
290
291 Returns:
292 An object of the form:
293
294 { # A link between a Google Analytics property and BigQuery project.
295 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the link was created.
296 &quot;dailyExportEnabled&quot;: True or False, # If set true, enables daily data export to the linked Google Cloud project.
297 &quot;datasetLocation&quot;: &quot;A String&quot;, # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
298 &quot;excludedEvents&quot;: [ # The list of event names that will be excluded from exports.
299 &quot;A String&quot;,
300 ],
301 &quot;exportStreams&quot;: [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [&#x27;properties/1000/dataStreams/2000&#x27;]
302 &quot;A String&quot;,
303 ],
304 &quot;freshDailyExportEnabled&quot;: True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
305 &quot;includeAdvertisingId&quot;: True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
306 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this BigQuery link. Format: &#x27;properties/{property_id}/bigQueryLinks/{bigquery_link_id}&#x27; Format: &#x27;properties/1234/bigQueryLinks/abc567&#x27;
307 &quot;project&quot;: &quot;A String&quot;, # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: &#x27;projects/{project number}&#x27; Example: &#x27;projects/1234&#x27;
308 &quot;streamingExportEnabled&quot;: True or False, # If set true, enables streaming export to the linked Google Cloud project.
309 }</pre>
310 </div>
311
312 </body></html>