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

82

<p class="firstline">Removes a user from the given web property.</p>

83

Dan O'Meara

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

[diff] [blame]

84

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

86

Dmitry Frenkel

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

[diff] [blame]

87

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

88

<p class="firstline">Lists webProperty-user links for a given web property.</p>

89

Dan O'Meara

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

[diff] [blame]

90

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

100

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

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

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]

110

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

John Asmuth

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

[diff] [blame]

111

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

112

113

Args:

114

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

115

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

Dan O'Meara

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

[diff] [blame]

116

body: object, The request body.

John Asmuth

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

[diff] [blame]

117

The object takes the form of:

118

119

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

120

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

121

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

Dmitry Frenkel

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

[diff] [blame]

122

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

123

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

Dmitry Frenkel

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame^]

125

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

126

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

127

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

128

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

Dmitry Frenkel

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

[diff] [blame]

129

},

130

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

131

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

132

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

Dmitry Frenkel

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

[diff] [blame]

133

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

Bu Sun Kim

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

[diff] [blame^]

134

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

135

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

136

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

137

},

138

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

139

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

140

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

141

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

142

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

Dmitry Frenkel

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

[diff] [blame]

143

},

144

},

Bu Sun Kim

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

[diff] [blame]

145

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

146

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

147

"A String",

148

],

149

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

150

"A String",

151

],

152

},

Bu Sun Kim

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

[diff] [blame^]

153

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

154

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

155

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

156

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

157

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

158

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

159

"kind": "analytics#userRef",

160

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

166

167

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

168

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

169

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

Dmitry Frenkel

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

[diff] [blame]

170

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

171

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

Dmitry Frenkel

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

[diff] [blame]

172

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

Bu Sun Kim

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

[diff] [blame^]

173

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

174

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

175

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

176

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

Dmitry Frenkel

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

[diff] [blame]

177

},

178

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

179

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

180

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

Dmitry Frenkel

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

[diff] [blame]

181

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

Bu Sun Kim

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

[diff] [blame^]

182

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

183

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

184

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

185

},

186

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

187

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

188

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

189

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

190

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

Dmitry Frenkel

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

[diff] [blame]

191

},

192

},

Bu Sun Kim

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

[diff] [blame]

193

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

194

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

195

"A String",

196

],

197

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

198

"A String",

199

],

200

},

Bu Sun Kim

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

[diff] [blame^]

201

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

202

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

203

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

204

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

205

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

206

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

207

"kind": "analytics#userRef",

208

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

213

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

214

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

215

216

Args:

217

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

Bu Sun Kim

6502091

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

[diff] [blame]

218

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)

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

219

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.

Dmitry Frenkel

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

[diff] [blame]

220

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]

221

222

Returns:

223

An object of the form:

224

225

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

226

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

227

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

228

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

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.

Dmitry Frenkel

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

[diff] [blame]

232

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

233

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

Dmitry Frenkel

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

[diff] [blame]

234

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

235

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

Dmitry Frenkel

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

[diff] [blame]

236

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

Bu Sun Kim

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

[diff] [blame^]

237

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

238

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

239

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

240

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

Dmitry Frenkel

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

[diff] [blame]

241

},

242

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

243

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

244

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

Dmitry Frenkel

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

[diff] [blame]

245

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

Bu Sun Kim

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

[diff] [blame^]

246

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

247

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

248

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

249

},

250

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

251

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

252

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

253

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

254

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

Dmitry Frenkel

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

[diff] [blame]

255

},

256

},

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

"A String",

260

],

261

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

262

"A String",

263

],

264

},

Bu Sun Kim

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

[diff] [blame^]

265

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

266

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

267

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

268

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

269

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

270

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

271

"kind": "analytics#userRef",

272

},

John Asmuth

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

[diff] [blame]

273

},

274

],

Dmitry Frenkel

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

[diff] [blame]

275

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

276

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

281

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

John Asmuth

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

[diff] [blame]

282

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

283

284

Args:

285

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

286

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

287

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

Dan O'Meara

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

[diff] [blame]

288

body: object, The request body.

John Asmuth

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

[diff] [blame]

289

The object takes the form of:

290

291

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

292

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

293

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

Dmitry Frenkel

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

[diff] [blame]

294

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

295

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

Dmitry Frenkel

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

[diff] [blame]

296

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

Bu Sun Kim

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

[diff] [blame^]

297

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

298

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

299

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

300

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

Dmitry Frenkel

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

[diff] [blame]

301

},

302

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

303

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

304

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

Dmitry Frenkel

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

[diff] [blame]

305

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

Bu Sun Kim

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

[diff] [blame^]

306

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

307

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

308

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

309

},

310

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

311

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

312

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

313

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

314

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

Dmitry Frenkel

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

[diff] [blame]

315

},

316

},

Bu Sun Kim

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

[diff] [blame]

317

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

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

320

],

321

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

322

"A String",

323

],

324

},

Bu Sun Kim

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

[diff] [blame^]

325

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

326

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

327

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

328

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

329

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

330

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

331

"kind": "analytics#userRef",

332

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

338

339

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

340

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

341

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

Dmitry Frenkel

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

[diff] [blame]

342

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

343

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

Dmitry Frenkel

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

[diff] [blame]

344

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

Bu Sun Kim

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

[diff] [blame^]

345

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

346

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

347

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

348

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

Dmitry Frenkel

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

[diff] [blame]

349

},

350

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

351

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

352

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

Dmitry Frenkel

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

[diff] [blame]

353

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

Bu Sun Kim

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

[diff] [blame^]

354

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

355

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

356

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

357

},

358

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

359

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

360

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

361

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

362

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

Dmitry Frenkel

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

[diff] [blame]

363

},

364

},

Bu Sun Kim

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

[diff] [blame]

365

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

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

368

],

369

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

370

"A String",

371

],

372

},

Bu Sun Kim