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.webDataStreams.html">webDataStreams</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="analyticsadmin_v1alpha.properties.webDataStreams.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 web stream with the specified location and attributes.</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 web stream 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 WebDataStream</p> 94<p class="toc_element"> 95 <code><a href="#getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</a></code></p> 96<p class="firstline">Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates a web stream on a property.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 114 <pre>Creates a web stream with the specified location and attributes. 115 116Args: 117 parent: string, Required. The parent resource where this web data stream will be created. Format: properties/123 (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # A resource message representing a Google Analytics web stream. 122 "createTime": "A String", # Output only. Time when this stream was originally created. 123 "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" 124 "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. 125 "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. 126 "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" 127 "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" 128 "updateTime": "A String", # Output only. Time when stream payload fields were last updated. 129} 130 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # A resource message representing a Google Analytics web stream. 140 "createTime": "A String", # Output only. Time when this stream was originally created. 141 "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" 142 "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. 143 "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. 144 "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" 145 "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" 146 "updateTime": "A String", # Output only. Time when stream payload fields were last updated. 147}</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 152 <pre>Deletes a web stream on a property. 153 154Args: 155 name: string, Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456" (required) 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # 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 `{}`. 165}</pre> 166</div> 167 168<div class="method"> 169 <code class="details" id="get">get(name, x__xgafv=None)</code> 170 <pre>Lookup for a single WebDataStream 171 172Args: 173 name: string, Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456" (required) 174 x__xgafv: string, V1 error format. 175 Allowed values 176 1 - v1 error format 177 2 - v2 error format 178 179Returns: 180 An object of the form: 181 182 { # A resource message representing a Google Analytics web stream. 183 "createTime": "A String", # Output only. Time when this stream was originally created. 184 "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" 185 "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. 186 "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. 187 "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" 188 "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" 189 "updateTime": "A String", # Output only. Time when stream payload fields were last updated. 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</code> 195 <pre>Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. 196 197Args: 198 name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: "properties/123/webDataStreams/456/globalSiteTag" (required) 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # Read-only resource with the tag for sending data from a website to a WebDataStream. 208 "name": "A String", # Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag 209 "snippet": "A String", # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure. 210}</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 215 <pre>Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found. 216 217Args: 218 parent: string, Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123" (required) 219 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) 220 pageToken: string, A page token, received from a previous `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebDataStreams` must match the call that provided the page token. 221 x__xgafv: string, V1 error format. 222 Allowed values 223 1 - v1 error format 224 2 - v2 error format 225 226Returns: 227 An object of the form: 228 229 { # Request message for ListWebDataStreams RPC. 230 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 231 "webDataStreams": [ # Results that matched the filter criteria and were accessible to the caller. 232 { # A resource message representing a Google Analytics web stream. 233 "createTime": "A String", # Output only. Time when this stream was originally created. 234 "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" 235 "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. 236 "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. 237 "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" 238 "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" 239 "updateTime": "A String", # Output only. Time when stream payload fields were last updated. 240 }, 241 ], 242}</pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 247 <pre>Retrieves the next page of results. 248 249Args: 250 previous_request: The request for the previous page. (required) 251 previous_response: The response from the request for the previous page. (required) 252 253Returns: 254 A request object that you can call 'execute()' 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 web stream on a property. 262 263Args: 264 name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" (required) 265 body: object, The request body. 266 The object takes the form of: 267 268{ # A resource message representing a Google Analytics web stream. 269 "createTime": "A String", # Output only. Time when this stream was originally created. 270 "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" 271 "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. 272 "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. 273 "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" 274 "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" 275 "updateTime": "A String", # Output only. Time when stream payload fields were last updated. 276} 277 278 updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. 279 x__xgafv: string, V1 error format. 280 Allowed values 281 1 - v1 error format 282 2 - v2 error format 283 284Returns: 285 An object of the form: 286 287 { # A resource message representing a Google Analytics web stream. 288 "createTime": "A String", # Output only. Time when this stream was originally created. 289 "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" 290 "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. 291 "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. 292 "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" 293 "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" 294 "updateTime": "A String", # Output only. Time when stream payload fields were last updated. 295}</pre> 296</div> 297 298</body></html>