Blame - docs/dyn/analytics_v3.management.profiles.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

81

<code><a href="#delete">delete(accountId, webPropertyId, profileId)</a></code></p>

82

<p class="firstline">Deletes a view (profile).</p>

83

84

<code><a href="#get">get(accountId, webPropertyId, profileId)</a></code></p>

85

<p class="firstline">Gets a view (profile) to which the user has access.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<p class="firstline">Create a new view (profile).</p>

89

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

90

<code><a href="#list">list(accountId, webPropertyId, start_index=None, max_results=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

91

<p class="firstline">Lists views (profiles) to which the user has access.</p>

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#patch">patch(accountId, webPropertyId, profileId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

94

<p class="firstline">Updates an existing view (profile). This method supports patch semantics.</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#update">update(accountId, webPropertyId, profileId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

97

<p class="firstline">Updates an existing view (profile).</p>

98

<h3>Method Details</h3>

99

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

105

<code class="details" id="delete">delete(accountId, webPropertyId, profileId)</code>

106

<pre>Deletes a view (profile).

107

108

Args:

109

accountId: string, Account ID to delete the view (profile) for. (required)

110

webPropertyId: string, Web property ID to delete the view (profile) for. (required)

111

profileId: string, ID of the view (profile) to be deleted. (required)

</pre>

</div>

<code class="details" id="get">get(accountId, webPropertyId, profileId)</code>

117

<pre>Gets a view (profile) to which the user has access.

118

119

Args:

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

120

accountId: string, Account ID to retrieve the view (profile) for. (required)

121

webPropertyId: string, Web property ID to retrieve the view (profile) for. (required)

122

profileId: string, View (Profile) ID to retrieve the view (profile) for. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

123

124

Returns:

125

An object of the form:

126

127

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

128

"id": "A String", # View (Profile) ID.

129

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

130

"type": "analytics#webproperty", # Value is "analytics#webproperty".

131

"href": "A String", # Link to the web property to which this view (profile) belongs.

132

},

133

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

134

"defaultPage": "A String", # Default page for this view (profile).

135

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

136

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

137

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

138

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

139

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

140

"type": "analytics#goals", # Value is "analytics#goals".

141

"href": "A String", # Link to the list of goals for this view (profile).

142

},

143

"starred": True or False, # Indicates whether this view (profile) is starred or not.

144

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

145

"name": "A String", # Name of this view (profile).

146

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

147

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

148

"websiteUrl": "A String", # Website URL for this view (profile).

149

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

150

"updated": "A String", # Time this view (profile) was last modified.

151

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

152

"permissions": { # Permissions the user has for this view (profile).

153

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

158

"created": "A String", # Time this view (profile) was created.

159

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

160

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

161

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

162

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

163

"selfLink": "A String", # Link for this view (profile).

164

"kind": "analytics#profile", # Resource type for Analytics view (profile).

165

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

169

<code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

170

<pre>Create a new view (profile).

171

172

Args:

173

accountId: string, Account ID to create the view (profile) for. (required)

174

webPropertyId: string, Web property ID to create the view (profile) for. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

175

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

176

The object takes the form of:

177

178

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

179

"id": "A String", # View (Profile) ID.

180

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

181

"type": "analytics#webproperty", # Value is "analytics#webproperty".

182

"href": "A String", # Link to the web property to which this view (profile) belongs.

183

},

184

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

185

"defaultPage": "A String", # Default page for this view (profile).

186

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

187

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

188

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

189

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

190

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

191

"type": "analytics#goals", # Value is "analytics#goals".

192

"href": "A String", # Link to the list of goals for this view (profile).

193

},

194

"starred": True or False, # Indicates whether this view (profile) is starred or not.

195

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

196

"name": "A String", # Name of this view (profile).

197

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

198

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

199

"websiteUrl": "A String", # Website URL for this view (profile).

200

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

201

"updated": "A String", # Time this view (profile) was last modified.

202

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

203

"permissions": { # Permissions the user has for this view (profile).

204

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

209

"created": "A String", # Time this view (profile) was created.

210

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

211

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

212

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

213

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

214

"selfLink": "A String", # Link for this view (profile).

215

"kind": "analytics#profile", # Resource type for Analytics view (profile).

216

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

221

222

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

223

"id": "A String", # View (Profile) ID.

224

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

225

"type": "analytics#webproperty", # Value is "analytics#webproperty".

226

"href": "A String", # Link to the web property to which this view (profile) belongs.

227

},

