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

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

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.

Bu Sun Kim

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

[diff] [blame]

114

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

115

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

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

},

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

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.

Bu Sun Kim

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

[diff] [blame]

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

},

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

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.

Bu Sun Kim

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

[diff] [blame]

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

},

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

}</pre>

Craig Citro

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

[diff] [blame]

</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

3e17f89

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

[diff] [blame]

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

208

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

Bu Sun Kim

6502091

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

[diff] [blame]

209

"items": [ # Collection of custom metrics.

Craig Citro

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

[diff] [blame]

210

{ # JSON template for Analytics Custom Metric.

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

Craig Citro

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

[diff] [blame]

220

},

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

},

Craig Citro

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

[diff] [blame]

230

],

Bu Sun Kim

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

[diff] [blame]

231

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

232

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

233

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

234

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

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.

Bu Sun Kim

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

[diff] [blame]

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

},

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

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.

Bu Sun Kim

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

[diff] [blame]

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

},

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

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.

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

},

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

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.

Bu Sun Kim