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.

Dmitry Frenkel

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

[diff] [blame]

122

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

123

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

Dmitry Frenkel

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

[diff] [blame]

124

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

125

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

Dmitry Frenkel

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

[diff] [blame]

126

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

Bu Sun Kim

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

[diff] [blame]

127

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

128

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

129

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

130

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

Dmitry Frenkel

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

[diff] [blame]

131

},

132

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

133

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

134

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

Dmitry Frenkel

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

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

137

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

138

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

139

},

140

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

141

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

142

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

143

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

144

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

Dmitry Frenkel

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

[diff] [blame]

145

},

146

},

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

"A String",

150

],

151

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

152

"A String",

153

],

154

},

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

157

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

158

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

159

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

160

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

161

"kind": "analytics#userRef",

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.

Dmitry Frenkel

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

[diff] [blame]

170

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

171

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

Dmitry Frenkel

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

[diff] [blame]

172

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

173

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

Dmitry Frenkel

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

[diff] [blame]

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

176

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

177

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

178

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

Dmitry Frenkel

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

[diff] [blame]

179

},

180

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

181

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

182

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

Dmitry Frenkel

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

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

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

185

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

186

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

187

},

188

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

189

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

190

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

191

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

192

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

Dmitry Frenkel

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

[diff] [blame]

193

},

194

},

Bu Sun Kim

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

[diff] [blame]

195

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

196

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

197

"A String",

198

],

199

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

200

"A String",

201

],

202

},

Bu Sun Kim

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

[diff] [blame]

203

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

204

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

205

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

206

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

207

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

208

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

209

"kind": "analytics#userRef",

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

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)

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

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

230

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

231

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

232

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

Bu Sun Kim

6502091

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

[diff] [blame]

233

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

John Asmuth

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

[diff] [blame]

234

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

235

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

236

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

Dmitry Frenkel

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

[diff] [blame]

237

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

238

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

Dmitry Frenkel

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

[diff] [blame]

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

241

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

242

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

243

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

Dmitry Frenkel

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

[diff] [blame]

244

},

245

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

246

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

247

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

Dmitry Frenkel

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

[diff] [blame]

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

252

},

253

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

254

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

255

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

256

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

257

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

Dmitry Frenkel

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

[diff] [blame]

258

},

259

},

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

"A String",

263

],

264

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

265

"A String",

266

],

267

},

Bu Sun Kim

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

[diff] [blame]

268

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

269

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

270

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

271

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

272

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

273

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

274

"kind": "analytics#userRef",

275

},

John Asmuth

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

[diff] [blame]

276

},

277

],

Dmitry Frenkel

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

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

Bu Sun Kim

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

[diff] [blame]

279

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

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.

Dmitry Frenkel

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

[diff] [blame]

296

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

297

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

Dmitry Frenkel

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

[diff] [blame]

298

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

299

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

Dmitry Frenkel

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

[diff] [blame]

300

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

Bu Sun Kim

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

[diff] [blame]

301

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

302

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

303

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

304

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

Dmitry Frenkel

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

[diff] [blame]

305

},

306

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

307

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

308

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

Dmitry Frenkel

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

[diff] [blame]

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

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

313

},

314

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

315

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

316

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

317

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

318

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

Dmitry Frenkel

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

[diff] [blame]

319

},

320

},

Bu Sun Kim

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

[diff] [blame]

321

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

322

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

323

"A String",

324

],

325

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

326

"A String",

327

],

328

},

Bu Sun Kim

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

[diff] [blame]

329

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

330

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

331

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

332

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

333

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

334

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

335

"kind": "analytics#userRef",

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.

Dmitry Frenkel

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

[diff] [blame]

344

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

345

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

Dmitry Frenkel

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

[diff] [blame]

346

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

347

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

Dmitry Frenkel

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

[diff] [blame]

348

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

Bu Sun Kim

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

[diff] [blame]

349

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

350

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

351

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

352

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

Dmitry Frenkel

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

[diff] [blame]

353

},

354

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

355

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

356

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

Dmitry Frenkel

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

[diff] [blame]

357

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

Bu Sun Kim

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

[diff] [blame]

358

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

359

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

360

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

361

},

362

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

363

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

364

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

365

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

366

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

Dmitry Frenkel

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

[diff] [blame]

367

},

368

},

Bu Sun Kim

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

[diff] [blame]

369

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

370

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

371

"A String",

372

],

373

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

374

"A String",

375

],

376

},

Bu Sun Kim