需要授權
要求
HTTP 要求
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
accountId |
string |
要擷取的自訂維度的帳戶 ID。 |
webPropertyId |
string |
要擷取自訂維度的網站資源 ID。 |
自選查詢參數 | ||
max-results |
integer |
要加進此回應的自訂維度數量上限。 |
start-index |
integer |
要擷取的第一個實體的索引。將此參數與 max-results 參數搭配使用。 |
授權
這項要求至少需要以下其中一個範圍的授權 (進一步瞭解驗證和授權)。
範圍 |
---|
https://www.googleapis.com/auth/analytics.readonly |
https://www.googleapis.com/auth/analytics |
要求主體
請勿使用這個方法提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "analytics#customDimensions", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customDimensions Resource ] }
屬性名稱 | 值 | 說明 | 附註 |
---|---|---|---|
kind |
string |
系列作品類型。 | |
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. */ /** * This request lists all custom dimensions for the authorized user. */ try { CustomDimensions dimensions = analytics.management.customDimensions .list("12345", "UA-12345-1").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * The results of the list method are stored in the dimensions object. * The following code shows how to iterate through them. */ for (CustomDimension dimension : dimensions.getItems()) { System.out.println("Dimension Kind: " + dimension.getKind()); System.out.println("Dimension Id: " + dimension.getId()); System.out.println("Account ID: " + dimension.getAccountId()); System.out.println("Property ID: " + dimension.getWebPropertyId()); System.out.println("Dimension Name: " + dimension.getName()); System.out.println("Dimension Index: " + dimension.getIndex()); System.out.println("Dimension Scope: " + dimension.getScope()); System.out.println("Dimension Active: " + dimension.getActive()); System.out.println("Dimension Created: " + dimension.getCreated()); System.out.println("Dimension Updated: " + dimension.getUpdated()); }
Python
使用 Python 用戶端程式庫。
# Note: This code assumes you have an authorized Analytics service object. # This request lists all custom dimensions for the authorized user. try: dimensions = analytics.management().customDimensions().list( accountId='123456', webPropertyId='UA-123456-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)) # The results of the list method are stored in the dimensions object. # The following code shows how to iterate through them. for dimension in dimensions.get('items', []): print 'Dimension Kind = %s' % dimension.get('kind') print 'Dimension Id = %s' % dimension.get('id') print 'Account ID = %s' % dimension.get('accountId') print 'Property ID = %s' % dimension.get('webPropertyId') print 'Dimension Name = %s' % dimension.get('name') print 'Dimension Index = %s' % dimension.get('index') print 'Dimension Scope = %s' % dimension.get('scope') print 'Dimension Active = %s' % dimension.get('active') print 'Dimension Created = %s' % dimension.get('created') print 'Dimension Updated = %s' % dimension.get('updated')
試試看!
您可以使用下方的 APIs Explorer,針對即時資料呼叫這個方法,然後查看回應。 或者,您也可以試試獨立的 Explorer。