需要授權
列出使用者可以存取的資料檢視 (設定檔)。 立即試用或參閱範例。
除了標準參數以外,這個方法也支援參數表格中列出的參數。
要求
HTTP 要求
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
accountId |
string |
要擷取的資料檢視 (設定檔) 帳戶 ID。可以是特定帳戶 ID 或「~all」,代表使用者可存取的所有帳戶。 |
webPropertyId |
string |
要擷取的資料檢視 (設定檔) 的網站資源 ID。可以是特定網站資源 ID 或「~all」,代表使用者可存取的所有網站資源。 |
選用查詢參數 | ||
max-results |
integer |
要加進此回應的檢視畫面上限 (個人資料)。 |
start-index |
integer |
要擷取的第一個實體的索引。將此參數做為分頁機制和 max-results 參數使用。 |
授權
這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
內容範圍 |
---|
https://www.googleapis.com/auth/analytics |
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
要求主體
請勿使用這個方法提供要求主體。
回應
回應中會包含每個要求的設定檔資源
{ "kind": "analytics#profiles", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.profiles Resource ] }
資源名稱 | 值 | 說明 | 附註 |
---|---|---|---|
kind |
string |
集合類型。值為「analytics#profiles」。 | |
username |
string |
已驗證使用者的電子郵件 ID | |
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 View (Profile) Developer Guide for details. */ /** * Example #1: * Requests a list of views (profiles) for the authorized user. */ try { Profiles profiles = analytics.management.profiles.list("12345", "UA-12345-1").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * Example #2: * Retrieves views (profiles) for all properties of the user's account, * using a wildcard '~all' as the webpropertyId. */ Profiles profiles = analytics.management.profiles.list("12345", "~all").execute(); /** * Example #3: * The results of the list method are stored in the profiles object. * The following code shows how to iterate through them. */ for (Profile profile : profiles.getItems()) { System.out.println("Account ID: " + profile.getAccountId()); System.out.println("Property ID: " + profile.getWebPropertyId()); System.out.println("Property Internal ID: " + profile.getInternalWebPropertyId()); System.out.println("View (Profile) ID: " + profile.getId()); System.out.println("View (Profile) Name: " + profile.getName()); System.out.println("View (Profile) defaultPage: " + profile.getDefaultPage()); System.out.println("View (Profile) Exclude Query Parameters: " + profile.getExcludeQueryParameters()); System.out.println("View (Profile) Site Search Query Parameters: " + profile.getSiteSearchQueryParameters()); System.out.println("View (Profile) Site Search Category Parameters: " + profile.getSiteSearchCategoryParameters()); System.out.println("View (Profile) Currency: " + profile.getCurrency()); System.out.println("View (Profile) Timezone: " + profile.getTimezone()); System.out.println("View (Profile) Created: " + profile.getCreated()); System.out.println("View (Profile) Updated: " + profile.getUpdated()); System.out.println("View (Profile) eCommerce Tracking: " + profile.getECommerceTracking()); System.out.println("View (Profile) Enhanced eCommerce Tracking: " + profile.getEnhancedECommerceTracking()); }
PHP
使用 PHP 用戶端程式庫。
/** * Note: This code assumes you have an authorized Analytics service object. * See the View (Profile) Developer Guide for details. */ /** * Example #1: * Requests a list of views (profiles) for the authorized user. */ try { $profiles = $analytics->management_profiles ->listManagementProfiles('123456', 'UA-123456-1'); } 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: * Retrieves views (profiles) for all properties of the user's account, * using a wildcard '~all' as the webpropertyId. */ $profiles = $analytics->management_profiles ->listManagementProfiles('123456', '~all'); /** * Example #3: * The results of the list method are stored in the profiles object. * The following code shows how to iterate through them. */ foreach ($profiles->getItems() as $profile) { $html = <<<HTML <pre> Account id = {$profile->getAccountId()} Property id = {$profile->getWebPropertyId()} View (Profile) id = {$profile->getId()} View (Profile) name = {$profile->getName()} View (Profile) type = {$profile->getType()} Default page = {$profile->getDefaultPage()} Exclude query parameters = {$profile->getExcludeQueryParameters()} Site search category parameters = {$profile->getSiteSearchCategoryParameters()} Currency = {$profile->getCurrency()} Timezone = {$profile->getTimezone()} Created = {$profile->getCreated()} Updated = {$profile->getUpdated()} eCommerce tracking = {$profile->getECommerceTracking()} Enhanced eCommerce Tracking = {$profile->getEnhancedECommerceTracking()} </pre> HTML; print $html; }
Python
使用 Python 用戶端程式庫。
# Note: This code assumes you have an authorized Analytics service object. # See the View (Profile) Developer Guide for details. # Example #1: # Requests a list of views (profiles) for the authorized user. try: profiles = analytics.management().profiles().list( accountId='12345', webPropertyId='UA-12345-1').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: # Retrieves views (profiles) for all properties of the user's account, # using a wildcard '~all' as the webpropertyId. profiles = analytics.management().profiles().list(accountId='12345', webPropertyId='~all' ).execute() # Example #3: # The results of the list method are stored in the profiles object. # The following code shows how to iterate through them. for profile in profiles.get('items', []): print 'Account ID = %s' % profile.get('accountId') print 'Property ID = %s' % profile.get('webPropertyId') print 'Internal Property ID = %s' % profile.get('internalWebPropertyId') print 'View (Profile ID) = %s' % profile.get('id') print 'View (Profile) Name = %s' % profile.get('name') print 'Default Page = %s' % profile.get('defaultPage') print 'Exclude Query Parameters = %s' % profile.get( 'excludeQueryParameters') print 'Site Search Category Parameters = %s' % profile.get( 'siteSearchCategoryParameters') print 'Site Search Query Parameters = %s' % profile.get( 'siteSearchQueryParameters') print 'Currency = %s' % profile.get('currency') print 'Timezone = %s' % profile.get('timezone') print 'Created = %s' % profile.get('created') print 'Updated = %s' % profile.get('updated') print 'eCommerce Tracking = %s' % profile.get('eCommerceTracking') print 'Enhanced eCommerce Tracking = %s' % profile.get( 'enhancedECommerceTracking')
JavaScript
/* * Note: This code assumes you have an authorized Analytics client object. * See the View (Profiles) Developer Guide for details. */ /* * Example 1: * Requests a list of all View (Profiles) for the authorized user. */ function listViews() { var request = gapi.client.analytics.management.profiles.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1' }); request.execute(printViews); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printViews(results) { if (results && !results.error) { var profiles = results.items; for (var i = 0, profile; profile = profiles[i]; i++) { console.log('Account Id: ' + profile.accountId); console.log('Property Id: ' + profile.webPropertyId); console.log('Internal Property Id: ' + profile.internalWebPropertyId); console.log('View (Profile) Id: ' + profile.id); console.log('View (Profile) Name: ' + profile.name); console.log('Default Page: ' + profile.defaultPage); console.log('Exclude Query Parameters: ' + profile.excludeQueryParameters); console.log('Site Search Category Parameters' + profile.siteSearchCategoryParameters); console.log('Site Search Query Parameters: ' + profile.siteSearchQueryParameters); console.log('Currency: ' + profile.currency); console.log('Timezone: ' + profile.timezone); console.log('Created: ' + profile.created); console.log('Updated: ' + profile.updated); } } }
試試看!
使用下方的 APIs Explorer,針對有效資料呼叫這個方法,然後查看回應。 或者,您也可以試試獨立的 Explorer。