Requires authorization
Lists account-user links for a given account. Try it now or see an example.
In addition to the standard parameters, this method supports the parameters listed in the parameters table.
Request
HTTP request
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/entityUserLinks
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
accountId |
string |
Account ID to retrieve the user links for. |
Optional query parameters | ||
max-results |
integer |
The maximum number of account-user links to include in this response. |
start-index |
integer |
An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/analytics.manage.users |
https://www.googleapis.com/auth/analytics.manage.users.readonly |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "analytics#entityUserLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.accountUserLinks Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Collection type. | |
totalResults |
integer |
The total number of results for the query, regardless of the number of results in the response. | |
startIndex |
integer |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. | |
itemsPerPage |
integer |
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. | |
previousLink |
string |
Previous link for this account collection. | |
nextLink |
string |
Next link for this account collection. | |
items[] |
list |
A list of entity user links. |
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
/* * Note: This code assumes you have an authorized Analytics service object. * See the User Permissions Developer Guide for details. */ /* * Example #1: * This request lists all Account User Links for the authorized user. */ try { EntityUserLinks accountLinks = analytics.management(). accountUserLinks().list("123456").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * Example #2: * The results of the list method are stored in the accountLinks object. * The following code shows how to iterate through them. */ for (EntityUserLink accountUserLink : accountLinks.getItems()) { Entity entity = accountUserLink.getEntity(); AccountRef accountRef = entity.getAccountRef(); UserRef userRef = accountUserLink.getUserRef(); Permissions permissions = accountUserLink.getPermissions(); System.out.println("Account User Link Id: " + accountUserLink.getId()); System.out.println("Account User Link kind: " + userRef.getKind()); System.out.println("User Email: " + userRef.getEmail()); System.out.println("Permissions effective: " + permissions.getEffective()); System.out.println("Permissions local: " + permissions.getLocal()); System.out.println("Account Id: " + accountRef.getId()); System.out.println("Account Kind: " + accountRef.getKind()); System.out.println("Account Name: " + accountRef.getName()); }
PHP
Uses the PHP client library.
/** * Note: This code assumes you have an authorized Analytics service object. * See the User Permissions Developer Guide for details. */ /** * Example #1: * Requests a list of all account user links for the authorized user. */ try { $accountUserlinks = $analytics->management_accountUserLinks ->listManagementAccountUserLinks('123456'); } catch (apiServiceException $e) { print 'There was an Analytics API service error ' . $e->getCode() . ':' . $e->getMessage(); } catch (apiException $e) { print 'There was a general API error ' . $e->getCode() . ':' . $e->getMessage(); } /** * Example #2: * The results of the list method are stored in the accountUserlinks object. * The following code shows how to iterate through them. */ foreach ($accountUserlinks->getItems() as $accountUserLink) { $entity = $accountUserLink->getEntity(); $accountRef = $entity->getAccountRef(); $userRef = $accountUserLink->getUserRef(); $permissions = $accountUserLink->getPermissions(); $html = <<<HTML <pre> Account user link id = {$accountUserLink->getId()} Account user link kind = {$accountUserLink->getKind()} Account id = {$accountRef->getId()} Account name = {$accountRef->getName()} Account kind = {$accountRef->getKind()} Permissions local = {$permissions->getLocal()} Permissions effective = {$permissions->getEffective()} User id = {$userRef->getId()} User kind = {$userRef->getKind()} user email = {$userRef->getEmail()} </pre> HTML; print $html; }
Python
Uses the Python client library.
# Note: This code assumes you have an authorized Analytics service object. # See the User Permissions Developer Guide for details. # Example #1: # Requests a list of all account-user links for the authorized user. try: account_links = analytics.management().accountUserLinks().list( accountId='123456' ).execute() except TypeError, error: # Handle errors in constructing a query. print 'There was an error in constructing your query : %s' % error except HttpError, error: # Handle API errors. print ('There was an API error : %s : %s' % (error.resp.status, error.resp.reason)) # Example #2: # The results of the list method are stored in the account_links object. # The following code shows how to iterate through them. for accountUserLink in account_links.get('items', []): entity = accountUserLink.get('entity', {}) accountRef = entity.get('accountRef', {}) userRef = accountUserLink.get('userRef', {}) permissions = accountUserLink.get('permissions', {}) print 'Account User Link Id = %s' % accountUserLink.get('id') print 'Account User Link kind = %s' % accountUserLink.get('kind') print 'User Email = %s' % userRef.get('email') print 'Permissions effective = %s' % permissions.get('effective') print 'Permissions local = %s' % permissions.get('local') print 'Account Id = %s' % accountRef.get('id') print 'Account Kind = %s' % accountRef.get('kind') print 'Account Name = %s\n' % accountRef.get('name')
JavaScript
Uses the JavaScript client library.
/* * Note: This code assumes you have an authorized Analytics client object. * See the User Permissions Developer Guide for details. */ /* * Example 1: * Requests a list of all Account User links for the authorized user. */ function listAccountUserLinks() { var request = gapi.client.analytics.management.accountUserLinks.list({ 'accountId': '123456' }); request.execute(printAccountUserLinks); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printAccountUserLinks(results) { if (results && !results.error) { var accountLinks = results.items; for (var i = 0, accountUserLink; accountUserLink = accountLinks[i]; i++) { var entity = accountUserLink.entity; var accountRef = entity.accountRef; var userRef = accountUserLink.userRef; var permissions = accountUserLink.permissions; console.log('Account User Link Id: ' + accountUserLink.id); console.log('Account User Link Kind: ' + accountUserLink.kind); console.log('User Email: ' + userRef.email); console.log('Permissions effective: ' + permissions.effective); console.log('Permissions local: ' + permissions.local); console.log('Account Id: ' + accountRef.id); console.log('Account Kind: ' + accountRef.kind); console.log('Account Name: ' + accountRef.name); } } }
Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.