blob: 557a29c30b44d602dc06a4e0602f089e9c2d93b9 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<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.iosAppDataStreams.html">iosAppDataStreams</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 an iOS app data stream with the specified location and attributes.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an iOS app stream 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 IosAppDataStream Throws "Target not found" if no such iOS app data stream found, or if the caller does not have permissions to access it.</p>
89<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080090 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</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 an iOS app stream on a property.</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 an iOS app data stream with the specified location and attributes.
107
108Args:
109 parent: string, Required. The parent resource where this ios app data stream will be created. Format: properties/123 (required)
110 body: object, The request body.
111 The object takes the form of:
112
113{ # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800114 &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.
115 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800116 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
117 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800118 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
119 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800120 }
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
130 { # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800131 &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.
132 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800133 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
134 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800135 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
136 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800137 }</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700138</div>
139
140<div class="method">
141 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
142 <pre>Deletes an iOS app stream on a property.
143
144Args:
145 name: string, Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/123/iosAppDataStreams/456&quot; (required)
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
154 { # 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 `{}`.
155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="get">get(name, x__xgafv=None)</code>
160 <pre>Lookup for a single IosAppDataStream Throws &quot;Target not found&quot; if no such iOS app data stream found, or if the caller does not have permissions to access it.
161
162Args:
163 name: string, Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/123/iosAppDataStreams/456&quot; (required)
164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
172 { # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800173 &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.
174 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800175 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
176 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800177 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
178 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800179 }</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180</div>
181
182<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800183 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700184 <pre>Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.
185
186Args:
187 parent: string, Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: &quot;properties/123&quot; (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800188 pageToken: string, A page token, received from a previous `ListIosAppDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIosAppDataStreams` must match the call that provided the page token.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800189 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)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195Returns:
196 An object of the form:
197
198 { # Request message for ListIosAppDataStreams RPC.
199 &quot;iosAppDataStreams&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
200 { # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800201 &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.
202 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800203 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
204 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800205 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
206 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800207 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800209 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
215 <pre>Retrieves the next page of results.
216
217Args:
218 previous_request: The request for the previous page. (required)
219 previous_response: The response from the request for the previous page. (required)
220
221Returns:
222 A request object that you can call &#x27;execute()&#x27; on to request the next
223 page. Returns None if there are no more items in the collection.
224 </pre>
225</div>
226
227<div class="method">
228 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
229 <pre>Updates an iOS app stream on a property.
230
231Args:
232 name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot; (required)
233 body: object, The request body.
234 The object takes the form of:
235
236{ # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800237 &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.
238 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800239 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
240 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800241 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
242 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800243 }
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244
245 updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251Returns:
252 An object of the form:
253
254 { # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800255 &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.
256 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800257 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
258 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: &quot;properties/1000/iosAppDataStreams/2000&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800259 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
260 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800261 }</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700262</div>
263
264</body></html>