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

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

[diff] [blame]

81

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

John Asmuth

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

[diff] [blame]

82

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

83

Bu Sun Kim

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

[diff] [blame]

84

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

85

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

86

Dan O'Meara

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

[diff] [blame]

87

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

88

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

John Asmuth

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

[diff] [blame]

89

Dan O'Meara

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

[diff] [blame]

90

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

91

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

John Asmuth

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

[diff] [blame]

92

<h3>Method Details</h3>

93

94

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

95

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

96

97

Args:

98

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

99

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

100

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

101

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

102

103

Returns:

104

An object of the form:

105

106

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

107

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

108

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

109

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

110

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

111

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

112

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

113

},

114

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

115

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

116

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

117

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

118

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

119

"value": 3.14, # Goal value.

120

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

121

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

122

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

123

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

124

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

125

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

126

},

127

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

128

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

129

{

130

"number": 42, # Step number.

131

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

132

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

133

},

134

],

135

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

136

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

137

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

138

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

139

},

140

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

141

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

142

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

143

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

144

},

145

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

146

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

147

"eventConditions": [ # List of event conditions.

148

{

149

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

150

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

151

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

152

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

153

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

},

],

},

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

161

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

John Asmuth

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

[diff] [blame]

162

<pre>Create a new goal.

163

164

Args:

165

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

166

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

167

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

Dan O'Meara

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

[diff] [blame]

168

body: object, The request body.

John Asmuth

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

[diff] [blame]

169

The object takes the form of:

170

171

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

172

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

173

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

174

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

175

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

176

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

177

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

178

},

179

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

180

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

181

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

182

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

183

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

184

"value": 3.14, # Goal value.

185

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

186

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

187

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

188

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

189

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

190

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

191

},

192

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

193

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

194

{

195

"number": 42, # Step number.

196

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

197

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

198

},

199

],

200

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

201

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

202

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

203

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

204

},

205

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

206

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

207

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

208

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

209

},

210

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

211

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

212

"eventConditions": [ # List of event conditions.

213

{

214

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

215

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

216

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

217

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

218

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

},

],

},

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

227

228

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

229

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

230

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

231

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

232

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

233

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

234

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

235

},

236

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

237

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

238

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

239

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

240

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

241

"value": 3.14, # Goal value.

242

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

243

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

244

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

245

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

246

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

247

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

248

},

249

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

250

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

251

{

252

"number": 42, # Step number.

253

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

254

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

255

},

256

],

257

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

258

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

259

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

260

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

261

},

262

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

263

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

264

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

265

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

266

},

267

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

268

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

269

"eventConditions": [ # List of event conditions.

270

{

271

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

272

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

273

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

274

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

275

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

},

],

},

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

283

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

284

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

285

286

Args:

Bu Sun Kim

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

[diff] [blame]

287

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)

288

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)

289

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)

John Asmuth

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

[diff] [blame]

290

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

Bu Sun Kim

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

[diff] [blame]

291

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

John Asmuth

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

[diff] [blame]

292

293

Returns:

294

An object of the form:

295

296

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

2020-07-22 17:02:09 -0700

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

300

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

Bu Sun Kim

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

[diff] [blame]

301

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

302

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

303

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

304

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

305

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

306

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

307

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

308

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

John Asmuth

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

[diff] [blame]

309

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

310

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

311

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

312

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

313

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

314

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

315

"value": 3.14, # Goal value.

316

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

317

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

318

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

319

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

320

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

321

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

322

},

323

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

324

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

325

{

326

"number": 42, # Step number.

327

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

328

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

329

},

330

],

331

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

332

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

333

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

334

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

335

},

336

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

337

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

338

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

339

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

340

},

341

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

342

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

343

"eventConditions": [ # List of event conditions.

344

{

345

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

346

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

347

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

348

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

349

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

},

],

},

},

John Asmuth

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

[diff] [blame]

354

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

355

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

356

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

357

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

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]

362

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

363

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

John Asmuth

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

[diff] [blame]

364

365

Args:

366

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

367

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

368

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

369

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

Dan O'Meara

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

[diff] [blame]

370

body: object, The request body.

John Asmuth

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

[diff] [blame]

371

The object takes the form of:

372

373

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

374

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

375

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

376

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

377

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

378

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

379

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

380

},

381

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

382

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

383

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

384

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

385

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

386

"value": 3.14, # Goal value.

387

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

388

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

389

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

390

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

391

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

392

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

393

},

394

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

395

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

396

{

397

"number": 42, # Step number.

398

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

399

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

400

},

401

],

402

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

403

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

404

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

405

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

406

},

407

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

408

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

409

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

410

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

411

},

412

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

413

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

414

"eventConditions": [ # List of event conditions.

415

{

416

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

417

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

418

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

419

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

420

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

},

],

},

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

429

430

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

431

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

432

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

433

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

434

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

435

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

436

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

437

},

438

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

439

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

440

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

441

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

442

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

443

"value": 3.14, # Goal value.

444

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

445

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

446

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

447

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

448

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

449

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

450

},

451

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

452

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

453

{

454

"number": 42, # Step number.

455

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

456

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

457

},

458

],

459

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

460

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

461

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

462

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

463

},

464

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

465

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

466

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

467

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

468

},

469

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

470

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

471

"eventConditions": [ # List of event conditions.

472

{

473

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

474

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

475

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

476

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

477

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

},

],

},

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

485

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

486

<pre>Updates an existing goal.

John Asmuth

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

[diff] [blame]

487

488

Args:

489

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

490

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

491

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

492

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

Dan O'Meara

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

[diff] [blame]

493

body: object, The request body.

John Asmuth

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

[diff] [blame]

494

The object takes the form of:

495

496

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

497

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

498

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

499

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

500

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

501

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

502

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

503

},

504

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

505

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

506

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

507

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

508

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

509

"value": 3.14, # Goal value.

510

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

511

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

512

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

513

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

514

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

515

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

516

},

517

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

518

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

519

{

520

"number": 42, # Step number.

521

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

522

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

523

},

524

],

525

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

526

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

527

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

528

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

529

},

530

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

531

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

532

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

533

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

534

},

535

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

536

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

537

"eventConditions": [ # List of event conditions.

538

{

539

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

540

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

541

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

542

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

543

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

},

],

},

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

552

553

{ # JSON template for Analytics goal resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

554

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

555

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

556

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

557

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

558

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

559

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

560

},

561

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

562

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

563

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

564

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

565

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

566

"value": 3.14, # Goal value.

567

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

568

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

569

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

570

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

571

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

572

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

573

},

574

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

575

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

576

{

577

"number": 42, # Step number.

578

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

579

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

580

},

581

],

582

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

583

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

584

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

585

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

586

},

587

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

588

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

589

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

590

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

591

},

592

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

593

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

594

"eventConditions": [ # List of event conditions.

595

{

596

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

597

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

598

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

599

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

600

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

},

],

},

}</pre>

John Asmuth