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-05-20 12:08:20 -0700

[diff] [blame]

107

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

108

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

109

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

110

},

Bu Sun Kim

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

[diff] [blame]

111

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

112

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

113

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

114

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

115

{

Bu Sun Kim

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

[diff] [blame]

116

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

117

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

118

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

119

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

120

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

John Asmuth

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

[diff] [blame]

121

},

122

],

John Asmuth

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

[diff] [blame]

123

},

Bu Sun Kim

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

[diff] [blame]

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

John Asmuth

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

[diff] [blame]

134

{

Bu Sun Kim

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

[diff] [blame]

135

"number": 42, # Step number.

136

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

137

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

John Asmuth

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

[diff] [blame]

138

},

139

],

Bu Sun Kim

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

[diff] [blame]

140

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

John Asmuth

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

[diff] [blame]

141

},

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

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

145

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

146

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

147

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

John Asmuth

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

[diff] [blame]

148

},

Bu Sun Kim

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

[diff] [blame]

149

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

150

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

151

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

152

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

153

},

154

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

155

"value": 3.14, # Goal value.

156

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

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]

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-05-20 12:08:20 -0700

[diff] [blame]

172

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

173

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

174

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

175

},

Bu Sun Kim

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

[diff] [blame]

176

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

177

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

178

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

179

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

180

{

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

183

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

184

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

185

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

John Asmuth

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

[diff] [blame]

186

},

187

],

John Asmuth

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

[diff] [blame]

188

},

Bu Sun Kim

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

[diff] [blame]

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

John Asmuth

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

[diff] [blame]

199

{

Bu Sun Kim

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

[diff] [blame]

200

"number": 42, # Step number.

201

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

202

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

John Asmuth

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

[diff] [blame]

203

},

204

],

Bu Sun Kim

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

[diff] [blame]

205

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

John Asmuth

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

[diff] [blame]

206

},

Bu Sun Kim

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

[diff] [blame]

207

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

208

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

209

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

210

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

211

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

212

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

John Asmuth

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

[diff] [blame]

213

},

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

216

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

217

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

218

},

219

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

220

"value": 3.14, # Goal value.

221

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

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-05-20 12:08:20 -0700

[diff] [blame]

229

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

230

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

231

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

232

},

Bu Sun Kim

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

[diff] [blame]

233

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

234

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

235

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

236

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

237

{

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

John Asmuth

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

[diff] [blame]

243

},

244

],

John Asmuth

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

[diff] [blame]

245

},

Bu Sun Kim

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

[diff] [blame]

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

John Asmuth

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

[diff] [blame]

256

{

Bu Sun Kim

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

[diff] [blame]

257

"number": 42, # Step number.

258

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

259

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

John Asmuth

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

[diff] [blame]

260

},

261

],

Bu Sun Kim

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

[diff] [blame]

262

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

John Asmuth

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

[diff] [blame]

263

},

Bu Sun Kim

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

[diff] [blame]

264

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

265

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

266

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

267

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

268

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

269

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

John Asmuth

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

[diff] [blame]

270

},

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

273

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

274

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

275

},

276

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

277

"value": 3.14, # Goal value.

278

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

John Asmuth

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

[diff] [blame]

}</pre>

</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-05-20 12:08:20 -0700

[diff] [blame]

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

305

{ # JSON template for Analytics goal resource.

Bu Sun Kim

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

[diff] [blame]

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-05-20 12:08:20 -0700

[diff] [blame]

310

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

311

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

312

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

313

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

314

{

Bu Sun Kim

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

[diff] [blame]

315

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

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.

318

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

319

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

John Asmuth

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

[diff] [blame]

320

},

321

],

John Asmuth

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

[diff] [blame]

322

},

Bu Sun Kim

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

[diff] [blame]

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

John Asmuth

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

[diff] [blame]

333

{

Bu Sun Kim

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

[diff] [blame]

334

"number": 42, # Step number.

335

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

336

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

John Asmuth

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

[diff] [blame]

337

},

338

],

Bu Sun Kim

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

[diff] [blame]

339

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

John Asmuth

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

[diff] [blame]

340

},

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

343

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

344

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

345

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

346

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

John Asmuth

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

[diff] [blame]

347

},

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

350

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

351

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

352

},

353

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

354

"value": 3.14, # Goal value.

355

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

John Asmuth

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

[diff] [blame]

356

},

357

],

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-05-20 12:08:20 -0700

[diff] [blame]

374

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

375

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

376

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

377

},

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

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

