Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / analytics_v3.management.webpropertyUserLinks.html
blob: e4e59609315dd62a41184d0839c96f3bb33be8b1 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.webpropertyUserLinks.html">webpropertyUserLinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(accountId, webPropertyId, linkId)</a></code></p>
79<p class="firstline">Removes a user from the given web property.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Adds a new user to the given web property.</p>
83<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]84 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Lists webProperty-user links for a given web property.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#update">update(accountId, webPropertyId, linkId, body=None)</a></code></p>
John Asmuth614db982014-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<div class="method">
91 <code class="details" id="delete">delete(accountId, webPropertyId, linkId)</code>
92 <pre>Removes a user from the given web property.
93
94Args:
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)
98</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103 <pre>Adds a new user to the given web property.
104
105Args:
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'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 body: object, The request body.
John Asmuth614db982014-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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]112 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
114 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]116 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
118 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;webPropertyRef&quot;: { # JSON template for a web property reference. # Web property for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
123 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
124 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]125 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this web property belongs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;profileRef&quot;: { # JSON template for a linked view (profile). # View (Profile) for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]130 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]132 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
133 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
134 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]135 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 },
137 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]139 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
141 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;permissions&quot;: { # Permissions the user has for this entity.
144 &quot;local&quot;: [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
145 &quot;A String&quot;,
146 ],
147 &quot;effective&quot;: [ # 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.
148 &quot;A String&quot;,
149 ],
150 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]152 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 }
154
155
156Returns:
157 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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
162 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]164 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]165 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
166 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;webPropertyRef&quot;: { # JSON template for a web property reference. # Web property for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]170 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
171 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
172 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]173 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this web property belongs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]174 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;profileRef&quot;: { # JSON template for a linked view (profile). # View (Profile) for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]178 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]180 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
181 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
182 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]183 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]184 },
185 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]187 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
189 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]191 &quot;permissions&quot;: { # Permissions the user has for this entity.
192 &quot;local&quot;: [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
193 &quot;A String&quot;,
194 ],
195 &quot;effective&quot;: [ # 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.
196 &quot;A String&quot;,
197 ],
198 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 }</pre>
202</div>
203
204<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]205 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 <pre>Lists webProperty-user links for a given web property.
207
208Args:
209 accountId: string, Account ID which the given web property belongs to. (required)
Bu Sun Kim65020912020-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 &#x27;~all&#x27;, which refers to all the web properties that user has access to. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 max_results: integer, The maximum number of webProperty-user Links to include in this response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]212 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213
214Returns:
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 &quot;items&quot;: [ # A list of entity user links.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]219 { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]220 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
222 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]224 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
226 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]227 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 &quot;webPropertyRef&quot;: { # JSON template for a web property reference. # Web property for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]230 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
231 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
232 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]233 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this web property belongs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]234 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]235 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 &quot;profileRef&quot;: { # JSON template for a linked view (profile). # View (Profile) for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]237 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]240 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
241 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
242 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]243 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 },
245 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]246 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]247 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]248 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
249 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]251 &quot;permissions&quot;: { # Permissions the user has for this entity.
252 &quot;local&quot;: [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
253 &quot;A String&quot;,
254 ],
255 &quot;effective&quot;: [ # 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.
256 &quot;A String&quot;,
257 ],
258 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]259 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]260 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]261 },
262 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]263 &quot;startIndex&quot;: 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
264 &quot;itemsPerPage&quot;: 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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]265 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
266 &quot;previousLink&quot;: &quot;A String&quot;, # Previous link for this account collection.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]267 &quot;kind&quot;: &quot;analytics#entityUserLinks&quot;, # Collection type.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 &quot;nextLink&quot;: &quot;A String&quot;, # Next link for this account collection.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]269 }</pre>
270</div>
271
272<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]273 <code class="details" id="update">update(accountId, webPropertyId, linkId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 <pre>Updates permissions for an existing user on the given web property.
275
276Args:
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'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]280 body: object, The request body.
John Asmuth614db982014-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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]284 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]285 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
286 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]288 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]289 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
290 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]292 &quot;webPropertyRef&quot;: { # JSON template for a web property reference. # Web property for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]293 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]294 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
295 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
296 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]297 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this web property belongs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]298 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]299 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]300 &quot;profileRef&quot;: { # JSON template for a linked view (profile). # View (Profile) for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]302 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]304 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
305 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
306 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]307 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]308 },
309 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]311 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]312 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
313 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]314 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]315 &quot;permissions&quot;: { # Permissions the user has for this entity.
316 &quot;local&quot;: [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
317 &quot;A String&quot;,
318 ],
319 &quot;effective&quot;: [ # 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.
320 &quot;A String&quot;,
321 ],
322 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]323 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]324 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 }
326
327
328Returns:
329 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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]332 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]333 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
334 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]336 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]337 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
338 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]339 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]340 &quot;webPropertyRef&quot;: { # JSON template for a web property reference. # Web property for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]341 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]342 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
343 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
344 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]345 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this web property belongs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]346 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]348 &quot;profileRef&quot;: { # JSON template for a linked view (profile). # View (Profile) for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]349 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]350 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]351 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]352 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
353 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
354 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]355 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]356 },
357 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]358 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]359 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]360 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
361 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]362 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]363 &quot;permissions&quot;: { # Permissions the user has for this entity.
364 &quot;local&quot;: [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
365 &quot;A String&quot;,
366 ],
367 &quot;effective&quot;: [ # 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.
368 &quot;A String&quot;,
369 ],
370 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]371 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]372 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]373 }</pre>
374</div>
375
376</body></html>