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

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

108

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

109

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

110

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

111

{

Bu Sun Kim

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

[diff] [blame^]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

114

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

115

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

116

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

117

},

118

],

John Asmuth

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

[diff] [blame]

119

},

Bu Sun Kim

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

[diff] [blame]

120

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

121

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

122

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

123

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

124

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

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

128

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

John Asmuth

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

[diff] [blame]

129

{

Bu Sun Kim

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

[diff] [blame^]

130

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

Bu Sun Kim

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

[diff] [blame]

131

"number": 42, # Step number.

132

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

John Asmuth

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

[diff] [blame]

133

},

134

],

Bu Sun Kim

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame^]

136

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

John Asmuth

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

[diff] [blame]

137

},

Bu Sun Kim

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

[diff] [blame]

138

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

139

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

140

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

141

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

142

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

143

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

144

},

Bu Sun Kim

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

[diff] [blame]

145

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

146

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

147

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

148

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

149

},

150

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

Bu Sun Kim

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

[diff] [blame]

151

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

Bu Sun Kim

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

[diff] [blame^]

152

"value": 3.14, # Goal value.

153

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

154

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

155

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

156

},

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

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

173

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

174

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

175

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

176

{

Bu Sun Kim

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

[diff] [blame^]

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

180

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

181

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

182

},

183

],

John Asmuth

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

[diff] [blame]

184

},

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

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

188

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

189

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

190

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

Bu Sun Kim

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

[diff] [blame]

191

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

192

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

193

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

John Asmuth

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

[diff] [blame]

194

{

Bu Sun Kim

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

[diff] [blame^]

195

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

Bu Sun Kim

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

[diff] [blame]

196

"number": 42, # Step number.

197

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

John Asmuth

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

[diff] [blame]

198

},

199

],

Bu Sun Kim

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

[diff] [blame]

200

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

Bu Sun Kim

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

[diff] [blame^]

201

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

John Asmuth

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

[diff] [blame]

202

},

Bu Sun Kim

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

[diff] [blame]

203

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

204

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

205

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

206

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

207

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

208

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

209

},

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

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

214

},

215

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

Bu Sun Kim

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

[diff] [blame]

216

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

Bu Sun Kim

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

[diff] [blame^]

217

"value": 3.14, # Goal value.

218

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

219

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

220

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

221

},

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

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

230

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

231

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

232

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

233

{

Bu Sun Kim

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

[diff] [blame^]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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

236

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

237

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

238

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

239

},

240

],

John Asmuth

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

[diff] [blame]

241

},

Bu Sun Kim

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

[diff] [blame]

242

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

243

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

244

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

245

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

246

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

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

249

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

250

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

John Asmuth

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

[diff] [blame]

251

{

Bu Sun Kim

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

[diff] [blame^]

252

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

Bu Sun Kim

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

[diff] [blame]

253

"number": 42, # Step number.

254

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

John Asmuth

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

[diff] [blame]

255

},

256

],

Bu Sun Kim

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

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame^]

258

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

John Asmuth

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

[diff] [blame]

259

},

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

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

263

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

264

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

265

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

266

},

Bu Sun Kim

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

[diff] [blame]

267

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

268

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

269

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

270

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

271

},

272

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

Bu Sun Kim

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

[diff] [blame]

273

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

Bu Sun Kim

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

[diff] [blame^]

274

"value": 3.14, # Goal value.

275

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

276

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

277

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

278

},

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

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

298

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

299

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

300

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

301

"items": [ # A list of goals.

John Asmuth

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

[diff] [blame]

302

{ # JSON template for Analytics goal resource.

Bu Sun Kim

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

[diff] [blame]

303

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

304

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

305

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

306

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

307

{

Bu Sun Kim

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

[diff] [blame^]

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

311

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

312

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

313

},

314

],

John Asmuth

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

[diff] [blame]

315

},

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

319

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

320

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

321

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

Bu Sun Kim

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

[diff] [blame]

322

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

323

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

324

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

John Asmuth

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

[diff] [blame]

325

{

Bu Sun Kim

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

[diff] [blame^]

326

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

Bu Sun Kim

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

[diff] [blame]

327

"number": 42, # Step number.

328

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

John Asmuth

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

[diff] [blame]

329

},

330

],

Bu Sun Kim

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

[diff] [blame]

331

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

Bu Sun Kim

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

[diff] [blame^]

332

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

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

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

335

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

336

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

337

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

338

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

339

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

340

},

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

343

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

344

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

345

},

346

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

Bu Sun Kim

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

[diff] [blame]

347

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

Bu Sun Kim

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

[diff] [blame^]

348

"value": 3.14, # Goal value.

349

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

350

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

351

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

352

},

John Asmuth

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

[diff] [blame]

353

},

354

],

Bu Sun Kim

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

[diff] [blame^]

355

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

356

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

357

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

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

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

375

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

376

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

377

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

378

{

Bu Sun Kim

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

[diff] [blame^]

379

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

Bu Sun Kim

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

[diff] [blame]

380

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

381

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

382

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

383

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

384

},

385

],

