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

Bu Sun Kim

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

[diff] [blame]

90

<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=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-11-24 15:48:03 -0800

[diff] [blame^]

128

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

129

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

130

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

131

},

Bu Sun Kim

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

[diff] [blame]

132

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

},

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

# 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

Bu Sun Kim

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

[diff] [blame]

157

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

158

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

159

"A String",

160

],

161

},

Bu Sun Kim

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

[diff] [blame]

162

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

163

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

Bu Sun Kim

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

[diff] [blame]

164

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

Bu Sun Kim

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

[diff] [blame]

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-11-24 15:48:03 -0800

[diff] [blame^]

179

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

180

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

181

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

182

},

Bu Sun Kim

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

[diff] [blame]

183

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

},

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

# 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

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

210

"A String",

211

],

212

},

Bu Sun Kim

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

[diff] [blame]

213

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

Bu Sun Kim

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

[diff] [blame]

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-11-24 15:48:03 -0800

[diff] [blame^]

223

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

224

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

225

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

226

},

Bu Sun Kim

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

[diff] [blame]

227

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

},

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

# 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

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

254

"A String",

255

],

256

},

Bu Sun Kim

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

[diff] [blame]

257

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

Bu Sun Kim

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

[diff] [blame]

260

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

264

<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=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)

Dmitry Frenkel

3e17f89

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

[diff] [blame]

270

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

Bu Sun Kim

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

[diff] [blame]

271

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

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

Bu Sun Kim

6502091

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

[diff] [blame]

277

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

John Asmuth

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

[diff] [blame]

278

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

279

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

280

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

281

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

282

},

Bu Sun Kim

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

[diff] [blame]

283

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

},

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

# 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

Bu Sun Kim

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

[diff] [blame]

308

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

309

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

310

"A String",

311

],

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

314

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

Bu Sun Kim

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

[diff] [blame]

315

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

John Asmuth

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

[diff] [blame]

316

},

317

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

318

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

319

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

320

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

321

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

322

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

323

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

324

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

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-11-24 15:48:03 -0800

[diff] [blame^]

340

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

341

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

342

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

343

},

Bu Sun Kim

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

[diff] [blame]

344

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

},

353

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

354

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

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

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

368

# 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

Bu Sun Kim

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

[diff] [blame]

369

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

370

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

371

"A String",

372

],

373

},

Bu Sun Kim

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

[diff] [blame]

374

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

375

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

Bu Sun Kim

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

[diff] [blame]

376

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

Bu Sun Kim

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

[diff] [blame]

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-11-24 15:48:03 -0800

[diff] [blame^]

384

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

385

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

386

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

387

},

Bu Sun Kim

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

[diff] [blame]

388

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

},

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

# 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

Bu Sun Kim

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

[diff] [blame]

413

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

414

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

415

"A String",

416

],

417

},

Bu Sun Kim

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

[diff] [blame]

418

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

419

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

Bu Sun Kim

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

[diff] [blame]

420

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

Bu Sun Kim

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

[diff] [blame]

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-11-24 15:48:03 -0800

[diff] [blame^]

436

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

437

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

438

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

439

},

Bu Sun Kim

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

[diff] [blame]

440

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

},

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

# 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

Bu Sun Kim

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

[diff] [blame]

465

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

466

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

467

"A String",

468

],

469

},

Bu Sun Kim

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

[diff] [blame]

470

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

Bu Sun Kim

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

[diff] [blame]

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-11-24 15:48:03 -0800

[diff] [blame^]

480

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

481

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

482

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

483

},

Bu Sun Kim

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

[diff] [blame]

484

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

},

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

# 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

Bu Sun Kim

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

[diff] [blame]

509

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

510

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

511

"A String",

512

],

513

},

Bu Sun Kim