Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / analytics_v3.management.profileUserLinks.html
blob: d459e79dc062a36c435465e449a11cb914b82f2a [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.profileUserLinks.html">profileUserLinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(accountId, webPropertyId, profileId, linkId)</a></code></p>
79<p class="firstline">Removes a user from the given view (profile).</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, profileId, 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 view (profile).</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, profileId, max_results=None, start_index=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Lists profile-user links for a given view (profile).</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, profileId, 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 view (profile).</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(accountId, webPropertyId, profileId, linkId)</code>
92 <pre>Removes a user from the given view (profile).
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 profileId: string, View (Profile) ID to delete the user link for. (required)
98 linkId: string, Link ID to delete the user link for. (required)
99</pre>
100</div>
101
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104 <pre>Adds a new user to the given view (profile).
105
106Args:
107 accountId: string, Account ID to create the user link for. (required)
108 webPropertyId: string, Web Property ID to create the user link for. (required)
109 profileId: string, View (Profile) ID to create the user link for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 The object takes the form of:
112
113{ # 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]114 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
116 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]118 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]119 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
120 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &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]123 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]124 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
125 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
126 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]127 &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^]128 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &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]131 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]132 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]134 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
135 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
136 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]137 &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]138 },
139 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]141 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
143 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]145 &quot;permissions&quot;: { # Permissions the user has for this entity.
146 &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.
147 &quot;A String&quot;,
148 ],
149 &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.
150 &quot;A String&quot;,
151 ],
152 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]154 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 }
156
157
158Returns:
159 An object of the form:
160
161 { # 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]162 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
164 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]166 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]167 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
168 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &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]171 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]172 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
173 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
174 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]175 &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^]176 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 &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]179 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]180 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]182 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
183 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
184 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]185 &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]186 },
187 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
191 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]193 &quot;permissions&quot;: { # Permissions the user has for this entity.
194 &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.
195 &quot;A String&quot;,
196 ],
197 &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.
198 &quot;A String&quot;,
199 ],
200 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]202 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203 }</pre>
204</div>
205
206<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]207 <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 <pre>Lists profile-user links for a given view (profile).
209
210Args:
211 accountId: string, Account ID which the given view (profile) belongs to. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]212 webPropertyId: string, Web Property ID which the given view (profile) belongs to. 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)
213 profileId: string, View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or &#x27;~all&#x27;, which refers to all the profiles that user has access to. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 max_results: integer, The maximum number of profile-user links to include in this response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]215 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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]216
217Returns:
218 An object of the form:
219
220 { # 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]221 &quot;items&quot;: [ # A list of entity user links.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 { # 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]223 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
225 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]227 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]228 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
229 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]230 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &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]232 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]233 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
234 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
235 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]236 &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^]237 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 &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]240 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]241 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]243 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
244 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
245 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]246 &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]247 },
248 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]250 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
252 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]254 &quot;permissions&quot;: { # Permissions the user has for this entity.
255 &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.
256 &quot;A String&quot;,
257 ],
258 &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.
259 &quot;A String&quot;,
260 ],
261 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]263 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]264 },
265 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]266 &quot;startIndex&quot;: 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
267 &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^]268 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
269 &quot;previousLink&quot;: &quot;A String&quot;, # Previous link for this account collection.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]270 &quot;kind&quot;: &quot;analytics#entityUserLinks&quot;, # Collection type.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]271 &quot;nextLink&quot;: &quot;A String&quot;, # Next link for this account collection.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 }</pre>
273</div>
274
275<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]276 <code class="details" id="update">update(accountId, webPropertyId, profileId, linkId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 <pre>Updates permissions for an existing user on the given view (profile).
278
279Args:
280 accountId: string, Account ID to update the user link for. (required)
281 webPropertyId: string, Web Property ID to update the user link for. (required)
282 profileId: string, View (Profile ID) to update the user link for. (required)
283 linkId: string, Link ID to update the user link for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]284 body: object, The request body.
John Asmuth614db982014-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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]288 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
290 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]292 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]293 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
294 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]295 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &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]297 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]298 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
299 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
300 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]301 &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^]302 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]303 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]304 &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]305 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]306 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]308 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
309 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
310 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]311 &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]312 },
313 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]314 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]315 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]316 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
317 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]318 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]319 &quot;permissions&quot;: { # Permissions the user has for this entity.
320 &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.
321 &quot;A String&quot;,
322 ],
323 &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.
324 &quot;A String&quot;,
325 ],
326 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]327 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]328 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 }
330
331
332Returns:
333 An object of the form:
334
335 { # 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]336 &quot;id&quot;: &quot;A String&quot;, # Entity user link ID
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]337 &quot;entity&quot;: { # Entity for this link. It can be an account, a web property, or a view (profile).
338 &quot;accountRef&quot;: { # JSON template for a linked account. # Account for this link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]339 &quot;name&quot;: &quot;A String&quot;, # Account name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]340 &quot;kind&quot;: &quot;analytics#accountRef&quot;, # Analytics account reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]341 &quot;href&quot;: &quot;A String&quot;, # Link for this account.
342 &quot;id&quot;: &quot;A String&quot;, # Account ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]343 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]344 &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]345 &quot;name&quot;: &quot;A String&quot;, # Name of this web property.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]346 &quot;id&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY.
347 &quot;kind&quot;: &quot;analytics#webPropertyRef&quot;, # Analytics web property reference.
348 &quot;href&quot;: &quot;A String&quot;, # Link for this web property.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]349 &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^]350 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]351 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 &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]353 &quot;id&quot;: &quot;A String&quot;, # View (Profile) ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]354 &quot;name&quot;: &quot;A String&quot;, # Name of this view (profile).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]355 &quot;kind&quot;: &quot;analytics#profileRef&quot;, # Analytics view (profile) reference.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]356 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
357 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
358 &quot;href&quot;: &quot;A String&quot;, # Link for this view (profile).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]359 &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]360 },
361 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]362 &quot;userRef&quot;: { # JSON template for a user reference. # User reference.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]363 &quot;id&quot;: &quot;A String&quot;, # User ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]364 &quot;email&quot;: &quot;A String&quot;, # Email ID of this user.
365 &quot;kind&quot;: &quot;analytics#userRef&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]366 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]367 &quot;permissions&quot;: { # Permissions the user has for this entity.
368 &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.
369 &quot;A String&quot;,
370 ],
371 &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.
372 &quot;A String&quot;,
373 ],
374 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]375 &quot;selfLink&quot;: &quot;A String&quot;, # Self link for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]376 &quot;kind&quot;: &quot;analytics#entityUserLink&quot;, # Resource type for entity user link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]377 }</pre>
378</div>
379
380</body></html>