228

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

229

"defaultPage": "A String", # Default page for this view (profile).

230

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

231

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

232

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

233

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

234

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

235

"type": "analytics#goals", # Value is "analytics#goals".

236

"href": "A String", # Link to the list of goals for this view (profile).

237

},

238

"starred": True or False, # Indicates whether this view (profile) is starred or not.

239

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

240

"name": "A String", # Name of this view (profile).

241

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

242

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

243

"websiteUrl": "A String", # Website URL for this view (profile).

244

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

245

"updated": "A String", # Time this view (profile) was last modified.

246

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

247

"permissions": { # Permissions the user has for this view (profile).

248

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

253

"created": "A String", # Time this view (profile) was created.

254

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

255

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

256

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

257

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

258

"selfLink": "A String", # Link for this view (profile).

259

"kind": "analytics#profile", # Resource type for Analytics view (profile).

260

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

264

<code class="details" id="list">list(accountId, webPropertyId, start_index=None, max_results=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

265

<pre>Lists views (profiles) to which the user has access.

266

267

Args:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

268

accountId: string, Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)

269

webPropertyId: string, Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

270

start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

271

max_results: integer, The maximum number of views (profiles) to include in this response.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

272

273

Returns:

274

An object of the form:

275

276

{ # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

277

"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

278

"items": [ # A list of views (profiles).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

279

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

280

"id": "A String", # View (Profile) ID.

281

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

282

"type": "analytics#webproperty", # Value is "analytics#webproperty".

283

"href": "A String", # Link to the web property to which this view (profile) belongs.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

284

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

285

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

286

"defaultPage": "A String", # Default page for this view (profile).

287

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

288

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

289

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

290

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

291

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

292

"type": "analytics#goals", # Value is "analytics#goals".

293

"href": "A String", # Link to the list of goals for this view (profile).

294

},

295

"starred": True or False, # Indicates whether this view (profile) is starred or not.

296

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

297

"name": "A String", # Name of this view (profile).

298

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

299

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

300

"websiteUrl": "A String", # Website URL for this view (profile).

301

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

302

"updated": "A String", # Time this view (profile) was last modified.

303

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

304

"permissions": { # Permissions the user has for this view (profile).

305

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

310

"created": "A String", # Time this view (profile) was created.

311

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

312

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

313

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

314

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

315

"selfLink": "A String", # Link for this view (profile).

316

"kind": "analytics#profile", # Resource type for Analytics view (profile).

317

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

318

],

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

319

"kind": "analytics#profiles", # Collection type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

320

"nextLink": "A String", # Link to next page for this view (profile) collection.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

321

"username": "A String", # Email ID of the authenticated user

322

"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

323

"previousLink": "A String", # Link to previous page for this view (profile) collection.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

324

"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

329

<code class="details" id="patch">patch(accountId, webPropertyId, profileId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

330

<pre>Updates an existing view (profile). This method supports patch semantics.

331

332

Args:

333

accountId: string, Account ID to which the view (profile) belongs (required)

334

webPropertyId: string, Web property ID to which the view (profile) belongs (required)

335

profileId: string, ID of the view (profile) to be updated. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

336

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

337

The object takes the form of:

338

339

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

340

"id": "A String", # View (Profile) ID.

341

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

342

"type": "analytics#webproperty", # Value is "analytics#webproperty".

343

"href": "A String", # Link to the web property to which this view (profile) belongs.

344

},

345

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

346

"defaultPage": "A String", # Default page for this view (profile).

347

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

348

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

349

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

350

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

351

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

352

"type": "analytics#goals", # Value is "analytics#goals".

353

"href": "A String", # Link to the list of goals for this view (profile).

354

},

355

"starred": True or False, # Indicates whether this view (profile) is starred or not.

356

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

357

"name": "A String", # Name of this view (profile).

358

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

359

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

360

"websiteUrl": "A String", # Website URL for this view (profile).

361

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

362

"updated": "A String", # Time this view (profile) was last modified.

363

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

364

"permissions": { # Permissions the user has for this view (profile).

365

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

370

"created": "A String", # Time this view (profile) was created.

371

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

372

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

373

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

374

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

375

"selfLink": "A String", # Link for this view (profile).

376

"kind": "analytics#profile", # Resource type for Analytics view (profile).

377

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

382

383

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

384

"id": "A String", # View (Profile) ID.

385

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

386

"type": "analytics#webproperty", # Value is "analytics#webproperty".

387

"href": "A String", # Link to the web property to which this view (profile) belongs.

388

},

389

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

390

"defaultPage": "A String", # Default page for this view (profile).

391

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

392

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

393

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

394

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

395

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

396

"type": "analytics#goals", # Value is "analytics#goals".

397

"href": "A String", # Link to the list of goals for this view (profile).

398

},

