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

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

[diff] [blame^]

78

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

79

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

80

John Asmuth

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

[diff] [blame]

81

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

82

<p class="firstline">Gets a goal to which the user has access.</p>

83

Dan O'Meara

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

[diff] [blame]

84

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

John Asmuth

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

[diff] [blame]

85

<p class="firstline">Create a new goal.</p>

86

Dmitry Frenkel

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

[diff] [blame^]

87

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

John Asmuth

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

[diff] [blame]

88

<p class="firstline">Lists goals to which the user has access.</p>

89

Dan O'Meara

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

[diff] [blame]

90

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

Jon Wayne Parrott

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

[diff] [blame]

91

<p class="firstline">Updates an existing goal. This method supports patch semantics.</p>

John Asmuth

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

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

Jon Wayne Parrott

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

[diff] [blame]

94

<p class="firstline">Updates an existing goal.</p>

John Asmuth

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

[diff] [blame]

95

<h3>Method Details</h3>

96

Dmitry Frenkel

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

[diff] [blame^]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

John Asmuth

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

[diff] [blame]

102

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

103

<pre>Gets a goal to which the user has access.

104

105

Args:

106

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

107

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

108

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

109

goalId: string, Goal ID to retrieve the goal for. (required)

110

111

Returns:

112

An object of the form:

113

114

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

115

"eventDetails": { # Details for the goal of the type EVENT.

116

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

117

"eventConditions": [ # List of event conditions.

118

{

119

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

120

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

121

"expression": "A String", # Expression used for this match.

122

"comparisonValue": "A String", # Value used for this comparison.

123

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

128

"selfLink": "A String", # Link for this goal.

129

"accountId": "A String", # Account ID to which this goal belongs.

130

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

131

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

132

"comparisonValue": "A String", # Value used for this comparison.

133

},

134

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

135

"name": "A String", # Goal name.

136

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

137

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

138

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

139

},

140

"id": "A String", # Goal ID.

141

"active": True or False, # Determines whether this goal is active.

142

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

143

"comparisonValue": "A String", # Value used for this comparison.

144

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

145

},

146

"kind": "analytics#goal", # Resource type for an Analytics goal.

147

"updated": "A String", # Time this goal was last modified.

148

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

149

"created": "A String", # Time this goal was created.

150

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

151

"steps": [ # List of steps configured for this goal funnel.

152

{

153

"url": "A String", # URL for this step.

154

"number": 42, # Step number.

155

"name": "A String", # Step name.

156

},

157

],

158

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

159

"url": "A String", # URL for this goal.

160

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

161

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

162

},

163

"value": 3.14, # Goal value.

164

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

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, profileId, body=None)</code>

John Asmuth

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

[diff] [blame]

170

<pre>Create a new goal.

171

172

Args:

173

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

174

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

175

profileId: string, View (Profile) ID to create the goal for. (required)

Dan O'Meara

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

[diff] [blame]

176

body: object, The request body.

John Asmuth

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

[diff] [blame]

177

The object takes the form of:

178

179

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

180

"eventDetails": { # Details for the goal of the type EVENT.

181

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

182

"eventConditions": [ # List of event conditions.

183

{

184

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

185

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

186

"expression": "A String", # Expression used for this match.

187

"comparisonValue": "A String", # Value used for this comparison.

188

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

193

"selfLink": "A String", # Link for this goal.

194

"accountId": "A String", # Account ID to which this goal belongs.

195

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

196

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

197

"comparisonValue": "A String", # Value used for this comparison.

198

},

199

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

200

"name": "A String", # Goal name.

201

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

202

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

203

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

204

},

205

"id": "A String", # Goal ID.

206

"active": True or False, # Determines whether this goal is active.

207

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

208

"comparisonValue": "A String", # Value used for this comparison.

209

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

210

},

211

"kind": "analytics#goal", # Resource type for an Analytics goal.

212

"updated": "A String", # Time this goal was last modified.

213

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

214

"created": "A String", # Time this goal was created.

215

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

216

"steps": [ # List of steps configured for this goal funnel.

217

{

218

"url": "A String", # URL for this step.

219

"number": 42, # Step number.

220

"name": "A String", # Step name.

221

},

222

],

223

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

224

"url": "A String", # URL for this goal.

225

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

226

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

227

},

228

"value": 3.14, # Goal value.

229

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

230

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

235

236

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

237

"eventDetails": { # Details for the goal of the type EVENT.

238

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

239

"eventConditions": [ # List of event conditions.

240

{

241

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

242

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

243

"expression": "A String", # Expression used for this match.

244

"comparisonValue": "A String", # Value used for this comparison.

245

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

250

"selfLink": "A String", # Link for this goal.

251

"accountId": "A String", # Account ID to which this goal belongs.

252

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

253

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

254

"comparisonValue": "A String", # Value used for this comparison.

255

},

256

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

257

"name": "A String", # Goal name.

258

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

259

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

260

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

261

},

262

"id": "A String", # Goal ID.

263

"active": True or False, # Determines whether this goal is active.

264

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

265

"comparisonValue": "A String", # Value used for this comparison.

266

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

267

},

