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

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

[diff] [blame]

81

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

83

Bu Sun Kim

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

[diff] [blame]

84

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

85

<p class="firstline">Lists profile-user links for a given view (profile).</p>

86

Dan O'Meara

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

[diff] [blame]

87

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

88

<p class="firstline">Updates permissions for an existing user on the given view (profile).</p>

89

<h3>Method Details</h3>

90

91

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

92

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

93

94

Args:

95

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

96

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

97

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

98

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]

103

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

John Asmuth

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

[diff] [blame]

104

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

105

106

Args:

107

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

108

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

109

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

Dan O'Meara

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

[diff] [blame]

110

body: object, The request body.

John Asmuth

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

[diff] [blame]

111

The object takes the form of:

112

113

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

114

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

115

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

116

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

117

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

118

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

119

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

120

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

John Asmuth

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

[diff] [blame]

121

},

Bu Sun Kim

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

[diff] [blame]

122

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

123

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

124

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

125

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

126

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

127

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

128

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

John Asmuth

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

[diff] [blame]

129

},

Bu Sun Kim

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

[diff] [blame]

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

John Asmuth

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

[diff] [blame]

138

},

139

},

Bu Sun Kim

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

[diff] [blame]

140

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

141

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

142

"A String",

John Asmuth

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

[diff] [blame]

143

],

Bu Sun Kim

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

[diff] [blame]

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

John Asmuth

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

[diff] [blame]

146

],

147

},

Bu Sun Kim

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

[diff] [blame]

148

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

149

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

150

"kind": "analytics#userRef",

151

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

152

},

153

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

154

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

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

160

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

John Asmuth

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

[diff] [blame]

169

},

Bu Sun Kim

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

[diff] [blame]

170

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

171

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

172

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

173

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

174

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

175

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

176

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

John Asmuth

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

[diff] [blame]

177

},

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

John Asmuth

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

[diff] [blame]

186

},

187

},

Bu Sun Kim

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

[diff] [blame]

188

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

189

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

190

"A String",

John Asmuth

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

[diff] [blame]

191

],

Bu Sun Kim

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

[diff] [blame]

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

John Asmuth

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

[diff] [blame]

194

],

195

},

Bu Sun Kim

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

[diff] [blame]

196

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

197

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

198

"kind": "analytics#userRef",

199

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

200

},

201

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

202

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

207

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

208

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

209

210

Args:

211

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

Bu Sun Kim

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

[diff] [blame]

212

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)

213

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)

John Asmuth

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

[diff] [blame]

214

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.

Bu Sun Kim

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

[diff] [blame]

215

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]

216

217

Returns:

218

An object of the form:

219

220

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

221

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

222

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

223

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

224

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

225

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

226

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

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.

Bu Sun Kim

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

[diff] [blame]

229

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

230

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

231

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

232

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

233

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

234

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

235

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

John Asmuth

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

[diff] [blame]

236

},

Bu Sun Kim

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

[diff] [blame]

237

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

238

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

239

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

240

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

241

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

242

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

243

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

John Asmuth

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

[diff] [blame]

244

},

Bu Sun Kim

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

[diff] [blame]

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

John Asmuth

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

[diff] [blame]

253

},

254

},

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

257

"A String",

John Asmuth

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

[diff] [blame]

258

],

Bu Sun Kim

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

[diff] [blame]

259

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

260

"A String",

John Asmuth

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

[diff] [blame]

261

],

262

},

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

"kind": "analytics#userRef",

266

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

267

},

268

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

269

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

John Asmuth

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

[diff] [blame]

270

},

271

],

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]

276

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

John Asmuth

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

[diff] [blame]

277

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

278

279

Args:

280

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

281

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

282

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

283

linkId: string, Link ID to update the 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.

Bu Sun Kim

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

[diff] [blame]

288

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

289

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

290

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

291

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

292

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

293

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

294

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

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

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

297

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

298

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

299

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

300

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

301

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

302

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

John Asmuth

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

[diff] [blame]

303

},

Bu Sun Kim

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

[diff] [blame]

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

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

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

315

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

316

"A String",

John Asmuth

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

[diff] [blame]

317

],

Bu Sun Kim

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

[diff] [blame]

318

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

319

"A String",

John Asmuth

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

[diff] [blame]

320

],

321

},

Bu Sun Kim

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

[diff] [blame]

322

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

323

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

324

"kind": "analytics#userRef",

325

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

326

},

327

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

328

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

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.

Bu Sun Kim

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

[diff] [blame]

336

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

337

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

338

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

339

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

340

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

341

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

342

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

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

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

345

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

346

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

347

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

348

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

349

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

350

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

John Asmuth

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

[diff] [blame]

351

},

Bu Sun Kim

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

[diff] [blame]

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

John Asmuth

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

[diff] [blame]

360

},

361

},

Bu Sun Kim

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

[diff] [blame]

362

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

363

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

364

"A String",

John Asmuth

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

[diff] [blame]

365

],

Bu Sun Kim

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

[diff] [blame]

366

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

367

"A String",

John Asmuth

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

[diff] [blame]

368

],

369

},

Bu Sun Kim