381

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

382

{

Bu Sun Kim

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

[diff] [blame]

383

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

384

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

385

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

386

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

387

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

John Asmuth

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

[diff] [blame]

388

},

389

],

John Asmuth

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

[diff] [blame]

390

},

Bu Sun Kim

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

[diff] [blame]

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

John Asmuth

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

[diff] [blame]

401

{

Bu Sun Kim

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

[diff] [blame]

402

"number": 42, # Step number.

403

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

404

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

John Asmuth

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

[diff] [blame]

405

},

406

],

Bu Sun Kim

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

[diff] [blame]

407

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

John Asmuth

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

[diff] [blame]

408

},

Bu Sun Kim

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

[diff] [blame]

409

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

410

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

411

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

412

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

413

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

414

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

John Asmuth

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

[diff] [blame]

415

},

Bu Sun Kim

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

[diff] [blame]

416

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

417

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

418

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

419

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

420

},

421

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

422

"value": 3.14, # Goal value.

423

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

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-05-20 12:08:20 -0700

[diff] [blame]

431

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

432

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

433

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

434

},

Bu Sun Kim

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

[diff] [blame]

435

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

436

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

437

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

438

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

439

{

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

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

443

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

444

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

John Asmuth

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

[diff] [blame]

445

},

446

],

John Asmuth

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

[diff] [blame]

447

},

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

John Asmuth

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

[diff] [blame]

458

{

Bu Sun Kim

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

[diff] [blame]

459

"number": 42, # Step number.

460

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

461

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

John Asmuth

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

[diff] [blame]

462

},

463

],

Bu Sun Kim

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

[diff] [blame]

464

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

John Asmuth

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

[diff] [blame]

465

},

Bu Sun Kim

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

[diff] [blame]

466

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

467

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

468

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

469

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

470

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

471

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

John Asmuth

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

[diff] [blame]

472

},

Bu Sun Kim

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

[diff] [blame]

473

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

474

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

475

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

476

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

477

},

478

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

479

"value": 3.14, # Goal value.

480

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

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]

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-05-20 12:08:20 -0700

[diff] [blame]

497

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

498

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

499

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

500

},

Bu Sun Kim

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

[diff] [blame]

501

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

502

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

503

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

504

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

505

{

Bu Sun Kim

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

[diff] [blame]

506

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

507

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

508

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

509

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

510

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

John Asmuth

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

[diff] [blame]

511

},

512

],

John Asmuth

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

[diff] [blame]

513

},

Bu Sun Kim

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

[diff] [blame]

514

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

John Asmuth

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

[diff] [blame]

524

{

Bu Sun Kim

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

[diff] [blame]

525

"number": 42, # Step number.

526

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

527

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

John Asmuth

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

[diff] [blame]

528

},

529

],

Bu Sun Kim

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

[diff] [blame]

530

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

John Asmuth

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

[diff] [blame]

531

},

Bu Sun Kim

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

[diff] [blame]

532

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

533

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

534

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

535

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

536

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

537

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

John Asmuth

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

[diff] [blame]

538

},

Bu Sun Kim

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

[diff] [blame]

539

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

540

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

541

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

542

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

543

},

544

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

545

"value": 3.14, # Goal value.

546

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

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-05-20 12:08:20 -0700

[diff] [blame]

554

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

555

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

556

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

557

},

Bu Sun Kim

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

[diff] [blame]

558

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

559

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

560

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

561

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

562

{

Bu Sun Kim

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

[diff] [blame]

563

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

564

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

565

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

566

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

567

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

John Asmuth

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

[diff] [blame]

568

},

569

],

John Asmuth

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

[diff] [blame]

570

},

Bu Sun Kim

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

[diff] [blame]

571

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

572

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

573

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

574

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

575

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

576

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

577

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

578

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

579

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

580

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

John Asmuth

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

[diff] [blame]

581

{

Bu Sun Kim

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

[diff] [blame]

582

"number": 42, # Step number.

583

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

584

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

John Asmuth

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

[diff] [blame]

585

},

586

],

Bu Sun Kim

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

[diff] [blame]

587

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

John Asmuth

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

[diff] [blame]

588

},

Bu Sun Kim

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

[diff] [blame]

589

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

590

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

591

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

592

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

593

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

594

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

John Asmuth

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

[diff] [blame]

595

},

Bu Sun Kim

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

[diff] [blame]

596

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

597

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

598

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

599

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

600

},

601

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

602

"value": 3.14, # Goal value.

603

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

John Asmuth