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

Yoshi Automation Bot

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

[diff] [blame]

87

<code><a href="#list">list(accountId, webPropertyId, profileId, 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 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.

Yoshi Automation Bot

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

[diff] [blame]

122

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

123

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

124

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

125

"A String",

126

],

127

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

128

"A String",

129

],

130

},

Yoshi Automation Bot

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

[diff] [blame]

131

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

132

"kind": "analytics#userRef",

133

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

134

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

135

},

136

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

137

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

Yoshi Automation Bot

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

[diff] [blame]

138

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

139

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

140

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

Yoshi Automation Bot

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

[diff] [blame]

141

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

142

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

Yoshi Automation Bot

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

[diff] [blame]

143

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

144

},

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

Dmitry Frenkel

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

[diff] [blame]

153

},

Yoshi Automation Bot

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

[diff] [blame]

154

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

155

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

156

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

Yoshi Automation Bot

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

[diff] [blame]

157

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

Yoshi Automation Bot

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

[diff] [blame]

158

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

159

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

160

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

Bu Sun Kim

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

[diff] [blame]

161

},

Yoshi Automation Bot

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

[diff] [blame]

162

},

Yoshi Automation Bot

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

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

170

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

171

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

172

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

173

"A String",

174

],

175

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

180

"kind": "analytics#userRef",

181

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

182

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

183

},

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

},

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

},

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

},

210

},

211

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

215

<code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=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)

Dmitry Frenkel

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

[diff] [blame]

222

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

Yoshi Automation Bot

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

[diff] [blame]

223

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.

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.

Bu Sun Kim

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

[diff] [blame]

229

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

Yoshi Automation Bot

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

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

Bu Sun Kim

6502091

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

[diff] [blame]

231

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

John Asmuth

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

[diff] [blame]

232

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

233

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

234

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

235

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

236

"A String",

237

],

238

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

239

"A String",

240

],

Dmitry Frenkel

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

[diff] [blame]

241

},

Yoshi Automation Bot

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

[diff] [blame]

242

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

243

"kind": "analytics#userRef",

244

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

245

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

246

},

Yoshi Automation Bot

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

[diff] [blame]

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

},

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

},

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

},

Bu Sun Kim

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

[diff] [blame]

273

},

John Asmuth

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

[diff] [blame]

274

},

275

],

Bu Sun Kim

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

[diff] [blame]

276

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

Yoshi Automation Bot

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

[diff] [blame]

277

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

278

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

Yoshi Automation Bot

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

[diff] [blame]

279

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

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.

Yoshi Automation Bot

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

[diff] [blame]

296

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

297

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

298

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

299

"A String",

300

],

301

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

302

"A String",

303

],

304

},

Yoshi Automation Bot

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

[diff] [blame]

305

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

306

"kind": "analytics#userRef",

307

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

308

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

309

},

310

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

311

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

Yoshi Automation Bot

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

[diff] [blame]

312

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

313

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

314

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

Yoshi Automation Bot

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

[diff] [blame]

315

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

316

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

Yoshi Automation Bot

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

[diff] [blame]

317

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

318

},

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

Dmitry Frenkel

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

[diff] [blame]

327

},

Yoshi Automation Bot

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

[diff] [blame]

328

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

329

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

330

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

Yoshi Automation Bot

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

[diff] [blame]

331

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

Yoshi Automation Bot

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

[diff] [blame]

332

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

333

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

334

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

Bu Sun Kim

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

[diff] [blame]

335

},

Yoshi Automation Bot

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

[diff] [blame]

336

},

Yoshi Automation Bot