需要授權
除了標準參數以外,這個方法也支援參數表格中列出的參數。
要求
HTTP 要求
GET https://www.googleapis.com/analytics/v3/management/segments
參數
參數名稱 | 值 | 說明 |
---|---|---|
選用查詢參數 | ||
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#segments", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.segments 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 |
區隔清單。 |
示例
注意:這個方法適用的程式語言眾多,我們只在此提供部分程式碼範例,完整的支援語言清單請參閱用戶端程式庫頁面。
PHP
使用 PHP 用戶端程式庫。
/** * Note: This code assumes you have an authorized Analytics service object. * See the Segments Developer Guide for details. */ /** * Example #1: * Requests a list of all Segments for the authorized user. */ try { $segments = $analytics->management_segments->listManagementSegments(); } 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 segments object. * The following code shows how to iterate through them. */ foreach ($segments->getItems() as $segment) { $html .= <<<HTML <pre> Segment ID = {$segment->getId()} Kind = {$segment->getKind()} Self Link = {$segment->getSelfLink()} Name = {$segment->getName()} Definition = {$segment->getDefinition()} Created = {$segment->getCreated()} Updated = {$segment->getUpdated()} </pre> HTML; print $html; }
Python
使用 Python 用戶端程式庫。
# Note: This code assumes you have an authorized Analytics service object. # See the Segments Developer Guide for details. # Example #1: # Requests a list of segments to which the user has access. try: segments = analytics.management().segments().list().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 segments object. # The following code shows how to iterate through them. for segment in segments.get('items', []): print 'Segment Id = %s' % segment.get('id') print 'Segment kind = %s' % segment.get('kind') print 'Segment segmentId = %s' % segment.get('segmentId') print 'Segment Name = %s' % segment.get('name') print 'Segment Definition = %s' % segment.get('definition') if segment.get('created'): print 'Created = %s' % segment.get('created') print 'Updated = %s' % segment.get('updated') print
JavaScript
/* * Note: This code assumes you have an authorized Analytics client object. * See the Segment Developer Guide for details. */ /* * Example 1: * Requests a list of all Segments for the authorized user. */ function listSegments() { var request = gapi.client.analytics.management.segments.list(); request.execute(printSegments); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printSegments(results) { if (results && !results.error) { var segments = results.items; for (var i = 0, segment; segment = segments[i]; i++) { console.log('Segment Id: ' + segment.id); console.log('Segment Kind: ' + segment.kind); console.log('Segment Name: ' + segment.name); console.log('Segment Definition: ' + segment.definition); // These fields are only set for custom segments and not default segments. if (segment.created) { console.log('Created: ' + segment.created); console.log('Updated: ' + segment.updated); } } } }
試試看!
使用下方的 APIs Explorer,針對有效資料呼叫這個方法,然後查看回應。 或者,您也可以試試獨立的 Explorer。