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

Yoshi Automation Bot

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

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

Yoshi Automation Bot

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

[diff] [blame^]

122

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

123

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

124

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

125

"A String",

126

],

127

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

"A String",

],

},

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

},

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

},

149

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

150

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

151

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

152

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

153

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

154

},

155

},

156

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

157

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

158

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

159

"kind": "analytics#userRef",

160

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

161

},

162

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

}

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.

170

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

171

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

172

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

173

"A String",

174

],

175

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

"A String",

],

},

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

Yoshi Automation Bot

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

[diff] [blame^]

180

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

181

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

182

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

183

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

184

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

185

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

186

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

187

},

188

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

189

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

Yoshi Automation Bot

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

[diff] [blame^]

190

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

191

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

192

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

193

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

194

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

195

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

Dmitry Frenkel

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

[diff] [blame]

196

},

Yoshi Automation Bot

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

[diff] [blame^]

197

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

198

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

199

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

200

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

201

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

Bu Sun Kim

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

[diff] [blame]

202

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

203

},

Yoshi Automation Bot

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

[diff] [blame^]

204

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

205

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

206

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

207

"kind": "analytics#userRef",

208

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

209

},

210

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

211

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[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

6502091

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)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

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

Yoshi Automation Bot

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

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

Bu Sun Kim

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

[diff] [blame]

229

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

Bu Sun Kim

6502091

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

[diff] [blame]

230

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

John Asmuth

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

[diff] [blame]

231

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

Yoshi Automation Bot

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

[diff] [blame^]

232

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

233

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

234

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

235

"A String",

236

],

237

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

"A String",

],

},

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

Dmitry Frenkel

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

[diff] [blame]

249

},

Yoshi Automation Bot

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

[diff] [blame^]

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

258

},

Yoshi Automation Bot

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

[diff] [blame^]

259

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

260

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

261

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

262

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

263

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

Bu Sun Kim

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

[diff] [blame]

264

},

John Asmuth

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

[diff] [blame]

265

},

Yoshi Automation Bot

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

[diff] [blame^]

266

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

267

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

268

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

269

"kind": "analytics#userRef",

270

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

271

},

272

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

273

},

John Asmuth

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

[diff] [blame]

274

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

275

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

Yoshi Automation Bot

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

[diff] [blame^]

276

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

277

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

Yoshi Automation Bot

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

[diff] [blame^]

278

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

279

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

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.

Yoshi Automation Bot

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

[diff] [blame^]

296

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

297

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

298

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

299

"A String",

300

],

301

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

"A String",

],

},

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

},

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

},

323

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

324

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

325

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

326

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

327

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

328

},

329

},

330

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

331

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

332

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

333

"kind": "analytics#userRef",

334

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

335

},

336

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

}

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.

344

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

345

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

346

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

347

"A String",

348

],

349

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

"A String",

],

},

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

Yoshi Automation Bot

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

[diff] [blame^]

354

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

355

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

356

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

357

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

358

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

359

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

360

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

361

},

362

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

363

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

Yoshi Automation Bot

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

[diff] [blame^]

364

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

365

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

366

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

367

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

368

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

369

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

Dmitry Frenkel

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

[diff] [blame]

370

},

Yoshi Automation Bot

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

[diff] [blame^]

371

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

372

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

373

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

374

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

375

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

Bu Sun Kim

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

[diff] [blame]

376

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

377

},

Yoshi Automation Bot

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

[diff] [blame^]

378

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

379

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

380

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

381

"kind": "analytics#userRef",

382

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

383

},

384

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

385

}</pre>

John Asmuth