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

82

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

83

Dan O'Meara

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

[diff] [blame]

84

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

86

Yoshi Automation Bot

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

[diff] [blame]

87

<code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p>

John Asmuth

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

[diff] [blame]

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

100

<pre>Removes a user from the given account.

101

102

Args:

103

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

104

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]

109

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

John Asmuth

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

[diff] [blame]

110

<pre>Adds a new user to the given account.

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

body: object, The request body.

John Asmuth

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

[diff] [blame]

115

The object takes the form of:

116

117

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

Yoshi Automation Bot

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

[diff] [blame]

118

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

119

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

120

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

121

"A String",

122

],

123

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

124

"A String",

125

],

126

},

Yoshi Automation Bot

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

[diff] [blame]

127

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

128

"kind": "analytics#userRef",

129

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

130

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

131

},

132

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

133

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

Yoshi Automation Bot

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

[diff] [blame]

134

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

135

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

136

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

Yoshi Automation Bot

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

[diff] [blame]

137

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

138

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

Yoshi Automation Bot

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

[diff] [blame]

139

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

140

},

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

Dmitry Frenkel

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

[diff] [blame]

149

},

Yoshi Automation Bot

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

[diff] [blame]

150

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

151

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

152

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

Yoshi Automation Bot

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

[diff] [blame]

153

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

Yoshi Automation Bot

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

[diff] [blame]

154

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

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

},

Yoshi Automation Bot

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

[diff] [blame]

158

},

Yoshi Automation Bot

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

[diff] [blame]

}

Returns:

An object of the form:

164

165

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

166

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

167

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

168

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

169

"A String",

170

],

171

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

],

},

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

176

"kind": "analytics#userRef",

177

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

178

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

179

},

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

},

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

},

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

},

206

},

207

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

211

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

John Asmuth

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

[diff] [blame]

212

<pre>Lists account-user links for a given account.

213

214

Args:

215

accountId: string, Account ID to retrieve the user links for. (required)

Dmitry Frenkel

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

[diff] [blame]

216

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

Yoshi Automation Bot

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

[diff] [blame]

217

start_index: integer, An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

John Asmuth

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

[diff] [blame]

218

219

Returns:

220

An object of the form:

221

222

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

223

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

Yoshi Automation Bot

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

[diff] [blame]

224

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

Bu Sun Kim

6502091

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

[diff] [blame]

225

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

John Asmuth

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

[diff] [blame]

226

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

Yoshi Automation Bot

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

[diff] [blame]

227

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

228

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

229

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

230

"A String",

231

],

232

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

233

"A String",

234

],

Dmitry Frenkel

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

[diff] [blame]

235

},

Yoshi Automation Bot

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

[diff] [blame]

236

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

237

"kind": "analytics#userRef",

238

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

239

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

240

},

Yoshi Automation Bot

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

[diff] [blame]

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

},

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

},

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

},

Bu Sun Kim

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

[diff] [blame]

267

},

John Asmuth

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

[diff] [blame]

268

},

269

],

Bu Sun Kim

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

[diff] [blame]

270

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

Yoshi Automation Bot

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

[diff] [blame]

271

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

Yoshi Automation Bot

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

[diff] [blame]

272

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

Yoshi Automation Bot

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

[diff] [blame]

273

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

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]

278

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

John Asmuth

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

[diff] [blame]

279

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

280

281

Args:

282

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

283

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

Yoshi Automation Bot

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

[diff] [blame]

288

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

289

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

290

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

291

"A String",

292

],

293

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

294

"A String",

295

],

296

},

Yoshi Automation Bot

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

[diff] [blame]

297

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

298

"kind": "analytics#userRef",

299

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

300

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

301

},

302

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

303

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

Yoshi Automation Bot

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

[diff] [blame]

304

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

305

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

306

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

Yoshi Automation Bot

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

[diff] [blame]

307

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

308

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

Yoshi Automation Bot

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

[diff] [blame]

309

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

310

},

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

Dmitry Frenkel

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

[diff] [blame]

319

},

Yoshi Automation Bot

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

[diff] [blame]

320

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

321

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

322

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

Yoshi Automation Bot

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

[diff] [blame]

323

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

Yoshi Automation Bot

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

[diff] [blame]

324

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

325

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

326

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

Bu Sun Kim

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

[diff] [blame]

327

},

Yoshi Automation Bot

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

[diff] [blame]

328

},

Yoshi Automation Bot