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

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

Yoshi Automation Bot

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

[diff] [blame]

87

<code><a href="#list">list(accountId, webPropertyId, profileId, start_index=None, max_results=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

3e17f89

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.

Yoshi Automation Bot

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

[diff] [blame]

115

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

116

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

117

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

118

},

119

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

120

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

121

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

122

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

123

{

124

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

125

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

126

"number": 42, # Step number.

127

},

128

],

129

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

130

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

131

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

132

},

133

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

134

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

135

"eventConditions": [ # List of event conditions.

136

{

137

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

138

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

139

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

140

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

141

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

142

},

143

],

144

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

145

},

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

},

159

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

160

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

161

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

162

},

163

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

164

"value": 3.14, # Goal value.

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.

Yoshi Automation Bot

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

[diff] [blame]

180

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

181

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

182

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

183

},

184

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

185

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

186

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

187

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

188

{

189

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

190

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

191

"number": 42, # Step number.

192

},

193

],

194

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

195

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

196

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

197

},

198

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

199

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

200

"eventConditions": [ # List of event conditions.

201

{

202

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

203

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

204

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

205

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

206

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

207

},

208

],

209

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

210

},

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

},

224

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

225

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

226

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

227

},

228

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

229

"value": 3.14, # Goal value.

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.

Yoshi Automation Bot

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

[diff] [blame]

237

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

238

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

239

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

240

},

241

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

242

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

243

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

244

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

245

{

246

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

247

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

248

"number": 42, # Step number.

249

},

250

],

251

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

252

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

253

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

254

},

255

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

256

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

257

"eventConditions": [ # List of event conditions.

258

{

259

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

260

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

261

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

262

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

263

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

264

},

265

],

266

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

267

},

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

},

281

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

282

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

283

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

284

},

285

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

286

"value": 3.14, # Goal value.

287

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

291

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

298

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

Yoshi Automation Bot

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

[diff] [blame]

299

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

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.

Yoshi Automation Bot

c2228be

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

[diff] [blame]

305

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

Bu Sun Kim

6502091

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

[diff] [blame]

306

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

307

{ # JSON template for Analytics goal resource.

Yoshi Automation Bot

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

[diff] [blame]

308

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

309

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

310

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

311

},

312

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

313

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

314

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

315

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

316

{

317

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

318

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

319

"number": 42, # Step number.

320

},

321

],

322

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

323

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

324

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

325

},

326

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

327

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

328

"eventConditions": [ # List of event conditions.

329

{

330

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

331

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

332

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

333

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

334

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

335

},

336

],

337

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

338

},

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

},

352

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

353

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

354

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

355

},

356

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

357

"value": 3.14, # Goal value.

Bu Sun Kim

673ec5c

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

[diff] [blame]

358

},

John Asmuth

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

[diff] [blame]

359

],

Yoshi Automation Bot

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

[diff] [blame]

360

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

361

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

362

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

363

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

364

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

365

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

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.

Yoshi Automation Bot

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

[diff] [blame]

382

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

383

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

384

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

385

},

386

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

387

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

388

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

389

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

390

{

391

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

392

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

393

"number": 42, # Step number.

394

},

395

],

396

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

397

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

398

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

399

},

400

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

401

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

402

"eventConditions": [ # List of event conditions.

403

{

404

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

405

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

406

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

407

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

408

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

409

},

410

],

411

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

412

},

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

},

426

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

427

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

428

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

429

},

430

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

431

"value": 3.14, # Goal value.

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.

Yoshi Automation Bot

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

[diff] [blame]

439

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

440

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

441

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

442

},

443

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

444

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

445

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

446

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

447

{

448

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

449

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

450

"number": 42, # Step number.

451

},

452

],

453

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

454

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

455

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

456

},

457

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

458

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

459

"eventConditions": [ # List of event conditions.

460

{

461

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

462

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

463

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

464

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

465

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

466

},

467

],

468

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

469

},

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

},

483

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

484

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

485

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

486

},

487

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

488

"value": 3.14, # Goal value.

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.

Yoshi Automation Bot

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

[diff] [blame]

505

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

506

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

507

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

508

},

509

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

510

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

511

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

512

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

513

{

514

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

515

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

516

"number": 42, # Step number.

517

},

518

],

519

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

520

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

521

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

522

},

523

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

524

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

525

"eventConditions": [ # List of event conditions.

526

{

527

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

528

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

529

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

530

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

531

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

532

},

533

],

534

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

535

},

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

},

549

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

550

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

551

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

552

},

553

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

554

"value": 3.14, # Goal value.

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.

Yoshi Automation Bot

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

[diff] [blame]

562

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

563

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

564

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

565

},

566

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

567

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

568

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

569

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

570

{

571

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

572

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

573

"number": 42, # Step number.

574

},

575

],

576

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

577

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

578

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

579

},

580

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

581

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

582

"eventConditions": [ # List of event conditions.

583

{

584

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

585

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

586

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

587

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

588

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

589

},

590

],

591

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

592

},

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

},

606

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

607

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

608

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

609

},

610

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

611

"value": 3.14, # Goal value.

612

}</pre>

John Asmuth