Debian Codegraph @

docs/dyn/analyticsadmin_v1beta.properties.dataStreams.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_v1beta.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1beta.properties.html">properties</a> . <a href="analyticsadmin_v1beta.properties.dataStreams.html">dataStreams</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html">measurementProtocolSecrets()</a></code>
79 </p>
80 <p class="firstline">Returns the measurementProtocolSecrets Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
87 <p class="firstline">Creates a DataStream.</p>
88 <p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90 <p class="firstline">Deletes a DataStream on a property.</p>
91 <p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93 <p class="firstline">Lookup for a single DataStream.</p>
94 <p class="toc_element">
95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96 <p class="firstline">Lists DataStreams on a property.</p>
97 <p class="toc_element">
98 <code><a href="#list_next">list_next()</a></code></p>
99 <p class="firstline">Retrieves the next page of results.</p>
100 <p class="toc_element">
101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">Updates a DataStream on a property.</p>
103 <h3>Method Details</h3>
104 <div class="method">
105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107 </div>
108
109 <div class="method">
110 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
111 <pre>Creates a DataStream.
112
113 Args:
114 parent: string, Required. Example format: properties/1234 (required)
115 body: object, The request body.
116 The object takes the form of:
117
118 { # A resource message representing a data stream.
119 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
120 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
121 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
122 },
123 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
124 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
125 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
126 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
127 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
128 },
129 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
130 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
131 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
132 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
133 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
134 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
135 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
136 },
137 }
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144 Returns:
145 An object of the form:
146
147 { # A resource message representing a data stream.
148 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
149 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
150 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
151 },
152 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
153 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
154 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
155 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
156 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
157 },
158 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
159 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
160 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
161 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
162 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
163 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
164 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
165 },
166 }</pre>
167 </div>
168
169 <div class="method">
170 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
171 <pre>Deletes a DataStream on a property.
172
173 Args:
174 name: string, Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 (required)
175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180 Returns:
181 An object of the form:
182
183 { # 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); }
184 }</pre>
185 </div>
186
187 <div class="method">
188 <code class="details" id="get">get(name, x__xgafv=None)</code>
189 <pre>Lookup for a single DataStream.
190
191 Args:
192 name: string, Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 (required)
193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198 Returns:
199 An object of the form:
200
201 { # A resource message representing a data stream.
202 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
203 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
204 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
205 },
206 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
207 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
208 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
209 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
210 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
211 },
212 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
213 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
214 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
215 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
216 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
217 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
218 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
219 },
220 }</pre>
221 </div>
222
223 <div class="method">
224 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
225 <pre>Lists DataStreams on a property.
226
227 Args:
228 parent: string, Required. Example format: properties/1234 (required)
229 pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
230 pageToken: string, A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token.
231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
235
236 Returns:
237 An object of the form:
238
239 { # Response message for ListDataStreams RPC.
240 &quot;dataStreams&quot;: [ # List of DataStreams.
241 { # A resource message representing a data stream.
242 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
243 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
244 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
245 },
246 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
247 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
248 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
249 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
250 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
251 },
252 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
253 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
254 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
255 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
256 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
257 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
258 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
259 },
260 },
261 ],
262 &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.
263 }</pre>
264 </div>
265
266 <div class="method">
267 <code class="details" id="list_next">list_next()</code>
268 <pre>Retrieves the next page of results.
269
270 Args:
271 previous_request: The request for the previous page. (required)
272 previous_response: The response from the request for the previous page. (required)
273
274 Returns:
275 A request object that you can call &#x27;execute()&#x27; on to request the next
276 page. Returns None if there are no more items in the collection.
277 </pre>
278 </div>
279
280 <div class="method">
281 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
282 <pre>Updates a DataStream on a property.
283
284 Args:
285 name: string, Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot; (required)
286 body: object, The request body.
287 The object takes the form of:
288
289 { # A resource message representing a data stream.
290 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
291 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
292 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
293 },
294 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
295 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
296 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
297 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
298 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
299 },
300 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
301 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
302 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
303 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
304 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
305 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
306 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
307 },
308 }
309
310 updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
311 x__xgafv: string, V1 error format.
312 Allowed values
313 1 - v1 error format
314 2 - v2 error format
315
316 Returns:
317 An object of the form:
318
319 { # A resource message representing a data stream.
320 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
321 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
322 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
323 },
324 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
325 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
326 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
327 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
328 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
329 },
330 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
331 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
332 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
333 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
334 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
335 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
336 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
337 },
338 }</pre>
339 </div>
340
341 </body></html>