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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

81

<code><a href="#delete">delete(accountId, webPropertyId, linkId)</a></code></p>

82

<p class="firstline">Removes a user from the given web property.</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>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

85

<p class="firstline">Adds a new user to the given web property.</p>

86

Dmitry Frenkel

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

[diff] [blame]

87

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<p class="firstline">Lists webProperty-user links for a given web property.</p>

89

Dan O'Meara

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

[diff] [blame]

90

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

91

<p class="firstline">Updates permissions for an existing user on the given web property.</p>

92

<h3>Method Details</h3>

93

Dmitry Frenkel

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

[diff] [blame]

94

<code class="details" id="close">close()</code>

95

<pre>Close httplib2 connections.</pre>

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

99

<code class="details" id="delete">delete(accountId, webPropertyId, linkId)</code>

100

<pre>Removes a user from the given web property.

101

102

Args:

103

accountId: string, Account ID to delete the user link for. (required)

104

webPropertyId: string, Web Property ID to delete the user link for. (required)

105

linkId: string, Link ID to delete the user link for. (required)

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

110

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

111

<pre>Adds a new user to the given web property.

112

113

Args:

114

accountId: string, Account ID to create the user link for. (required)

115

webPropertyId: string, Web Property ID to create the user link for. (required)

Dan O'Meara

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

[diff] [blame]

116

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

117

The object takes the form of:

118

119

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.

Bu Sun Kim

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

[diff] [blame]

120

"userRef": { # JSON template for a user reference. # User reference.

121

"email": "A String", # Email ID of this user.

122

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

123

"id": "A String", # User ID.

Bu Sun Kim

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

[diff] [blame]

124

},

Dmitry Frenkel

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

[diff] [blame]

125

"selfLink": "A String", # Self link for this resource.

126

"kind": "analytics#entityUserLink", # Resource type for entity user link.

127

"entity": { # Entity for this link. It can be an account, a web property, or a view (profile).

128

"accountRef": { # JSON template for a linked account. # Account for this link.

129

"href": "A String", # Link for this account.

130

"kind": "analytics#accountRef", # Analytics account reference.

131

"name": "A String", # Account name.

132

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

133

},

134

"profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.

135

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

136

"kind": "analytics#profileRef", # Analytics view (profile) reference.

137

"name": "A String", # Name of this view (profile).

138

"href": "A String", # Link for this view (profile).

139

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

140

"id": "A String", # View (Profile) ID.

141

"accountId": "A String", # Account ID to which this view (profile) belongs.

142

},

143

"webPropertyRef": { # JSON template for a web property reference. # Web property for this link.

144

"internalWebPropertyId": "A String", # Internal ID for this web property.

145

"href": "A String", # Link for this web property.

146

"accountId": "A String", # Account ID to which this web property belongs.

147

"id": "A String", # Web property ID of the form UA-XXXXX-YY.

148

"name": "A String", # Name of this web property.

149

"kind": "analytics#webPropertyRef", # Analytics web property reference.

150

},

151

},

152

"id": "A String", # Entity user link ID

Bu Sun Kim

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

[diff] [blame]

153

"permissions": { # Permissions the user has for this entity.

154

"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.

155

"A String",

156

],

157

"effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.

158

"A String",

159

],

160

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

166

167

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.

Bu Sun Kim

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

[diff] [blame]

168

"userRef": { # JSON template for a user reference. # User reference.

169

"email": "A String", # Email ID of this user.

170

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

171

"id": "A String", # User ID.

Bu Sun Kim

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

[diff] [blame]

172

},

Dmitry Frenkel

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

[diff] [blame]

173

"selfLink": "A String", # Self link for this resource.

174

"kind": "analytics#entityUserLink", # Resource type for entity user link.

175

