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.

Bu Sun Kim

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

[diff] [blame]

115

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

Yoshi Automation Bot

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

[diff] [blame^]

116

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

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

119

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

120

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

121

},

Yoshi Automation Bot

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

[diff] [blame^]

122

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

123

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

124

{

125

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

126

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

127

"number": 42, # Step number.

128

},

129

],

130

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

131

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

132

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

133

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

Bu Sun Kim

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

[diff] [blame]

134

},

Yoshi Automation Bot

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

[diff] [blame^]

135

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

136

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

137

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

138

"eventConditions": [ # List of event conditions.

139

{

140

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

141

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

142

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

143

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

144

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

149

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

Yoshi Automation Bot

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

[diff] [blame^]

150

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

151

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

152

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

153

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

154

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

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

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

158

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

159

},

160

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

161

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

162

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

163

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

Bu Sun Kim

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

[diff] [blame]

164

},

Bu Sun Kim

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

[diff] [blame]

165

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

169

<code class="details" id="insert">insert(accountId, webPropertyId, 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.

Bu Sun Kim

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

[diff] [blame]

180

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

Yoshi Automation Bot

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

[diff] [blame^]

181

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

182

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

Bu Sun Kim

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

[diff] [blame]

183

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

184

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

185

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

186

},

Yoshi Automation Bot

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

[diff] [blame^]

187

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

188

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

189

{

190

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

191

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

192

"number": 42, # Step number.

193

},

194

],

195

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

196

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

197

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

198

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

Bu Sun Kim

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

[diff] [blame]

199

},

Yoshi Automation Bot

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

[diff] [blame^]

200

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

201

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

202

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

203

"eventConditions": [ # List of event conditions.

204

{

205

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

206

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

207

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

208

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

209

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

214

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

Yoshi Automation Bot

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

[diff] [blame^]

215

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

216

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

217

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

218

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

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

223

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

224

},

225

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

226

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

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

},

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

237

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

Yoshi Automation Bot

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

[diff] [blame^]

238

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

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

241

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

242

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

243

},

Yoshi Automation Bot

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

[diff] [blame^]

244

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

245

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

246

{

247

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

248

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

249

"number": 42, # Step number.

250

},

251

],

252

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

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

},

Yoshi Automation Bot

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

[diff] [blame^]

257

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

258

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

259

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

260

"eventConditions": [ # List of event conditions.

261

{

262

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

263

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

264

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

265

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

266

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

271

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

Yoshi Automation Bot

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

[diff] [blame^]

272

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

273

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

274

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

275

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

276

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

277

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

Bu Sun Kim

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

[diff] [blame]

278

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

279

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

280

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

281

},

282

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

283

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

284

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

285

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

Bu Sun Kim

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

[diff] [blame]

286

},

Bu Sun Kim

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

[diff] [blame]

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.

Yoshi Automation Bot

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

[diff] [blame^]

305

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

306

"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-11-16 11:05:03 -0700

[diff] [blame]

307

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

308

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

Yoshi Automation Bot

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

[diff] [blame^]

309

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

310

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

311

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

Bu Sun Kim

6502091

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

[diff] [blame]

312

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

313

{ # JSON template for Analytics goal resource.

Bu Sun Kim

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

[diff] [blame]

314

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

Yoshi Automation Bot

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

[diff] [blame^]

315

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

316

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

Bu Sun Kim

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

[diff] [blame]

317

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

318

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

319

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

320

},

Yoshi Automation Bot

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

[diff] [blame^]

321

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

322

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

323

{

324

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

325

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

326

"number": 42, # Step number.

327

},

328

],

329

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

330

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

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

},

Yoshi Automation Bot

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

[diff] [blame^]

334

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

335

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

336

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

337

"eventConditions": [ # List of event conditions.

338

{

339

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

340

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

341

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

342

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

343

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

348

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

Yoshi Automation Bot

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

[diff] [blame^]

349

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

350

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

351

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

352

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

353

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

354

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

Bu Sun Kim

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

[diff] [blame]

355

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

356

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

357

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

358

},

359

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

360

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

361

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

362

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

Bu Sun Kim

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

[diff] [blame]

363

},

Bu Sun Kim

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

[diff] [blame]

