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-12-09 08:56:03 -0800

[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

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-26 17:16:03 -0800

[diff] [blame]

115

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

116

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

117

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

Yoshi Automation Bot

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

[diff] [blame]

118

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

119

"eventConditions": [ # List of event conditions.

120

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

121

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

Yoshi Automation Bot

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

[diff] [blame]

122

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

123

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

124

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

125

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

Yoshi Automation Bot

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

[diff] [blame]

126

},

127

],

128

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

129

},

Yoshi Automation Bot

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

[diff] [blame]

130

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

Yoshi Automation Bot

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

[diff] [blame]

131

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

132

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

Yoshi Automation Bot

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

[diff] [blame]

133

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

134

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

135

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

136

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

137

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

138

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

139

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

140

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

141

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

142

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

143

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

144

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

145

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

146

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

147

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

148

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

149

},

150

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

151

"value": 3.14, # Goal value.

152

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

153

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

154

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

155

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

156

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

157

{

158

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

159

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

160

"number": 42, # Step number.

161

},

162

],

163

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

164

},

Yoshi Automation Bot

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

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

180

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

181

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

182

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

Yoshi Automation Bot

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

[diff] [blame]

183

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

184

"eventConditions": [ # List of event conditions.

185

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

186

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

Yoshi Automation Bot

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

[diff] [blame]

187

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

188

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

189

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

190

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

Yoshi Automation Bot

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

[diff] [blame]

191

},

192

],

193

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

194

},

Yoshi Automation Bot

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

[diff] [blame]

195

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

Yoshi Automation Bot

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

[diff] [blame]

196

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

197

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

Yoshi Automation Bot

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

[diff] [blame]

198

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

199

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

200

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

201

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

202

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

203

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

204

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

205

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

206

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

207

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

208

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

209

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

210

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

211

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

212

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

213

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

214

},

215

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

216

"value": 3.14, # Goal value.

217

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

218

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

219

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

220

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

221

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

222

{

223

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

224

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

225

"number": 42, # Step number.

226

},

227

],

228

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

229

},

Yoshi Automation Bot

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

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

237

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

238

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

239

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

Yoshi Automation Bot

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

[diff] [blame]

240

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

241

"eventConditions": [ # List of event conditions.

242

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

243

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

Yoshi Automation Bot

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

[diff] [blame]

244

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

245

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

246

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

247

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

Yoshi Automation Bot

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

[diff] [blame]

248

},

249

],

250

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

251

},

Yoshi Automation Bot

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

[diff] [blame]

252

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

Yoshi Automation Bot

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

[diff] [blame]

253

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

254

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

Yoshi Automation Bot

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

[diff] [blame]

255

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

256

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

257

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

258

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

259

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

260

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

261

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

262

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

263

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

264

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

265

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

266

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

267

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

268

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

269

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

270

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

271

},

272

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

273

"value": 3.14, # Goal value.

274

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

275

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

276

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

277

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

278

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

279

{

280

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

281

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

282

"number": 42, # Step number.

283

},

284

],

285

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

286

},

Yoshi Automation Bot

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

[diff] [blame]

287

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

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

Yoshi Automation Bot

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

[diff] [blame]

298

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[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-12-09 08:56:03 -0800

[diff] [blame^]

305

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

306

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

Bu Sun Kim

6502091

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

[diff] [blame]

307

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

308

{ # JSON template for Analytics goal resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

309

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

310

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

311

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

Yoshi Automation Bot

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

[diff] [blame]

312

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

313

"eventConditions": [ # List of event conditions.

314

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

315

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

Yoshi Automation Bot

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

[diff] [blame]

316

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

317

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

318

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

319

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

Yoshi Automation Bot

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

[diff] [blame]

320

},

321

],

322

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

323

},

Yoshi Automation Bot

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

[diff] [blame]

324

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

Yoshi Automation Bot

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

[diff] [blame]

325

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

326

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

Yoshi Automation Bot

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

[diff] [blame]

327

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

328

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

329

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

330

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

331

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

332

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

333

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

334

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

335

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

336

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

337

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

338

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

339

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

340

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

341

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

342

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

343

},

344

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

345

"value": 3.14, # Goal value.

346

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

347

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

348

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

349

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

350

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

351

{

352

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

353

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

354

"number": 42, # Step number.

355

},

356

],

357

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

358

},

Bu Sun Kim

