需要授權
除了標準參數以外,這個方法也支援參數表格中列出的參數。
要求
HTTP 要求
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/entityUserLinks
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
accountId |
string |
要擷取使用者連結的帳戶 ID。 |
選用查詢參數 | ||
max-results |
integer |
此回應中包含的帳戶使用者連結數量上限。 |
start-index |
integer |
要擷取的第一個帳戶使用者連結的索引。請將這個參數當做分頁機制,並搭配 max-results 參數。 |
授權
這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
內容範圍 |
---|
https://www.googleapis.com/auth/analytics.manage.users |
https://www.googleapis.com/auth/analytics.manage.users.readonly |
要求主體
請勿使用這個方法提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "analytics#entityUserLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.accountUserLinks Resource ] }
屬性名稱 | 值 | 說明 | 附註 |
---|---|---|---|
kind |
string |
集合類型。 | |
totalResults |
integer |
查詢結果的總數,無論回應中的結果數量為何。 | |
startIndex |
integer |
項目的起始索引,預設為 1,或由 start-index 查詢參數指定。 | |
itemsPerPage |
integer |
回應可包含的項目數量上限,無論傳回的項目數量為何。這個函式的值範圍從 1 到 1000,且預設值為 1000,或者是由 max-results 查詢參數指定。 | |
previousLink |
string |
這個帳戶集合的上一個連結。 | |
nextLink |
string |
這個帳戶集合的下一個連結。 | |
items[] |
list |
實體使用者連結清單。 |
示例
注意:這個方法適用的程式語言眾多,我們只在此提供部分程式碼範例,完整的支援語言清單請參閱用戶端程式庫頁面。
Java
使用 Java 用戶端程式庫。
/* * 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
使用 PHP 用戶端程式庫。
/** * 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
使用 Python 用戶端程式庫。
# 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
/* * 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); } } }
試試看!
使用下方的 APIs Explorer,針對有效資料呼叫這個方法,然後查看回應。 或者,您也可以試試獨立的 Explorer。