Blame - docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html - platform/external/python/google-api-python-client

<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

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Creates a web stream with the specified location and attributes.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a web stream on a property.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Lookup for a single WebDataStream Throws "Target not found" if no such web data stream found, or if the caller does not have permissions to access it.</p>

89

90

<code><a href="#getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</a></code></p>

91

<p class="firstline">Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.</p>

92

93

<code><a href="#getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</a></code></p>

94

<p class="firstline">Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.</p>

95

96

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

97

<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>

98

99

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

100

<p class="firstline">Retrieves the next page of results.</p>

101

102

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

103

<p class="firstline">Updates a web stream on a property.</p>

104

105

<code><a href="#updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

106

<p class="firstline">Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.</p>

107

<h3>Method Details</h3>

108

109

<code class="details" id="close">close()</code>

110

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

115

<pre>Creates a web stream with the specified location and attributes.

116

117

Args:

118

parent: string, Required. The parent resource where this web data stream will be created. Format: properties/123 (required)

119

body: object, The request body.

120

The object takes the form of:

121

122

{ # A resource message representing a Google Analytics web stream.

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 100 UTF-16 code units.

125

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

126

"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.

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

"createTime": "A String", # Output only. Time when this stream was originally created.

130

}

131

132

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

139

140

{ # A resource message representing a Google Analytics web stream.

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 100 UTF-16 code units.

143

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

144

"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.

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

"createTime": "A String", # Output only. Time when this stream was originally created.

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

153

<pre>Deletes a web stream on a property.

154

155

Args:

156

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)

157

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

164

165

{ # 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 `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

171

<pre>Lookup for a single WebDataStream Throws "Target not found" if no such web data stream found, or if the caller does not have permissions to access it.

172

173

Args:

174

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)

175

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

182

183

{ # A resource message representing a Google Analytics web stream.

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 100 UTF-16 code units.

186

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

187

"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.

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

"createTime": "A String", # Output only. Time when this stream was originally created.

}</pre>

</div>

<code class="details" id="getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</code>

196

<pre>Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

197

198

Args:

199

name: string, Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings" (required)

200

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

207

208

{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

209

"productsAndEcommerceEnabled": True or False, # Capture events when your visitors view content on your site that has product details screens, etc.

210

"fileDownloadsEnabled": True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.

211

"siteSearchEnabled": True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).

212

"excludedDomains": "A String", # Domains to exclude from measurement. Max length is 1024 characters.

213

"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

214

"articlesAndBlogsEnabled": True or False, # Capture events when your visitors view content on your site that has articles or blog posts.

215

"urlQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.

216

"formInteractionsEnabled": True or False, # If enabled, capture a view search results event each time a visitor interacts with a form on your site.

217

"contentViewsEnabled": True or False, # Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.).

218

"pageViewsEnabled": True or False, # Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.

219

"dataTaggedElementClicksEnabled": True or False, # If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with "data-ga".

220

"streamEnabled": True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.

221

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"

222

"pageLoadsEnabled": True or False, # If enabled, capture a page view event each time a page loads.

223

"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.

224

"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.

225

"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

226

"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.

}</pre>

</div>

<code class="details" id="getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</code>

232

<pre>Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

233

234

Args:

235

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)

236

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

243

244

{ # Read-only resource with the tag for sending data from a website to a WebDataStream.

245

"snippet": "A String", # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.

}</pre>

</div>

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

251

<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.

252

253

Args:

254

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)

255

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.

256

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)

257

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

264

265

{ # Request message for ListWebDataStreams RPC.

266

"webDataStreams": [ # Results that matched the filter criteria and were accessible to the caller.

267

{ # A resource message representing a Google Analytics web stream.

268

"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

269

"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.

270

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

271

"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.

272

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

273

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

274

"createTime": "A String", # Output only. Time when this stream was originally created.

275

},

276

],

277

"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.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

283

<pre>Retrieves the next page of results.

284

285

Args:

286

previous_request: The request for the previous page. (required)

287

previous_response: The response from the request for the previous page. (required)

288

289

Returns:

290

A request object that you can call 'execute()' on to request the next

291

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

297

<pre>Updates a web stream on a property.

298

299

Args:

300

name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" (required)

301

body: object, The request body.

302

The object takes the form of:

303

304

{ # A resource message representing a Google Analytics web stream.

305

"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

306

"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.

307

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

308

"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.

309

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

310

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

311

"createTime": "A String", # Output only. Time when this stream was originally created.

312

}

313

314

updateMask: string, The list of fields to be updated. Omitted fields will not be updated.

315

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

322

323

{ # A resource message representing a Google Analytics web stream.

324

"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

325

"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.

326

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

327

"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.

328

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

329

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

330

"createTime": "A String", # Output only. Time when this stream was originally created.

}</pre>

</div>

<code class="details" id="updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</code>

336

<pre>Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

337

338

Args:

339

name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings" (required)

340

body: object, The request body.

341

The object takes the form of:

342

343

{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

344

"productsAndEcommerceEnabled": True or False, # Capture events when your visitors view content on your site that has product details screens, etc.

345

"fileDownloadsEnabled": True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.

346

"siteSearchEnabled": True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).

347

"excludedDomains": "A String", # Domains to exclude from measurement. Max length is 1024 characters.

348

"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

349

"articlesAndBlogsEnabled": True or False, # Capture events when your visitors view content on your site that has articles or blog posts.

350

"urlQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.

351

"formInteractionsEnabled": True or False, # If enabled, capture a view search results event each time a visitor interacts with a form on your site.

352

"contentViewsEnabled": True or False, # Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.).

353

"pageViewsEnabled": True or False, # Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.

354

"dataTaggedElementClicksEnabled": True or False, # If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with "data-ga".

355

"streamEnabled": True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.

356

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"

357

"pageLoadsEnabled": True or False, # If enabled, capture a page view event each time a page loads.

358

"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.

359

"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.

360

"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

361

"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.

362

}

363

364

updateMask: string, The list of fields to be updated. Omitted fields will not be updated.

365

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

372

373

{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

374

"productsAndEcommerceEnabled": True or False, # Capture events when your visitors view content on your site that has product details screens, etc.

375

"fileDownloadsEnabled": True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.

376

"siteSearchEnabled": True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).

377

"excludedDomains": "A String", # Domains to exclude from measurement. Max length is 1024 characters.

378

"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

379

"articlesAndBlogsEnabled": True or False, # Capture events when your visitors view content on your site that has articles or blog posts.

380

"urlQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.

381

"formInteractionsEnabled": True or False, # If enabled, capture a view search results event each time a visitor interacts with a form on your site.

382

"contentViewsEnabled": True or False, # Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.).

383

"pageViewsEnabled": True or False, # Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.

384

"dataTaggedElementClicksEnabled": True or False, # If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with "data-ga".

385

"streamEnabled": True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.

386

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"

387

"pageLoadsEnabled": True or False, # If enabled, capture a page view event each time a page loads.

388

"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.

389

"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.

390

"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

391

"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.

}</pre>

</div>

</body></html>