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

82

<p class="firstline">Removes a user from the given view (profile).</p>

83

Dan O'Meara

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

[diff] [blame]

84

<code><a href="#insert">insert(accountId, webPropertyId, profileId, 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 view (profile).</p>

86

Dmitry Frenkel

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

[diff] [blame]

87

<code><a href="#list">list(accountId, webPropertyId, profileId, 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 profile-user links for a given view (profile).</p>

89

Dan O'Meara

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

[diff] [blame]

90

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

100

<pre>Removes a user from the given view (profile).

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

profileId: string, View (Profile) ID to delete the user link for. (required)

106

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]

111

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

John Asmuth

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

[diff] [blame]

112

<pre>Adds a new user to the given view (profile).

113

114

Args:

115

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

116

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

117

profileId: string, View (Profile) ID to create the user link for. (required)

Dan O'Meara

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

[diff] [blame]

118

body: object, The request body.

John Asmuth

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

[diff] [blame]

119

The object takes the form of:

120

121

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

122

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

123

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

124

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

},

Dmitry Frenkel

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

[diff] [blame]

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

},

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

},

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

},

153

},

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

157

"A String",

158

],

159

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

160

"A String",

161

],

162

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

168

169

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

170

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

171

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

172

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

173

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

Bu Sun Kim

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

[diff] [blame]

174

},

Dmitry Frenkel

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

[diff] [blame]

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

},

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

},

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

},

201

},

202

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

Bu Sun Kim

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

[diff] [blame]

203

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

204

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

205

"A String",

206

],

207

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

208

"A String",

209

],

210

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

215

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

John Asmuth

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

[diff] [blame]

216

<pre>Lists profile-user links for a given view (profile).

217

218

Args:

219

accountId: string, Account ID which the given view (profile) belongs to. (required)

Bu Sun Kim

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

[diff] [blame]

220

webPropertyId: string, Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)

221

profileId: string, View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

222

start_index: integer, An index of the first profile-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]

223

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

John Asmuth

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

[diff] [blame]

224

225

Returns:

226

An object of the form:

227

228

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

229

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

230

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

231

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

232

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

John Asmuth

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

[diff] [blame]

233

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

234

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

235

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

236

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

237

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

Bu Sun Kim

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

[diff] [blame]

238

},

Dmitry Frenkel

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

[diff] [blame]

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

},

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

},

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

},

265

},

266

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

Bu Sun Kim

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

[diff] [blame]

267

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

268

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

269

"A String",

270

],

271

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

272

"A String",

273

],

274

},

John Asmuth

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

[diff] [blame]

275

},

276

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

277

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

Dmitry Frenkel

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

[diff] [blame]

278

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

279

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

284

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

John Asmuth

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

[diff] [blame]

285

<pre>Updates permissions for an existing user on the given view (profile).

286

287

Args:

288

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

289

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

290

profileId: string, View (Profile ID) to update the user link for. (required)

291

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

Dan O'Meara

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

[diff] [blame]

292

body: object, The request body.

John Asmuth

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

[diff] [blame]

293

The object takes the form of:

294

295

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

296

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

297

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

298

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

299

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

Bu Sun Kim

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

[diff] [blame]

300

},

Dmitry Frenkel

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

[diff] [blame]

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

},

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

},

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

},

327

},

328

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

Bu Sun Kim

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

[diff] [blame]

329

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

330

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

331

"A String",

332

],

333

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

334

"A String",

335

],

336

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

342

343

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

344

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

345

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

346

"kind": "analytics#userRef",

Dmitry Frenkel

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

[diff] [blame]

347

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

Bu Sun Kim

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

[diff] [blame]

348

},

Dmitry Frenkel

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

[diff] [blame]

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

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

357

},

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

},

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

},

375

},

376

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

Bu Sun Kim

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

[diff] [blame]

377

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

378

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

379

"A String",

380

],

381

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

382

"A String",

383

],

384

},

John Asmuth