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

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

[diff] [blame]

81

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

John Asmuth

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

[diff] [blame]

82

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

83

Bu Sun Kim

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

[diff] [blame]

84

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

John Asmuth

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

[diff] [blame]

85

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

86

Dan O'Meara

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

[diff] [blame]

87

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

John Asmuth

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

[diff] [blame]

88

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

89

<h3>Method Details</h3>

90

91

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

92

<pre>Removes a user from the given account.

93

94

Args:

95

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

96

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]

101

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

John Asmuth

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

[diff] [blame]

102

<pre>Adds a new user to the given account.

103

104

Args:

105

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

Dan O'Meara

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

[diff] [blame]

106

body: object, The request body.

John Asmuth

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

[diff] [blame]

107

The object takes the form of:

108

109

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

110

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

111

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

112

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

113

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

114

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

115

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

116

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

John Asmuth

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

[diff] [blame]

117

},

Bu Sun Kim

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

[diff] [blame]

118

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

119

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

120

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

121

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

122

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

123

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

124

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

John Asmuth

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

[diff] [blame]

125

},

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

John Asmuth

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

[diff] [blame]

134

},

135

},

Bu Sun Kim

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

[diff] [blame]

136

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

137

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

138

"A String",

John Asmuth

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

[diff] [blame]

139

],

Bu Sun Kim

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

[diff] [blame]

140

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

141

"A String",

John Asmuth

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

[diff] [blame]

142

],

143

},

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

146

"kind": "analytics#userRef",

147

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

148

},

149

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

150

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

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

156

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

John Asmuth

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

[diff] [blame]

165

},

Bu Sun Kim

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

[diff] [blame]

166

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

167

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

168

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

169

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

170

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

171

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

172

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

John Asmuth

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

[diff] [blame]

173

},

Bu Sun Kim

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

[diff] [blame]

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

John Asmuth

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

[diff] [blame]

182

},

183

},

Bu Sun Kim

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

[diff] [blame]

184

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

185

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

186

"A String",

John Asmuth

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

[diff] [blame]

187

],

Bu Sun Kim

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

[diff] [blame]

188

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

189

"A String",

John Asmuth

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

[diff] [blame]

190

],

191

},

Bu Sun Kim

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

[diff] [blame]

192

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

193

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

194

"kind": "analytics#userRef",

195

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

196

},

197

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

198

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

203

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

John Asmuth

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

[diff] [blame]

204

<pre>Lists account-user links for a given account.

205

206

Args:

207

accountId: string, Account ID to retrieve the user links for. (required)

John Asmuth

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

[diff] [blame]

208

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

Bu Sun Kim

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

[diff] [blame]

209

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

John Asmuth

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

[diff] [blame]

210

211

Returns:

212

An object of the form:

213

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

217

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

218

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

219

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

220

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

221

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

John Asmuth

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

[diff] [blame]

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

John Asmuth

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

[diff] [blame]

230

},

Bu Sun Kim

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

[diff] [blame]

231

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

232

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

233

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

234

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

235

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

236

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

237

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

John Asmuth

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

[diff] [blame]

238

},

Bu Sun Kim

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

[diff] [blame]

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

John Asmuth

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

[diff] [blame]

247

},

248

},

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

"A String",

John Asmuth

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

[diff] [blame]

252

],

Bu Sun Kim

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

[diff] [blame]

253

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

254

"A String",

John Asmuth

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

[diff] [blame]

255

],

256

},

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

"kind": "analytics#userRef",

260

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

261

},

262

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

263

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

John Asmuth

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

[diff] [blame]

264

},

265

],

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]

270

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

John Asmuth

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

[diff] [blame]

271

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

272

273

Args:

274

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

275

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

Dan O'Meara

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

[diff] [blame]

276

body: object, The request body.

John Asmuth

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

[diff] [blame]

277

The object takes the form of:

278

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

John Asmuth

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

[diff] [blame]

287

},

Bu Sun Kim

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

[diff] [blame]

288

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

289

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

290

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

291

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

292

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

293

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

294

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

John Asmuth

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

[diff] [blame]

295

},

Bu Sun Kim

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

[diff] [blame]

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

John Asmuth

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

[diff] [blame]

304

},

305

},

Bu Sun Kim

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

[diff] [blame]

306

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

307

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

308

"A String",

John Asmuth

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

[diff] [blame]

309

],

Bu Sun Kim

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

[diff] [blame]

310

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

311

"A String",

John Asmuth

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

[diff] [blame]

312

],

313

},

Bu Sun Kim

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

[diff] [blame]

314

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

315

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

316

"kind": "analytics#userRef",

317

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

318

},

319

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

320

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

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

326

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

John Asmuth

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

[diff] [blame]

335

},

Bu Sun Kim

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

[diff] [blame]

336

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

337

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

338

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

339

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

340

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

341

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

342

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

John Asmuth

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

[diff] [blame]

343

},

Bu Sun Kim

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

[diff] [blame]

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

John Asmuth

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

[diff] [blame]

352

},

353

},

Bu Sun Kim

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

[diff] [blame]

354

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

355

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

356

"A String",

John Asmuth

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

[diff] [blame]

357

],

Bu Sun Kim

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

[diff] [blame]

358

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

359

"A String",

John Asmuth

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

[diff] [blame]

360

],

361

},

Bu Sun Kim