Blame - docs/dyn/analytics_v3.management.customDimensions.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, 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

Yoshi Automation Bot

b6971b0

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

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

114

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

115

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

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

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

124

},

125

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

126

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

127

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

128

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

129

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

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

},

154

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

155

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

156

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

157

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

158

}

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

},

176

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

177

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

178

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

179

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

180

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

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

673ec5c

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

[diff] [blame]

190

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

Yoshi Automation Bot

b6971b0

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

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

197

"items": [ # Collection of custom dimensions.

198

{ # JSON template for Analytics Custom Dimension.

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

},

210

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

211

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

212

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

213

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

214

},

215

],

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

},

249

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

250

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

251

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

252

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

253

}

Craig Citro

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

[diff] [blame]

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

},

272

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

273

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

274

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

275

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

276

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

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

},

302

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

303

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

304

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

305

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

306

}

Craig Citro

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

[diff] [blame]

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.

Yoshi Automation Bot