Blame - docs/dyn/analytics_v3.management.customDimensions.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, customDimensionId)</a></code></p>

82

<p class="firstline">Get a custom dimension 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 dimension.</p>

86

Dmitry Frenkel

2020-10-06 16:46:05 -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 dimensions 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, customDimensionId, 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 dimension. 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, customDimensionId, 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 dimension.</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, customDimensionId)</code>

103

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

104

105

Args:

106

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

107

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

108

customDimensionId: string, The ID of the custom dimension to retrieve. (required)

109

110

Returns:

111

An object of the form:

112

113

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

114

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

Dmitry Frenkel

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

[diff] [blame]

115

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

116

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

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

Dmitry Frenkel

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

Dmitry Frenkel

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

[diff] [blame]

122

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

123

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

Bu Sun Kim

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

[diff] [blame]

124

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

125

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

126

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

127

},

Dmitry Frenkel

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

[diff] [blame]

128

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

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]

133

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

Craig Citro

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

[diff] [blame]

134

<pre>Create a new custom dimension.

135

136

Args:

137

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

138

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

Dan O'Meara

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

[diff] [blame]

139

body: object, The request body.

Craig Citro

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

[diff] [blame]

140

The object takes the form of:

141

142

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

143

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

Dmitry Frenkel

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

[diff] [blame]

144

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

145

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

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

Dmitry Frenkel

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

[diff] [blame]

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

Bu Sun Kim

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

[diff] [blame]

150

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

Dmitry Frenkel

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

[diff] [blame]

151

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

152

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

Bu Sun Kim

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

[diff] [blame]

153

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

154

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

155

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

156

},

Dmitry Frenkel

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

[diff] [blame]

157

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

Craig Citro

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

[diff] [blame]

}

Returns:

An object of the form:

163

164

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

165

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

Dmitry Frenkel

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

[diff] [blame]

166

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

167

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

168

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

Bu Sun Kim

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

[diff] [blame]

169

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

Dmitry Frenkel

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

[diff] [blame]

170

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

Bu Sun Kim

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

[diff] [blame]

171

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

Bu Sun Kim

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

[diff] [blame]

172

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

Dmitry Frenkel

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

[diff] [blame]

173

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

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

176

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

177

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

178

},

Dmitry Frenkel

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

[diff] [blame]

179

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

Craig Citro

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

184

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

185

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

186

187

Args:

188

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

189

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

Bu Sun Kim

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

[diff] [blame]

190

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

Dmitry Frenkel

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

[diff] [blame]

191

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]

192

193

Returns:

194

An object of the form:

195

196

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

Dmitry Frenkel

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

[diff] [blame]

197

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

Bu Sun Kim

6502091

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

[diff] [blame]

198

"items": [ # Collection of custom dimensions.

Craig Citro

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

[diff] [blame]

199

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

200

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

Dmitry Frenkel

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

[diff] [blame]

201

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

202

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

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

Dmitry Frenkel

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

[diff] [blame]

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

Dmitry Frenkel

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

[diff] [blame]

208

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

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

},

Dmitry Frenkel

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

[diff] [blame]

214

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

Craig Citro

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

[diff] [blame]

215

},

216

],

Bu Sun Kim

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

[diff] [blame]

217

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

Dmitry Frenkel

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

[diff] [blame]

218

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

219

"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

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

[diff] [blame]

220

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

Dmitry Frenkel

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

[diff] [blame]

221

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

222

"nextLink": "A String", # Link to next page for this custom dimension 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]

227

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

Craig Citro

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

[diff] [blame]

228

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

229

230

Args:

231

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

232

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

233

customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)

Dan O'Meara

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

[diff] [blame]

234

body: object, The request body.

Craig Citro

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

[diff] [blame]

235

The object takes the form of:

236

237

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

238

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

Dmitry Frenkel

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

[diff] [blame]

239

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

240

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

241

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

Bu Sun Kim

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

[diff] [blame]

242

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

Dmitry Frenkel

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

[diff] [blame]

243

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

Bu Sun Kim

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

[diff] [blame]

244

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

Bu Sun Kim

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

[diff] [blame]

245

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

Dmitry Frenkel

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

[diff] [blame]

246

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

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

249

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

250

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

251

},

Dmitry Frenkel

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

[diff] [blame]

252

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

Craig Citro

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

[diff] [blame]

253

}

254

255

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

256

257

Returns:

258

An object of the form:

259

260

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

261

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

Dmitry Frenkel

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

[diff] [blame]

262

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

263

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

264

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

Bu Sun Kim

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

[diff] [blame]

265

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

Dmitry Frenkel

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

[diff] [blame]

266

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

Bu Sun Kim

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

[diff] [blame]

267

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

Bu Sun Kim

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

[diff] [blame]

268

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

Dmitry Frenkel

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

[diff] [blame]

269

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

270

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

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

273

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

274

},

Dmitry Frenkel

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

[diff] [blame]

275

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

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]

280

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

Craig Citro

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

[diff] [blame]

281

<pre>Updates an existing custom dimension.

282

283

Args:

284

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

285

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

286

customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)

Dan O'Meara

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

[diff] [blame]

287

body: object, The request body.

Craig Citro

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

[diff] [blame]

288

The object takes the form of:

289

290

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim

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

[diff] [blame]

291

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

Dmitry Frenkel

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

[diff] [blame]

292

"scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

293

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

294

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

Bu Sun Kim

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

[diff] [blame]

295

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

Dmitry Frenkel

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

[diff] [blame]

296

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

Bu Sun Kim

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

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

Dmitry Frenkel

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

[diff] [blame]

299

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

300

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

Bu Sun Kim

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

[diff] [blame]

301

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

302

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

303

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

304

},

Dmitry Frenkel

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

[diff] [blame]

305

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

Craig Citro

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

[diff] [blame]

306

}

307

308

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

309

310

Returns:

311

An object of the form:

312

313

{ # JSON template for Analytics Custom Dimension.

Bu Sun Kim