673ec5c

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

[diff] [blame]

359

},

John Asmuth

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

[diff] [blame]

360

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

361

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

Yoshi Automation Bot

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

[diff] [blame]

362

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

363

"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-12-09 08:56:03 -0800

[diff] [blame^]

364

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

365

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

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-26 17:16:03 -0800

[diff] [blame]

382

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

383

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

384

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

Yoshi Automation Bot

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

[diff] [blame]

385

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

386

"eventConditions": [ # List of event conditions.

387

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

388

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

Yoshi Automation Bot

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

[diff] [blame]

389

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

390

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

391

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

392

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

Yoshi Automation Bot

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

[diff] [blame]

393

},

394

],

395

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

396

},

Yoshi Automation Bot

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

[diff] [blame]

397

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

Yoshi Automation Bot

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

[diff] [blame]

398

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

399

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

Yoshi Automation Bot

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

[diff] [blame]

400

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

401

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

402

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

403

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

404

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

405

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

406

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

407

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

408

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

409

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

410

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

411

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

412

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

413

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

414

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

415

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

416

},

417

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

418

"value": 3.14, # Goal value.

419

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

420

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

421

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

422

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

423

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

424

{

425

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

426

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

427

"number": 42, # Step number.

428

},

429

],

430

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

431

},

Yoshi Automation Bot

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

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

439

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

440

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

441

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

Yoshi Automation Bot

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

[diff] [blame]

442

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

443

"eventConditions": [ # List of event conditions.

444

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

445

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

Yoshi Automation Bot

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

[diff] [blame]

446

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

447

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

448

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

449

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

Yoshi Automation Bot

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

[diff] [blame]

450

},

451

],

452

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

453

},

Yoshi Automation Bot

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

[diff] [blame]

454

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

Yoshi Automation Bot

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

[diff] [blame]

455

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

456

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

Yoshi Automation Bot

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

[diff] [blame]

457

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

458

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

459

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

460

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

461

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

462

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

463

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

464

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

465

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

466

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

467

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

468

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

469

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

470

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

471

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

472

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

473

},

474

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

475

"value": 3.14, # Goal value.

476

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

477

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

478

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

479

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

480

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

481

{

482

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

483

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

484

"number": 42, # Step number.

485

},

486

],

487

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

488

},

Yoshi Automation Bot

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

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

505

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

506

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

507

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

Yoshi Automation Bot

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

[diff] [blame]

508

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

509

"eventConditions": [ # List of event conditions.

510

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

511

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

Yoshi Automation Bot

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

[diff] [blame]

512

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

513

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

514

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

515

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

Yoshi Automation Bot

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

[diff] [blame]

516

},

517

],

518

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

519

},

Yoshi Automation Bot

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

[diff] [blame]

520

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

Yoshi Automation Bot

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

[diff] [blame]

521

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

522

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

Yoshi Automation Bot

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

[diff] [blame]

523

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

524

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

525

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

526

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

527

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

528

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

529

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

530

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

531

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

532

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

533

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

534

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

535

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

536

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

537

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

538

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

539

},

540

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

541

"value": 3.14, # Goal value.

542

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

543

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

544

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

545

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

546

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

547

{

548

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

549

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

550

"number": 42, # Step number.

551

},

552

],

553

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

554

},

Yoshi Automation Bot

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

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

562

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

563

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

564

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

Yoshi Automation Bot

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

[diff] [blame]

565

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

566

"eventConditions": [ # List of event conditions.

567

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

568

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

Yoshi Automation Bot

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

[diff] [blame]

569

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

570

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

571

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

572

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

Yoshi Automation Bot

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

[diff] [blame]

573

},

574

],

575

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

576

},

Yoshi Automation Bot

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

[diff] [blame]

577

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

Yoshi Automation Bot

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

[diff] [blame]

578

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

579

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

Yoshi Automation Bot

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

[diff] [blame]

580

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

581

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

582

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

583

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

584

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

585

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

586

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

587

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

588

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

589

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

590

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

591

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

592

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

593

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

594

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

595

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

596

},

597

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

598

"value": 3.14, # Goal value.

599

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

600

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

601

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

602

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

603

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

604

{

605

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

606

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

607

"number": 42, # Step number.

608

},

609

],

610

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

611

},

Yoshi Automation Bot

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

[diff] [blame]

612

}</pre>

John Asmuth