268

"kind": "analytics#goal", # Resource type for an Analytics goal.

269

"updated": "A String", # Time this goal was last modified.

270

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

271

"created": "A String", # Time this goal was created.

272

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

273

"steps": [ # List of steps configured for this goal funnel.

274

{

275

"url": "A String", # URL for this step.

276

"number": 42, # Step number.

277

"name": "A String", # Step name.

278

},

279

],

280

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

281

"url": "A String", # URL for this goal.

282

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

283

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

284

},

285

"value": 3.14, # Goal value.

286

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

287

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame^]

291

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

John Asmuth

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

[diff] [blame]

292

<pre>Lists goals to which the user has access.

293

294

Args:

Bu Sun Kim

6502091

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

[diff] [blame]

295

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

296

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

297

profileId: string, View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. (required)

Bu Sun Kim

6502091

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

[diff] [blame]

298

max_results: integer, The maximum number of goals to include in this response.

Dmitry Frenkel

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

[diff] [blame^]

299

start_index: integer, An index of the first goal 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]

300

301

Returns:

302

An object of the form:

303

304

{ # A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.

Bu Sun Kim

6502091

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

[diff] [blame]

305

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

306

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

307

"eventDetails": { # Details for the goal of the type EVENT.

308

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

309

"eventConditions": [ # List of event conditions.

310

{

311

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

312

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

313

"expression": "A String", # Expression used for this match.

314

"comparisonValue": "A String", # Value used for this comparison.

315

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

320

"selfLink": "A String", # Link for this goal.

321

"accountId": "A String", # Account ID to which this goal belongs.

322

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

323

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

324

"comparisonValue": "A String", # Value used for this comparison.

325

},

326

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

327

"name": "A String", # Goal name.

328

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

329

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

330

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

331

},

332

"id": "A String", # Goal ID.

333

"active": True or False, # Determines whether this goal is active.

334

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

335

"comparisonValue": "A String", # Value used for this comparison.

336

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

337

},

338

"kind": "analytics#goal", # Resource type for an Analytics goal.

339

"updated": "A String", # Time this goal was last modified.

340

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

341

"created": "A String", # Time this goal was created.

342

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

343

"steps": [ # List of steps configured for this goal funnel.

344

{

345

"url": "A String", # URL for this step.

346

"number": 42, # Step number.

347

"name": "A String", # Step name.

348

},

349

],

350

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

351

"url": "A String", # URL for this goal.

352

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

353

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

354

},

355

"value": 3.14, # Goal value.

356

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

John Asmuth

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

[diff] [blame]

357

},

358

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

359

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

360

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

Dmitry Frenkel

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

[diff] [blame^]

361

"nextLink": "A String", # Link to next page for this goal collection.

362

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

363

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

364

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

365

"previousLink": "A String", # Link to previous page for this goal collection.

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]

370

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

Jon Wayne Parrott

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

[diff] [blame]

371

<pre>Updates an existing goal. This method supports patch semantics.

John Asmuth

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

[diff] [blame]

372

373

Args:

374

accountId: string, Account ID to update the goal. (required)

375

webPropertyId: string, Web property ID to update the goal. (required)

376

profileId: string, View (Profile) ID to update the goal. (required)

377

goalId: string, Index of the goal to be updated. (required)

Dan O'Meara

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

[diff] [blame]

378

body: object, The request body.

John Asmuth

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

[diff] [blame]

379

The object takes the form of:

380

381

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

382

"eventDetails": { # Details for the goal of the type EVENT.

383

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

384

"eventConditions": [ # List of event conditions.

385

{

386

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

387

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

388

"expression": "A String", # Expression used for this match.

389

"comparisonValue": "A String", # Value used for this comparison.

390

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

395

"selfLink": "A String", # Link for this goal.

396

"accountId": "A String", # Account ID to which this goal belongs.

397

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

398

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

399

"comparisonValue": "A String", # Value used for this comparison.

400

},

401

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

402

"name": "A String", # Goal name.

403

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

404

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

405

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

406

},

407

"id": "A String", # Goal ID.

408

"active": True or False, # Determines whether this goal is active.

409

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

410

"comparisonValue": "A String", # Value used for this comparison.

411

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

412

},

413

"kind": "analytics#goal", # Resource type for an Analytics goal.

414

"updated": "A String", # Time this goal was last modified.

415

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

416

"created": "A String", # Time this goal was created.

417

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

418

"steps": [ # List of steps configured for this goal funnel.

419

{

420

"url": "A String", # URL for this step.

421

"number": 42, # Step number.

422

"name": "A String", # Step name.

423

},

424

],

425

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

426

"url": "A String", # URL for this goal.

427

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

428

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

429

},

430

"value": 3.14, # Goal value.

