blob: d6c735946d58fa53f71e456a1871f9d65151eaf3 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070081 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an iOS app stream on a property.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080085<p class="firstline">Lookup for a single IosAppDataStream</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070086<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080087 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<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>
89<p class="toc_element">
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>
92<p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates an iOS app stream on a property.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
103 <pre>Deletes an iOS app stream on a property.
104
105Args:
106 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)
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # 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 -0800116}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117</div>
118
119<div class="method">
120 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800121 <pre>Lookup for a single IosAppDataStream
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700122
123Args:
124 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)
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
133 { # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800134 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
135 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
136 &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.
137 &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.
138 &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;
139 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
140}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141</div>
142
143<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 <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.
146
147Args:
148 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 Botb6971b02020-11-26 17:16:03 -0800149 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)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800150 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
159 { # Request message for ListIosAppDataStreams RPC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800160 &quot;iosAppDataStreams&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
161 { # A resource message representing a Google Analytics IOS app stream.
162 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
163 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
164 &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.
165 &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.
166 &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;
167 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
168 },
169 ],
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.
171}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172</div>
173
174<div class="method">
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
188<div class="method">
189 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
190 <pre>Updates an iOS app stream on a property.
191
192Args:
193 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)
194 body: object, The request body.
195 The object takes the form of:
196
197{ # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800198 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
199 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
200 &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.
201 &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;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;
203 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
204}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700205
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800206 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212Returns:
213 An object of the form:
214
215 { # A resource message representing a Google Analytics IOS app stream.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800216 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
217 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
218 &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.
219 &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.
220 &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;
221 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
222}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223</div>
224
225</body></html>