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

82

<p class="firstline">Removes a user from the given account.</p>

83

Dan O'Meara

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

[diff] [blame]

84

<code><a href="#insert">insert(accountId, 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 account.</p>

86

Dmitry Frenkel

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

[diff] [blame]

87

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

88

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

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#update">update(accountId, 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 account.</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, linkId)</code>

100

<pre>Removes a user from the given account.

101

102

Args:

103

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

104

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]

109

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

John Asmuth

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

[diff] [blame]

110

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

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

body: object, The request body.

John Asmuth

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

[diff] [blame]

115

The object takes the form of:

116

117

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

Dmitry Frenkel

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

[diff] [blame]

118

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

Dmitry Frenkel

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

[diff] [blame]

119

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

Dmitry Frenkel

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

[diff] [blame]

120

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

121

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

Dmitry Frenkel

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

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

125

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

126

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

Dmitry Frenkel

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

[diff] [blame]

127

},

128

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

129

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

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

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

135

},

136

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

137

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

138

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

139

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

140

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

Dmitry Frenkel

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

[diff] [blame]

141

},

142

},

Bu Sun Kim

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

[diff] [blame]

143

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

144

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

145

"A String",

146

],

147

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

148

"A String",

149

],

150

},

Bu Sun Kim

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

[diff] [blame]

151

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

152

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

153

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

154

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

155

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

156

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

157

"kind": "analytics#userRef",

158

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

164

165

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

Dmitry Frenkel

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

[diff] [blame]

166

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

Dmitry Frenkel

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

[diff] [blame]

167

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

Dmitry Frenkel

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

[diff] [blame]

168

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

169

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

Dmitry Frenkel

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

[diff] [blame]

170

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

Bu Sun Kim

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

[diff] [blame]

171

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

172

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

173

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

174

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

Dmitry Frenkel

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

[diff] [blame]

175

},

176

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

177

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

178

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

Dmitry Frenkel

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

[diff] [blame]

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

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

182

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

183

},

184

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

185

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

186

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

187

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

188

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

Dmitry Frenkel

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

[diff] [blame]

189

},

190

},

Bu Sun Kim

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

[diff] [blame]

191

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

192

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

193

"A String",

194

],

195

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

196

"A String",

197

],

198

},

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

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

202

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

203

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

204

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

205

"kind": "analytics#userRef",

206

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

211

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

212

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

213

214

Args:

215

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

Bu Sun Kim

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

[diff] [blame]

216

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.

Dmitry Frenkel

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

[diff] [blame]

217

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]

218

219

Returns:

220

An object of the form:

221

222

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

223

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

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

226

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

Bu Sun Kim

6502091

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

[diff] [blame]

227

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

John Asmuth

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

[diff] [blame]

228

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

Dmitry Frenkel

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

[diff] [blame]

229

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

Dmitry Frenkel

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

[diff] [blame]

230

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

Dmitry Frenkel

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

[diff] [blame]

231

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

232

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

Dmitry Frenkel

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

[diff] [blame]

233

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

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

236

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

237

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

Dmitry Frenkel

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

[diff] [blame]

238

},

239

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

240

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

241

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

Dmitry Frenkel

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

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

244

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

245

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

246

},

247

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

248

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

249

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

250

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

251

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

Dmitry Frenkel

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

[diff] [blame]

252

},

253

},

Bu Sun Kim

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

[diff] [blame]

254

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

255

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

256

"A String",

257

],

258

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

259

"A String",

260

],

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

263

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

264

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

265

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

266

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

267

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

268

"kind": "analytics#userRef",

269

},

John Asmuth

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

[diff] [blame]

270

},

271

],

Dmitry Frenkel

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

[diff] [blame]

272

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

Bu Sun Kim

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

[diff] [blame]

273

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

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]

278

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

John Asmuth

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

[diff] [blame]

279

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

280

281

Args:

282

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

283

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

Dan O'Meara

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

[diff] [blame]

284

body: object, The request body.

John Asmuth

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

[diff] [blame]

285

The object takes the form of:

286

287

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

Dmitry Frenkel

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

[diff] [blame]

288

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

Dmitry Frenkel

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

[diff] [blame]

289

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

Dmitry Frenkel

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

[diff] [blame]

290

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

291

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

Dmitry Frenkel

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

[diff] [blame]

292

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

Bu Sun Kim

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

[diff] [blame]

293

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

294

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

295

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

296

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

Dmitry Frenkel

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

[diff] [blame]

297

},

298

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

299

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

300

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

Dmitry Frenkel

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

[diff] [blame]

301

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

Bu Sun Kim

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

[diff] [blame]

302

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

303

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

304

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

305

},

306

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

307

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

308

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

309

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

310

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

Dmitry Frenkel

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

[diff] [blame]

311

},

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

314

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

315

"A String",

316

],

317

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

318

"A String",

319

],

320

},

Bu Sun Kim

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

[diff] [blame]

321

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

322

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

323

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

324

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

325

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

326

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

327

"kind": "analytics#userRef",

328

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

334

335

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

Dmitry Frenkel

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

[diff] [blame]

336

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

Dmitry Frenkel

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

[diff] [blame]

337

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

Dmitry Frenkel

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

[diff] [blame]

338

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

339

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

Dmitry Frenkel

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

[diff] [blame]

340

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

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

343

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

344

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

Dmitry Frenkel

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

[diff] [blame]

345

},

346

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

347

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

348

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

Dmitry Frenkel

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

[diff] [blame]

349

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

Bu Sun Kim

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

[diff] [blame]

350

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

351

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

352

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

353

},

354

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

355

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

356

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

357

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

358

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

Dmitry Frenkel

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

[diff] [blame]

359

},

360

},

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

"A String",

364

],

365

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

366

"A String",

367

],

368

},

Bu Sun Kim