John Asmuth

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

[diff] [blame]

386

},

Bu Sun Kim

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

[diff] [blame]

387

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

388

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

389

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

390

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

391

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

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

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

John Asmuth

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

[diff] [blame]

396

{

Bu Sun Kim

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

[diff] [blame^]

397

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

Bu Sun Kim

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

[diff] [blame]

398

"number": 42, # Step number.

399

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

John Asmuth

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

[diff] [blame]

400

},

401

],

Bu Sun Kim

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

[diff] [blame]

402

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

Bu Sun Kim

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

[diff] [blame^]

403

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

John Asmuth

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

[diff] [blame]

404

},

Bu Sun Kim

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

[diff] [blame]

405

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

406

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

407

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

408

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

409

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

410

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

411

},

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

414

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

415

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

416

},

417

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

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame^]

419

"value": 3.14, # Goal value.

420

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

421

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

422

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

423

},

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

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

432

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

433

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

434

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

435

{

Bu Sun Kim

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

[diff] [blame^]

436

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

Bu Sun Kim

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

[diff] [blame]

437

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

438

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

439

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

440

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

441

},

442

],

John Asmuth

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

[diff] [blame]

443

},

Bu Sun Kim

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

[diff] [blame]

444

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

445

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

446

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

447

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

448

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

449

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

Bu Sun Kim

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

[diff] [blame]

450

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

451

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

452

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

John Asmuth

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

[diff] [blame]

453

{

Bu Sun Kim

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

[diff] [blame^]

454

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

Bu Sun Kim

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

[diff] [blame]

455

"number": 42, # Step number.

456

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

John Asmuth

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

[diff] [blame]

457

},

458

],

Bu Sun Kim

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

[diff] [blame]

459

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

Bu Sun Kim

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

[diff] [blame^]

460

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

John Asmuth

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

[diff] [blame]

461

},

Bu Sun Kim

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

[diff] [blame]

462

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

463

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

464

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

465

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

466

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

467

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

468

},

Bu Sun Kim

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

[diff] [blame]

469

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

470

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

471

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

472

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

473

},

474

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

Bu Sun Kim

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

[diff] [blame]

475

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

Bu Sun Kim

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

[diff] [blame^]

476

"value": 3.14, # Goal value.

477

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

478

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

479

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

480

},

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

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

498

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

499

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

500

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

501

{

Bu Sun Kim

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

[diff] [blame^]

502

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

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

505

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

506

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

507

},

508

],

John Asmuth

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

[diff] [blame]

509

},

Bu Sun Kim

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

[diff] [blame]

510

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

511

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

512

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

513

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

514

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

515

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

Bu Sun Kim

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

[diff] [blame]

516

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

517

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

518

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

John Asmuth

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

[diff] [blame]

519

{

Bu Sun Kim

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

[diff] [blame^]

520

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

Bu Sun Kim

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

[diff] [blame]

521

"number": 42, # Step number.

522

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

John Asmuth

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

[diff] [blame]

523

},

524

],

Bu Sun Kim

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

[diff] [blame]

525

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

Bu Sun Kim

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

[diff] [blame^]

526

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

John Asmuth

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

[diff] [blame]

527

},

Bu Sun Kim

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

[diff] [blame]

528

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

529

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

530

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

531

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

532

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

533

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

534

},

Bu Sun Kim

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

[diff] [blame]

535

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

536

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

537

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

538

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

539

},

540

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

Bu Sun Kim

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

[diff] [blame]

541

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

Bu Sun Kim

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

[diff] [blame^]

542

"value": 3.14, # Goal value.

543

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

544

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

545

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

546

},

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

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

555

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

556

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

557

"eventConditions": [ # List of event conditions.

John Asmuth

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

[diff] [blame]

558

{

Bu Sun Kim

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

[diff] [blame^]

559

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

Bu Sun Kim

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

[diff] [blame]

560

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

561

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

562

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

563

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

564

},

565

],

John Asmuth

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

[diff] [blame]

566

},

Bu Sun Kim

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

[diff] [blame]

567

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

568

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

569

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

570

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

571

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

572

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

Bu Sun Kim

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

[diff] [blame]

573

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

574

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

575

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

John Asmuth

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

[diff] [blame]

576

{

Bu Sun Kim

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

[diff] [blame^]

577

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

Bu Sun Kim

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

[diff] [blame]

578

"number": 42, # Step number.

579

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

John Asmuth

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

[diff] [blame]

580

},

581

],

Bu Sun Kim

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

[diff] [blame]

582

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

Bu Sun Kim

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

[diff] [blame^]

583

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

John Asmuth

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

[diff] [blame]

584

},

Bu Sun Kim

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

[diff] [blame]

585

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

586

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

587

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

588

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

589

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

590

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

591

},

Bu Sun Kim

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

[diff] [blame]

592

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

593

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

594

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

595

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

596

},

597

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

Bu Sun Kim

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

[diff] [blame]

598

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

Bu Sun Kim

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

[diff] [blame^]

599

"value": 3.14, # Goal value.

600

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

601

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

602

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

603

},

John Asmuth