John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p> |
John Asmuth | 614db98 | 2014-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 Kim | 4ed7d3f | 2020-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 Asmuth | 614db98 | 2014-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#update">update(accountId, webPropertyId, profileId, linkId, body=None)</a></code></p> |
John Asmuth | 614db98 | 2014-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 | |
| 94 | Args: |
| 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 103 | <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 104 | <pre>Adds a new user to the given view (profile). |
| 105 | |
| 106 | Args: |
| 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | body: object, The request body. |
John Asmuth | 614db98 | 2014-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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 114 | "id": "A String", # Entity user link ID |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "kind": "analytics#entityUserLink", # Resource type for entity user link. |
| 116 | "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). |
| 117 | "accountRef": { # JSON template for a linked account. # Account for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | "id": "A String", # Account ID. |
| 119 | "href": "A String", # Link for this account. |
| 120 | "name": "A String", # Account name. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 121 | "kind": "analytics#accountRef", # Analytics account reference. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 122 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 125 | "href": "A String", # Link for this web property. |
| 126 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 127 | "kind": "analytics#webPropertyRef", # Analytics web property reference. |
| 128 | "name": "A String", # Name of this web property. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 129 | "accountId": "A String", # Account ID to which this web property belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 130 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "name": "A String", # Name of this view (profile). |
| 133 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 134 | "id": "A String", # View (Profile) ID. |
| 135 | "href": "A String", # Link for this view (profile). |
| 136 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 137 | "kind": "analytics#profileRef", # Analytics view (profile) reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 138 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 139 | }, |
| 140 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "permissions": { # Permissions the user has for this entity. |
| 142 | "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. |
| 143 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 144 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. |
| 146 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 147 | ], |
| 148 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | "userRef": { # JSON template for a user reference. # User reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 150 | "id": "A String", # User ID. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | "email": "A String", # Email ID of this user. |
| 152 | "kind": "analytics#userRef", |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | }, |
| 154 | "selfLink": "A String", # Self link for this resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | |
| 158 | Returns: |
| 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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 162 | "id": "A String", # Entity user link ID |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 163 | "kind": "analytics#entityUserLink", # Resource type for entity user link. |
| 164 | "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). |
| 165 | "accountRef": { # JSON template for a linked account. # Account for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "id": "A String", # Account ID. |
| 167 | "href": "A String", # Link for this account. |
| 168 | "name": "A String", # Account name. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 169 | "kind": "analytics#accountRef", # Analytics account reference. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 170 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 173 | "href": "A String", # Link for this web property. |
| 174 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 175 | "kind": "analytics#webPropertyRef", # Analytics web property reference. |
| 176 | "name": "A String", # Name of this web property. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 177 | "accountId": "A String", # Account ID to which this web property belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 178 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 179 | "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | "name": "A String", # Name of this view (profile). |
| 181 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 182 | "id": "A String", # View (Profile) ID. |
| 183 | "href": "A String", # Link for this view (profile). |
| 184 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 185 | "kind": "analytics#profileRef", # Analytics view (profile) reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 186 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 187 | }, |
| 188 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 189 | "permissions": { # Permissions the user has for this entity. |
| 190 | "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. |
| 191 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 192 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. |
| 194 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 195 | ], |
| 196 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 197 | "userRef": { # JSON template for a user reference. # User reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 198 | "id": "A String", # User ID. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | "email": "A String", # Email ID of this user. |
| 200 | "kind": "analytics#userRef", |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | }, |
| 202 | "selfLink": "A String", # Self link for this resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 203 | }</pre> |
| 204 | </div> |
| 205 | |
| 206 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 208 | <pre>Lists profile-user links for a given view (profile). |
| 209 | |
| 210 | Args: |
| 211 | 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] | 212 | 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) |
| 213 | 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) |
Bu Sun Kim | 6502091 | 2020-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 Kim | 4ed7d3f | 2020-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 216 | |
| 217 | Returns: |
| 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 221 | "nextLink": "A String", # Next link for this account collection. |
| 222 | "previousLink": "A String", # Previous link for this account collection. |
| 223 | "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| 224 | "items": [ # A list of entity user links. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 225 | { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 226 | "id": "A String", # Entity user link ID |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 227 | "kind": "analytics#entityUserLink", # Resource type for entity user link. |
| 228 | "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). |
| 229 | "accountRef": { # JSON template for a linked account. # Account for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 230 | "id": "A String", # Account ID. |
| 231 | "href": "A String", # Link for this account. |
| 232 | "name": "A String", # Account name. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 233 | "kind": "analytics#accountRef", # Analytics account reference. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 234 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 235 | "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 237 | "href": "A String", # Link for this web property. |
| 238 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 239 | "kind": "analytics#webPropertyRef", # Analytics web property reference. |
| 240 | "name": "A String", # Name of this web property. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 241 | "accountId": "A String", # Account ID to which this web property belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 242 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 244 | "name": "A String", # Name of this view (profile). |
| 245 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 246 | "id": "A String", # View (Profile) ID. |
| 247 | "href": "A String", # Link for this view (profile). |
| 248 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 249 | "kind": "analytics#profileRef", # Analytics view (profile) reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 250 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 251 | }, |
| 252 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | "permissions": { # Permissions the user has for this entity. |
| 254 | "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. |
| 255 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 256 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 257 | "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. |
| 258 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 259 | ], |
| 260 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "userRef": { # JSON template for a user reference. # User reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 262 | "id": "A String", # User ID. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "email": "A String", # Email ID of this user. |
| 264 | "kind": "analytics#userRef", |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | }, |
| 266 | "selfLink": "A String", # Self link for this resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 267 | }, |
| 268 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 269 | "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. |
| 270 | "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. |
| 271 | "kind": "analytics#entityUserLinks", # Collection type. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 272 | }</pre> |
| 273 | </div> |
| 274 | |
| 275 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 276 | <code class="details" id="update">update(accountId, webPropertyId, profileId, linkId, body=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 277 | <pre>Updates permissions for an existing user on the given view (profile). |
| 278 | |
| 279 | Args: |
| 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 284 | body: object, The request body. |
John Asmuth | 614db98 | 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. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 288 | "id": "A String", # Entity user link ID |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 289 | "kind": "analytics#entityUserLink", # Resource type for entity user link. |
| 290 | "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). |
| 291 | "accountRef": { # JSON template for a linked account. # Account for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 292 | "id": "A String", # Account ID. |
| 293 | "href": "A String", # Link for this account. |
| 294 | "name": "A String", # Account name. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 295 | "kind": "analytics#accountRef", # Analytics account reference. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 296 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 297 | "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 299 | "href": "A String", # Link for this web property. |
| 300 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 301 | "kind": "analytics#webPropertyRef", # Analytics web property reference. |
| 302 | "name": "A String", # Name of this web property. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 303 | "accountId": "A String", # Account ID to which this web property belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 304 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 306 | "name": "A String", # Name of this view (profile). |
| 307 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 308 | "id": "A String", # View (Profile) ID. |
| 309 | "href": "A String", # Link for this view (profile). |
| 310 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 311 | "kind": "analytics#profileRef", # Analytics view (profile) reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 312 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 313 | }, |
| 314 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 315 | "permissions": { # Permissions the user has for this entity. |
| 316 | "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. |
| 317 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 318 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 319 | "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. |
| 320 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 321 | ], |
| 322 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 323 | "userRef": { # JSON template for a user reference. # User reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 324 | "id": "A String", # User ID. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 325 | "email": "A String", # Email ID of this user. |
| 326 | "kind": "analytics#userRef", |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 327 | }, |
| 328 | "selfLink": "A String", # Self link for this resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 329 | } |
| 330 | |
| 331 | |
| 332 | Returns: |
| 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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 336 | "id": "A String", # Entity user link ID |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | "kind": "analytics#entityUserLink", # Resource type for entity user link. |
| 338 | "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). |
| 339 | "accountRef": { # JSON template for a linked account. # Account for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 340 | "id": "A String", # Account ID. |
| 341 | "href": "A String", # Link for this account. |
| 342 | "name": "A String", # Account name. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 343 | "kind": "analytics#accountRef", # Analytics account reference. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 344 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 345 | "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 346 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 347 | "href": "A String", # Link for this web property. |
| 348 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 349 | "kind": "analytics#webPropertyRef", # Analytics web property reference. |
| 350 | "name": "A String", # Name of this web property. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 351 | "accountId": "A String", # Account ID to which this web property belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 352 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 353 | "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | "name": "A String", # Name of this view (profile). |
| 355 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 356 | "id": "A String", # View (Profile) ID. |
| 357 | "href": "A String", # Link for this view (profile). |
| 358 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 359 | "kind": "analytics#profileRef", # Analytics view (profile) reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 360 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 361 | }, |
| 362 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 363 | "permissions": { # Permissions the user has for this entity. |
| 364 | "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. |
| 365 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 366 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. |
| 368 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 369 | ], |
| 370 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 371 | "userRef": { # JSON template for a user reference. # User reference. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 372 | "id": "A String", # User ID. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | "email": "A String", # Email ID of this user. |
| 374 | "kind": "analytics#userRef", |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | }, |
| 376 | "selfLink": "A String", # Self link for this resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 377 | }</pre> |
| 378 | </div> |
| 379 | |
| 380 | </body></html> |