需要授权
除了标准参数之外,此方法还支持参数表中列出的参数。
请求
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
使用 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); } } } }
试试看!
请使用下面的 API Explorer 对实际数据调用此方法,并查看响应。或者,您也可以尝试使用独立的 Explorer。