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

2020-10-06 16:46:05 -0700

[diff] [blame^]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Craig Citro

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

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[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

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

114

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

115

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

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

118

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

119

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

120

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

121

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

122

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

123

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

124

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

125

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

126

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

127

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

Bu Sun Kim

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

[diff] [blame]

128

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

129

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

130

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

131

},

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]

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

146

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

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

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

161

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

162

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

163

},

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

171

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

172

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

173

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

Bu Sun Kim

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

[diff] [blame]

174

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

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

188

},

Craig Citro

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

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

Bu Sun Kim

6502091

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

[diff] [blame]

199

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

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

206

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

207

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

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

208

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

209

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

210

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

211

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

Bu Sun Kim

6502091

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

[diff] [blame]

212

"items": [ # Collection of custom metrics.

Craig Citro

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

[diff] [blame]

213

{ # JSON template for Analytics Custom Metric.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

214

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

215

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

216

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

Bu Sun Kim

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

[diff] [blame]

217

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

Bu Sun Kim

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

[diff] [blame]

228

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

229

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

230

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

231

},

Craig Citro

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

[diff] [blame]

232

},

233

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

250

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

251

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

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

Bu Sun Kim

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

[diff] [blame]

264

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

265

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

266

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

267

},

Craig Citro

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

[diff] [blame]

268

}

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

276

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

277

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

278

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

Bu Sun Kim

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

[diff] [blame]

279

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

Bu Sun Kim

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

[diff] [blame]

290

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

291

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

292

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

293

},

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]

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

309

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

310

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

Bu Sun Kim

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

[diff] [blame]

323

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

324

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

325

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

326

},

Craig Citro

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

[diff] [blame]

327

}

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.

Dmitry Frenkel