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

2015-03-02 13:40:36 -0800

[diff] [blame]

81

<code><a href="#get">get(accountId, webPropertyId, customMetricId)</a></code></p>

82

<p class="firstline">Get a custom metric 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, body=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

85

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

86

Yoshi Automation Bot

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

[diff] [blame^]

87

<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

88

<p class="firstline">Lists custom metrics 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, customMetricId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

91

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

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#update">update(accountId, webPropertyId, customMetricId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

94

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

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>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

102

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

103

<pre>Get a custom metric to which the user has access.

104

105

Args:

106

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

107

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

108

customMetricId: string, The ID of the custom metric to retrieve. (required)

109

110

Returns:

111

An object of the form:

112

113

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

114

"accountId": "A String", # Account ID.

115

"type": "A String", # Data type of custom metric.

116

"index": 42, # Index of the custom metric.

117

"min_value": "A String", # Min value of custom metric.

118

"created": "A String", # Time the custom metric was created.

119

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

120

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

121

"id": "A String", # Custom metric ID.

122

"updated": "A String", # Time the custom metric was last modified.

123

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

124

"href": "A String", # Link to the property to which the custom metric belongs.

125

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

126

},

127

"selfLink": "A String", # Link for the custom metric

128

"name": "A String", # Name of the custom metric.

129

"active": True or False, # Boolean indicating whether the custom metric is active.

130

"webPropertyId": "A String", # Property ID.

131

"max_value": "A String", # Max value of custom metric.

132

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

136

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

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

137

<pre>Create a new custom metric.

138

139

Args:

140

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

141

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

Dan O'Meara

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

[diff] [blame]

142

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

143

The object takes the form of:

144

145

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

146

"accountId": "A String", # Account ID.

147

"type": "A String", # Data type of custom metric.

148

"index": 42, # Index of the custom metric.

149

"min_value": "A String", # Min value of custom metric.

150

"created": "A String", # Time the custom metric was created.

151

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

152

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

153

"id": "A String", # Custom metric ID.

154

"updated": "A String", # Time the custom metric was last modified.

155

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

156

"href": "A String", # Link to the property to which the custom metric belongs.

157

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

158

},

159

"selfLink": "A String", # Link for the custom metric

160

"name": "A String", # Name of the custom metric.

161

"active": True or False, # Boolean indicating whether the custom metric is active.

162

"webPropertyId": "A String", # Property ID.

163

"max_value": "A String", # Max value of custom metric.

164

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

Returns:

An object of the form:

169

170

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

171

"accountId": "A String", # Account ID.

172

"type": "A String", # Data type of custom metric.

173

"index": 42, # Index of the custom metric.

174

"min_value": "A String", # Min value of custom metric.

175

"created": "A String", # Time the custom metric was created.

176

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

177

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

178

"id": "A String", # Custom metric ID.

179

"updated": "A String", # Time the custom metric was last modified.

180

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

181

"href": "A String", # Link to the property to which the custom metric belongs.

182

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

183

},

184

"selfLink": "A String", # Link for the custom metric

185

"name": "A String", # Name of the custom metric.

186

"active": True or False, # Boolean indicating whether the custom metric is active.

187

"webPropertyId": "A String", # Property ID.

188

"max_value": "A String", # Max value of custom metric.

189

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame^]

193

<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

194

<pre>Lists custom metrics to which the user has access.

195

196

Args:

197

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

198

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

199

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

Yoshi Automation Bot

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

[diff] [blame^]

200

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

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

201

202

Returns:

203

An object of the form:

204

205

{ # A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.

Yoshi Automation Bot

c2228be

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

[diff] [blame]

206

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

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

207

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

Yoshi Automation Bot

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

[diff] [blame^]

208

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

209

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

210

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

Bu Sun Kim

6502091

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

[diff] [blame]

211

"items": [ # Collection of custom metrics.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

212

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

213

"accountId": "A String", # Account ID.

214

"type": "A String", # Data type of custom metric.

215

"index": 42, # Index of the custom metric.

216

"min_value": "A String", # Min value of custom metric.

217

"created": "A String", # Time the custom metric was created.

218

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

219

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

220

"id": "A String", # Custom metric ID.

221

"updated": "A String", # Time the custom metric was last modified.

222

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

223

"href": "A String", # Link to the property to which the custom metric belongs.

224

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

225

},

Yoshi Automation Bot

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

[diff] [blame^]

226

"selfLink": "A String", # Link for the custom metric

227

"name": "A String", # Name of the custom metric.

228

"active": True or False, # Boolean indicating whether the custom metric is active.

229

"webPropertyId": "A String", # Property ID.

230

"max_value": "A String", # Max value of custom metric.

231

},

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

