승인 필요
사용자가 액세스할 수 있는 세그먼트를 나열합니다. 지금 사용해 보거나 예를 참조하세요.
이 방법은 표준 매개변수 외에도 매개변수 표에 나열된 매개변수를 지원합니다.
요청
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 ] }
속성 이름 | 값 | 설명 | Notes |
---|---|---|---|
kind |
string |
세그먼트의 컬렉션 유형입니다. | |
username |
string |
인증된 사용자의 이메일 ID | |
totalResults |
integer |
응답의 결과 수와 관계없이 쿼리의 총 결과 수입니다. | |
startIndex |
integer |
리소스의 시작 색인으로, 기본값은 1이거나 start-index 쿼리 매개변수에 의해 지정됩니다. |
|
itemsPerPage |
integer |
반환된 실제 리소스 수와 관계없이 응답에 포함할 수 있는 최대 리소스 수 값 범위는 1~1000이며 기본값은 1, 000이거나 max-results 쿼리 매개변수로 지정됩니다. |
|
previousLink |
string |
이 세그먼트 컬렉션의 이전 페이지에 대한 링크입니다. | |
nextLink |
string |
이 세그먼트 컬렉션의 다음 페이지로 연결되는 링크입니다. | |
items[] |
list |
세그먼트 목록입니다. |
예
참고: 이 메서드에 제공되는 코드 예시가 지원되는 모든 프로그래밍 언어를 나타내는 것은 아닙니다. 지원되는 언어 목록은 클라이언트 라이브러리 페이지를 참조하세요.
2,399필리핀
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); } } } }
사용해 보기
아래의 API 탐색기를 사용하여 실시간 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요. 또는 독립형 탐색기를 사용해 보세요.