Blame - docs/dyn/analytics_v3.management.webpropertyUserLinks.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, 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 web property.</p>

83

Bu Sun Kim

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

[diff] [blame]

84

<code><a href="#list">list(accountId, webPropertyId, 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 webProperty-user links for a given web property.</p>

86

Dan O'Meara

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

[diff] [blame]

87

<code><a href="#update">update(accountId, webPropertyId, 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 web property.</p>

89

<h3>Method Details</h3>

90

91

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

92

<pre>Removes a user from the given web property.

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

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]

102

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

John Asmuth

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

[diff] [blame]

103

<pre>Adds a new user to the given web property.

104

105

Args:

106

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

107

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

Dan O'Meara

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

[diff] [blame]

108

body: object, The request body.

John Asmuth

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

[diff] [blame]

109

The object takes the form of:

110

111

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

112

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

113

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

114

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

115

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

116

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

117

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

118

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

John Asmuth

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

[diff] [blame]

119

},

Bu Sun Kim

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

[diff] [blame]

120

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

121

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

122

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

123

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

124

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

125

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

126

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

John Asmuth

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

[diff] [blame]

127

},

Bu Sun Kim

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

[diff] [blame]

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

John Asmuth

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

[diff] [blame]

136

},

137

},

Bu Sun Kim

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

[diff] [blame]

138

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

139

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

140

"A String",

John Asmuth

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

[diff] [blame]

141

],

Bu Sun Kim

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

[diff] [blame]

142

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

143

"A String",

John Asmuth

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

[diff] [blame]

144

],

145

},

Bu Sun Kim

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

[diff] [blame]

146

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

147

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

148

"kind": "analytics#userRef",

149

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

150

},

151

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

152

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

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

158

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

John Asmuth

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

[diff] [blame]

167

},

Bu Sun Kim

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

[diff] [blame]

168

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

169

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

170

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

171

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

172

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

173

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

174

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

John Asmuth

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

[diff] [blame]

175

},

Bu Sun Kim

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

[diff] [blame]

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

John Asmuth

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

[diff] [blame]

184

},

185

},

Bu Sun Kim

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

[diff] [blame]

186

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

187

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

188

"A String",

John Asmuth

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

[diff] [blame]

189

],

Bu Sun Kim

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

[diff] [blame]

190

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

191

"A String",

John Asmuth

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

[diff] [blame]

192

],

193

},

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

196

"kind": "analytics#userRef",

197

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

198

},

199

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

200

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

205

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

John Asmuth

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

[diff] [blame]

206

<pre>Lists webProperty-user links for a given web property.

207

208

Args:

209

accountId: string, Account ID which the given web property belongs to. (required)

Bu Sun Kim

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

[diff] [blame]

210

webPropertyId: string, Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)

John Asmuth

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

[diff] [blame]

211

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

212

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

John Asmuth

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

[diff] [blame]

213

214

Returns:

215

An object of the form:

216

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

John Asmuth

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

[diff] [blame]

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

John Asmuth

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

[diff] [blame]

233

},

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

236

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

237

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

238

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

239

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

240

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

John Asmuth

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

[diff] [blame]

241

},

Bu Sun Kim

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

[diff] [blame]

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

John Asmuth

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

[diff] [blame]

250

},

251

},

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

254

"A String",

John Asmuth

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

[diff] [blame]

255

],

Bu Sun Kim

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

[diff] [blame]

256

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

257

"A String",

John Asmuth

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

[diff] [blame]

258

],

259

},

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

"kind": "analytics#userRef",

263

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

264

},

265

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

266

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

John Asmuth

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

[diff] [blame]

267

},

268

],

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]

273

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

John Asmuth

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

[diff] [blame]

274

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

275

276

Args:

277

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

278

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

279

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

Dan O'Meara

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

[diff] [blame]

280

body: object, The request body.

John Asmuth

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

[diff] [blame]

281

The object takes the form of:

282

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

John Asmuth

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

[diff] [blame]

291

},

Bu Sun Kim

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

[diff] [blame]

292

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

293

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

294

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

295

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

296

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

297

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

298

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

John Asmuth

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

[diff] [blame]

299

},

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

John Asmuth

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

[diff] [blame]

308

},

309

},

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

"A String",

John Asmuth

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

[diff] [blame]

313

],

Bu Sun Kim

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

[diff] [blame]

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

John Asmuth

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

[diff] [blame]

316

],

317

},

Bu Sun Kim

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

[diff] [blame]

318

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

319

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

320

"kind": "analytics#userRef",

321

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

322

},

323

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

324

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

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

330

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

John Asmuth

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

[diff] [blame]

339

},

Bu Sun Kim

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

[diff] [blame]

340

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

341

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

342

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

343

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

344

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

345

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

346

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

John Asmuth

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

[diff] [blame]

347

},

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

John Asmuth

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

[diff] [blame]

356

},

357

},

Bu Sun Kim

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

[diff] [blame]

358

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

359

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

360

"A String",

John Asmuth

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

[diff] [blame]

361

],

Bu Sun Kim

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

[diff] [blame]

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

John Asmuth

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

[diff] [blame]

364

],

365

},

Bu Sun Kim