"entity": { # Entity for this link. It can be an account, a web property, or a view (profile).

176

"accountRef": { # JSON template for a linked account. # Account for this link.

177

"href": "A String", # Link for this account.

178

"kind": "analytics#accountRef", # Analytics account reference.

179

"name": "A String", # Account name.

180

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

181

},

182

"profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.

183

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

184

"kind": "analytics#profileRef", # Analytics view (profile) reference.

185

"name": "A String", # Name of this view (profile).

186

"href": "A String", # Link for this view (profile).

187

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

188

"id": "A String", # View (Profile) ID.

189

"accountId": "A String", # Account ID to which this view (profile) belongs.

190

},

191

"webPropertyRef": { # JSON template for a web property reference. # Web property for this link.

192

"internalWebPropertyId": "A String", # Internal ID for this web property.

193

"href": "A String", # Link for this web property.

194

"accountId": "A String", # Account ID to which this web property belongs.

195

"id": "A String", # Web property ID of the form UA-XXXXX-YY.

196

"name": "A String", # Name of this web property.

197

"kind": "analytics#webPropertyRef", # Analytics web property reference.

198

},

199

},

200

"id": "A String", # Entity user link ID

Bu Sun Kim

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

[diff] [blame]

201

"permissions": { # Permissions the user has for this entity.

202

"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.

203

"A String",

204

],

205

"effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.

206

"A String",

207

],

208

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

213

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

214

<pre>Lists webProperty-user links for a given web property.

215

216

Args:

217

accountId: string, Account ID which the given web property belongs to. (required)

Bu Sun Kim

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

[diff] [blame]

218

webPropertyId: string, Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

219

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

Dmitry Frenkel

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

[diff] [blame]

220

max_results: integer, The maximum number of webProperty-user Links to include in this response.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

221

222

Returns:

223

An object of the form:

224

225

{ # An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.

Dmitry Frenkel

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

[diff] [blame]

226

"previousLink": "A String", # Previous link for this account collection.

227

"nextLink": "A String", # Next link for this account collection.

228

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

Bu Sun Kim

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

[diff] [blame]

229

"items": [ # A list of entity user links.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

230

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.

Bu Sun Kim

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

[diff] [blame]

231

"userRef": { # JSON template for a user reference. # User reference.

232

"email": "A String", # Email ID of this user.

233

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

234

"id": "A String", # User ID.

Bu Sun Kim

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

[diff] [blame]

235

},

Dmitry Frenkel

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

[diff] [blame]

236

"selfLink": "A String", # Self link for this resource.

237

"kind": "analytics#entityUserLink", # Resource type for entity user link.

238

"entity": { # Entity for this link. It can be an account, a web property, or a view (profile).

239

"accountRef": { # JSON template for a linked account. # Account for this link.

240

"href": "A String", # Link for this account.

241

"kind": "analytics#accountRef", # Analytics account reference.

242

"name": "A String", # Account name.

243

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

244

},

245

"profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.

246

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

247

"kind": "analytics#profileRef", # Analytics view (profile) reference.

248

"name": "A String", # Name of this view (profile).

249

"href": "A String", # Link for this view (profile).

250

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

251

"id": "A String", # View (Profile) ID.

252

"accountId": "A String", # Account ID to which this view (profile) belongs.

253

},

254

"webPropertyRef": { # JSON template for a web property reference. # Web property for this link.

255

"internalWebPropertyId": "A String", # Internal ID for this web property.

256

"href": "A String", # Link for this web property.

257

"accountId": "A String", # Account ID to which this web property belongs.

258

"id": "A String", # Web property ID of the form UA-XXXXX-YY.

259

"name": "A String", # Name of this web property.

260

"kind": "analytics#webPropertyRef", # Analytics web property reference.

261

},

262

},

263

"id": "A String", # Entity user link ID

Bu Sun Kim

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

[diff] [blame]

264

"permissions": { # Permissions the user has for this entity.

265

"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.

266

"A String",

267

],

268

"effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.

269

"A String",

270

],

271

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

272

},

273

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

274

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

Dmitry Frenkel

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

[diff] [blame]

275

"itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

276

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

281

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

282

<pre>Updates permissions for an existing user on the given web property.

283

284

Args:

285

accountId: string, Account ID to update the account-user link for. (required)

286