399

"starred": True or False, # Indicates whether this view (profile) is starred or not.

400

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

401

"name": "A String", # Name of this view (profile).

402

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

403

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

404

"websiteUrl": "A String", # Website URL for this view (profile).

405

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

406

"updated": "A String", # Time this view (profile) was last modified.

407

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

408

"permissions": { # Permissions the user has for this view (profile).

409

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

414

"created": "A String", # Time this view (profile) was created.

415

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

416

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

417

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

418

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

419

"selfLink": "A String", # Link for this view (profile).

420

"kind": "analytics#profile", # Resource type for Analytics view (profile).

421

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

425

<code class="details" id="update">update(accountId, webPropertyId, profileId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

426

<pre>Updates an existing view (profile).

427

428

Args:

429

accountId: string, Account ID to which the view (profile) belongs (required)

430

webPropertyId: string, Web property ID to which the view (profile) belongs (required)

431

profileId: string, ID of the view (profile) to be updated. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

432

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

433

The object takes the form of:

434

435

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

436

"id": "A String", # View (Profile) ID.

437

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

438

"type": "analytics#webproperty", # Value is "analytics#webproperty".

439

"href": "A String", # Link to the web property to which this view (profile) belongs.

440

},

441

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

442

"defaultPage": "A String", # Default page for this view (profile).

443

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

444

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

445

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

446

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

447

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

448

"type": "analytics#goals", # Value is "analytics#goals".

449

"href": "A String", # Link to the list of goals for this view (profile).

450

},

451

"starred": True or False, # Indicates whether this view (profile) is starred or not.

452

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

453

"name": "A String", # Name of this view (profile).

454

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

455

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

456

"websiteUrl": "A String", # Website URL for this view (profile).

457

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

458

"updated": "A String", # Time this view (profile) was last modified.

459

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

460

"permissions": { # Permissions the user has for this view (profile).

461

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

466

"created": "A String", # Time this view (profile) was created.

467

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

468

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

469

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

470

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

471

"selfLink": "A String", # Link for this view (profile).

472

"kind": "analytics#profile", # Resource type for Analytics view (profile).

473

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

478

479

{ # JSON template for an Analytics view (profile).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

480

"id": "A String", # View (Profile) ID.

481

"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

482

"type": "analytics#webproperty", # Value is "analytics#webproperty".

483

"href": "A String", # Link to the web property to which this view (profile) belongs.

484

},

485

"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).

486

"defaultPage": "A String", # Default page for this view (profile).

487

"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.

488

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

489

"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:

490

# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

491

"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).

492

"type": "analytics#goals", # Value is "analytics#goals".

493

"href": "A String", # Link to the list of goals for this view (profile).

494

},

495

"starred": True or False, # Indicates whether this view (profile) is starred or not.

496

"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).

497

"name": "A String", # Name of this view (profile).

498

"type": "A String", # View (Profile) type. Supported types: WEB or APP.

499

"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.

500

"websiteUrl": "A String", # Website URL for this view (profile).

501

"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).

502

"updated": "A String", # Time this view (profile) was last modified.

503

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

504

"permissions": { # Permissions the user has for this view (profile).

505

"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

"A String",

],

},

"accountId": "A String", # Account ID to which this view (profile) belongs.

510

"created": "A String", # Time this view (profile) was created.

511

"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).

512

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

513

"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).

514

"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

515

"selfLink": "A String", # Link for this view (profile).

516

"kind": "analytics#profile", # Resource type for Analytics view (profile).

517

}</pre>

John Asmuth