431

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

432

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

437

438

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

439

"eventDetails": { # Details for the goal of the type EVENT.

440

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

441

"eventConditions": [ # List of event conditions.

442

{

443

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

444

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

445

"expression": "A String", # Expression used for this match.

446

"comparisonValue": "A String", # Value used for this comparison.

447

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

452

"selfLink": "A String", # Link for this goal.

453

"accountId": "A String", # Account ID to which this goal belongs.

454

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

455

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

456

"comparisonValue": "A String", # Value used for this comparison.

457

},

458

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

459

"name": "A String", # Goal name.

460

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

461

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

462

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

463

},

464

"id": "A String", # Goal ID.

465

"active": True or False, # Determines whether this goal is active.

466

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

467

"comparisonValue": "A String", # Value used for this comparison.

468

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

469

},

470

"kind": "analytics#goal", # Resource type for an Analytics goal.

471

"updated": "A String", # Time this goal was last modified.

472

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

473

"created": "A String", # Time this goal was created.

474

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

475

"steps": [ # List of steps configured for this goal funnel.

476

{

477

"url": "A String", # URL for this step.

478

"number": 42, # Step number.

479

"name": "A String", # Step name.

480

},

481

],

482

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

483

"url": "A String", # URL for this goal.

484

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

485

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

486

},

487

"value": 3.14, # Goal value.

488

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

489

}</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]

493

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

Jon Wayne Parrott

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

[diff] [blame]

494

<pre>Updates an existing goal.

John Asmuth

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

[diff] [blame]

495

496

Args:

497

accountId: string, Account ID to update the goal. (required)

498

webPropertyId: string, Web property ID to update the goal. (required)

499

profileId: string, View (Profile) ID to update the goal. (required)

500

goalId: string, Index of the goal to be updated. (required)

Dan O'Meara

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

[diff] [blame]

501

body: object, The request body.

John Asmuth

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

[diff] [blame]

502

The object takes the form of:

503

504

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

505

"eventDetails": { # Details for the goal of the type EVENT.

506

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

507

"eventConditions": [ # List of event conditions.

508

{

509

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

510

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

511

"expression": "A String", # Expression used for this match.

512

"comparisonValue": "A String", # Value used for this comparison.

513

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

518

"selfLink": "A String", # Link for this goal.

519

"accountId": "A String", # Account ID to which this goal belongs.

520

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

521

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

522

"comparisonValue": "A String", # Value used for this comparison.

523

},

524

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

525

"name": "A String", # Goal name.

526

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

527

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

528

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

529

},

530

"id": "A String", # Goal ID.

531

"active": True or False, # Determines whether this goal is active.

532

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

533

"comparisonValue": "A String", # Value used for this comparison.

534

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

535

},

536

"kind": "analytics#goal", # Resource type for an Analytics goal.

537

"updated": "A String", # Time this goal was last modified.

538

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

539

"created": "A String", # Time this goal was created.

540

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

541

"steps": [ # List of steps configured for this goal funnel.

542

{

543

"url": "A String", # URL for this step.

544

"number": 42, # Step number.

545

"name": "A String", # Step name.

546

},

547

],

548

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

549

"url": "A String", # URL for this goal.

550

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

551

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

552

},

553

"value": 3.14, # Goal value.

554

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

555

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

560

561

{ # JSON template for Analytics goal resource.

Dmitry Frenkel

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

[diff] [blame^]

562

"eventDetails": { # Details for the goal of the type EVENT.

563

"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.

564

"eventConditions": [ # List of event conditions.

565

{

566

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

567

"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

568

"expression": "A String", # Expression used for this match.

569

"comparisonValue": "A String", # Value used for this comparison.

570

"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

},

],

},

"profileId": "A String", # View (Profile) ID to which this goal belongs.

575

"selfLink": "A String", # Link for this goal.

576

"accountId": "A String", # Account ID to which this goal belongs.

577

"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.

578

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

579

"comparisonValue": "A String", # Value used for this comparison.

580

},

581

"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

582

"name": "A String", # Goal name.

583

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

584

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

585

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

586

},

587

"id": "A String", # Goal ID.

588

"active": True or False, # Determines whether this goal is active.

589

"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.

590

"comparisonValue": "A String", # Value used for this comparison.

591

"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

592

},

593

"kind": "analytics#goal", # Resource type for an Analytics goal.

594

"updated": "A String", # Time this goal was last modified.

595

"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

596

"created": "A String", # Time this goal was created.

597

"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.

598

"steps": [ # List of steps configured for this goal funnel.

599

{

600

"url": "A String", # URL for this step.

601

"number": 42, # Step number.

602

"name": "A String", # Step name.

603

},

604

],

605

"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.

606

"url": "A String", # URL for this goal.

607

"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

608

"firstStepRequired": True or False, # Determines if the first step in this goal is required.

609

},

610

"value": 3.14, # Goal value.

611

"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.

612

}</pre>

John Asmuth