232

],

Yoshi Automation Bot

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

[diff] [blame^]

233

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

234

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

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

239

<code class="details" id="patch">patch(accountId, webPropertyId, customMetricId, body=None, ignoreCustomDataSourceLinks=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

240

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

241

242

Args:

243

accountId: string, Account ID for the custom metric to update. (required)

244

webPropertyId: string, Web property ID for the custom metric to update. (required)

245

customMetricId: string, Custom metric ID for the custom metric to update. (required)

Dan O'Meara

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

[diff] [blame]

246

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

247

The object takes the form of:

248

249

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

250

"accountId": "A String", # Account ID.

251

"type": "A String", # Data type of custom metric.

252

"index": 42, # Index of the custom metric.

253

"min_value": "A String", # Min value of custom metric.

254

"created": "A String", # Time the custom metric was created.

255

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

256

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

257

"id": "A String", # Custom metric ID.

258

"updated": "A String", # Time the custom metric was last modified.

259

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

260

"href": "A String", # Link to the property to which the custom metric belongs.

261

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

262

},

263

"selfLink": "A String", # Link for the custom metric

264

"name": "A String", # Name of the custom metric.

265

"active": True or False, # Boolean indicating whether the custom metric is active.

266

"webPropertyId": "A String", # Property ID.

267

"max_value": "A String", # Max value of custom metric.

268

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

269

270

ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

271

272

Returns:

273

An object of the form:

274

275

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

276

"accountId": "A String", # Account ID.

277

"type": "A String", # Data type of custom metric.

278

"index": 42, # Index of the custom metric.

279

"min_value": "A String", # Min value of custom metric.

280

"created": "A String", # Time the custom metric was created.

281

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

282

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

283

"id": "A String", # Custom metric ID.

284

"updated": "A String", # Time the custom metric was last modified.

285

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

286

"href": "A String", # Link to the property to which the custom metric belongs.

287

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

288

},

289

"selfLink": "A String", # Link for the custom metric

290

"name": "A String", # Name of the custom metric.

291

"active": True or False, # Boolean indicating whether the custom metric is active.

292

"webPropertyId": "A String", # Property ID.

293

"max_value": "A String", # Max value of custom metric.

294

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

298

<code class="details" id="update">update(accountId, webPropertyId, customMetricId, body=None, ignoreCustomDataSourceLinks=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

299

<pre>Updates an existing custom metric.

300

301

Args:

302

accountId: string, Account ID for the custom metric to update. (required)

303

webPropertyId: string, Web property ID for the custom metric to update. (required)

304

customMetricId: string, Custom metric ID for the custom metric to update. (required)

Dan O'Meara

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

[diff] [blame]

305

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

306

The object takes the form of:

307

308

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot

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

[diff] [blame^]

309

"accountId": "A String", # Account ID.

310

"type": "A String", # Data type of custom metric.

311

"index": 42, # Index of the custom metric.

312

"min_value": "A String", # Min value of custom metric.

313

"created": "A String", # Time the custom metric was created.

314

"scope": "A String", # Scope of the custom metric: HIT or PRODUCT.

315

"kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.

316

"id": "A String", # Custom metric ID.

317

"updated": "A String", # Time the custom metric was last modified.

318

"parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.

319

"href": "A String", # Link to the property to which the custom metric belongs.

320

"type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".

321

},

322

"selfLink": "A String", # Link for the custom metric

323

"name": "A String", # Name of the custom metric.

324

"active": True or False, # Boolean indicating whether the custom metric is active.

325

"webPropertyId": "A String", # Property ID.

326

"max_value": "A String", # Max value of custom metric.

327

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

328

329

ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

330

331

Returns:

332

An object of the form:

333

334

{ # JSON template for Analytics Custom Metric.

Yoshi Automation Bot