364

},

John Asmuth

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

[diff] [blame]

365

],

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.

Bu Sun Kim

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

[diff] [blame]

382

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

Yoshi Automation Bot

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

[diff] [blame^]

383

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

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

386

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

387

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

388

},

Yoshi Automation Bot

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

[diff] [blame^]

389

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

390

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

391

{

392

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

393

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

394

"number": 42, # Step number.

395

},

396

],

397

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

398

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

399

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

400

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

Bu Sun Kim

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

[diff] [blame]

401

},

Yoshi Automation Bot

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

[diff] [blame^]

402

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

403

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

404

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

405

"eventConditions": [ # List of event conditions.

406

{

407

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

408

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

409

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

410

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

411

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

416

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

Yoshi Automation Bot

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

[diff] [blame^]

417

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

418

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

419

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

420

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

421

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

422

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

Bu Sun Kim

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

[diff] [blame]

423

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

424

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

425

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

426

},

427

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

428

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

429

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

430

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

Bu Sun Kim

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

[diff] [blame]

431

},

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

439

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

Yoshi Automation Bot

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

[diff] [blame^]

440

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

441

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

Bu Sun Kim

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

[diff] [blame]

442

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

443

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

444

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

445

},

Yoshi Automation Bot

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

[diff] [blame^]

446

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

447

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

448

{

449

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

450

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

451

"number": 42, # Step number.

452

},

453

],

454

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

455

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

456

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

457

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

Bu Sun Kim

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

[diff] [blame]

458

},

Yoshi Automation Bot

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

[diff] [blame^]

459

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

460

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

461

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

462

"eventConditions": [ # List of event conditions.

463

{

464

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

465

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

466

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

467

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

468

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

473

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

Yoshi Automation Bot

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

[diff] [blame^]

474

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

475

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

476

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

477

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

478

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

479

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

Bu Sun Kim

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

[diff] [blame]

480

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

481

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

482

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

483

},

484

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

485

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

486

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

487

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

Bu Sun Kim

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

[diff] [blame]

488

},

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

505

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

Yoshi Automation Bot

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

[diff] [blame^]

506

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

507

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

Bu Sun Kim

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

[diff] [blame]

508

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

509

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

510

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

511

},

Yoshi Automation Bot

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

[diff] [blame^]

512

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

513

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

514

{

515

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

516

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

517

"number": 42, # Step number.

518

},

519

],

520

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

521

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

522

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

523

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

Bu Sun Kim

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

[diff] [blame]

524

},

Yoshi Automation Bot

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

[diff] [blame^]

525

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

526

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

527

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

528

"eventConditions": [ # List of event conditions.

529

{

530

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

531

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

532

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

533

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

534

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

539

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

Yoshi Automation Bot

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

[diff] [blame^]

540

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

541

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

542

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

543

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

544

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

545

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

Bu Sun Kim

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

[diff] [blame]

546

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

547

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

548

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

549

},

550

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

551

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

552

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

553

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

Bu Sun Kim

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

[diff] [blame]

554

},

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

562

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

Yoshi Automation Bot

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

[diff] [blame^]

563

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

564

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

Bu Sun Kim

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

[diff] [blame]

565

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

566

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

567

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

568

},

Yoshi Automation Bot

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

[diff] [blame^]

569

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

570

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

571

{

572

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

573

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

574

"number": 42, # Step number.

575

},

576

],

577

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

578

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

579

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

580

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

Bu Sun Kim

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

[diff] [blame]

581

},

Yoshi Automation Bot

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

[diff] [blame^]

582

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

583

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

584

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

585

"eventConditions": [ # List of event conditions.

586

{

587

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

588

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

589

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

590

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

591

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

596

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

Yoshi Automation Bot

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

[diff] [blame^]

597

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

598

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

599

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

600

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

601

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

602

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

Bu Sun Kim

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

[diff] [blame]

603

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

604

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

605

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

606

},

607

"value": 3.14, # Goal value.

Yoshi Automation Bot

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

[diff] [blame^]

608

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

609

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

610

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

Bu Sun Kim

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

[diff] [blame]

611

},

Bu Sun Kim

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

[diff] [blame]

612

}</pre>

John Asmuth