webPropertyId: string, Web property ID to update the account-user link for. (required)

287

linkId: string, Link ID to update the account-user link for. (required)

Dan O'Meara

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

[diff] [blame]

288

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

289

The object takes the form of:

290

291

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.

Bu Sun Kim

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

[diff] [blame]

292

"userRef": { # JSON template for a user reference. # User reference.

293

"email": "A String", # Email ID of this user.

294

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

295

"id": "A String", # User ID.

Bu Sun Kim

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

[diff] [blame]

296

},

Dmitry Frenkel

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

[diff] [blame]

297

"selfLink": "A String", # Self link for this resource.

298

"kind": "analytics#entityUserLink", # Resource type for entity user link.

299

"entity": { # Entity for this link. It can be an account, a web property, or a view (profile).

300

"accountRef": { # JSON template for a linked account. # Account for this link.

301

"href": "A String", # Link for this account.

302

"kind": "analytics#accountRef", # Analytics account reference.

303

"name": "A String", # Account name.

304

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

305

},

306

"profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.

307

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

308

"kind": "analytics#profileRef", # Analytics view (profile) reference.

309

"name": "A String", # Name of this view (profile).

310

"href": "A String", # Link for this view (profile).

311

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

312

"id": "A String", # View (Profile) ID.

313

"accountId": "A String", # Account ID to which this view (profile) belongs.

314

},

315

"webPropertyRef": { # JSON template for a web property reference. # Web property for this link.

316

"internalWebPropertyId": "A String", # Internal ID for this web property.

317

"href": "A String", # Link for this web property.

318

"accountId": "A String", # Account ID to which this web property belongs.

319

"id": "A String", # Web property ID of the form UA-XXXXX-YY.

320

"name": "A String", # Name of this web property.

321

"kind": "analytics#webPropertyRef", # Analytics web property reference.

322

},

323

},

324

"id": "A String", # Entity user link ID

Bu Sun Kim

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

[diff] [blame]

325

"permissions": { # Permissions the user has for this entity.

326

"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.

327

"A String",

328

],

329

"effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.

330

"A String",

331

],

332

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

338

339

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.

Bu Sun Kim

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

[diff] [blame]

340

"userRef": { # JSON template for a user reference. # User reference.

341

"email": "A String", # Email ID of this user.

342

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

343

"id": "A String", # User ID.

Bu Sun Kim

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

[diff] [blame]

344

},

Dmitry Frenkel

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

[diff] [blame]

345

"selfLink": "A String", # Self link for this resource.

346

"kind": "analytics#entityUserLink", # Resource type for entity user link.

347

"entity": { # Entity for this link. It can be an account, a web property, or a view (profile).

348

"accountRef": { # JSON template for a linked account. # Account for this link.

349

"href": "A String", # Link for this account.

350

"kind": "analytics#accountRef", # Analytics account reference.

351

"name": "A String", # Account name.

352

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

353

},

354

"profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.

355

"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.

356

"kind": "analytics#profileRef", # Analytics view (profile) reference.

357

"name": "A String", # Name of this view (profile).

358

"href": "A String", # Link for this view (profile).

359

"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

360

"id": "A String", # View (Profile) ID.

361

"accountId": "A String", # Account ID to which this view (profile) belongs.

362

},

363

"webPropertyRef": { # JSON template for a web property reference. # Web property for this link.

364

"internalWebPropertyId": "A String", # Internal ID for this web property.

365

"href": "A String", # Link for this web property.

366

"accountId": "A String", # Account ID to which this web property belongs.

367

"id": "A String", # Web property ID of the form UA-XXXXX-YY.

368

"name": "A String", # Name of this web property.

369

"kind": "analytics#webPropertyRef", # Analytics web property reference.

370

},

371

},

372

"id": "A String", # Entity user link ID

Bu Sun Kim

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

[diff] [blame]

373

"permissions": { # Permissions the user has for this entity.

374

"local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.

375

"A String",

376

],

377

"effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.

378

"A String",

379

],

380

},

John Asmuth