Требуется авторизация
Перечисляет сегменты, к которым у пользователя есть доступ. Попробуйте сейчас или посмотрите пример .
Помимо стандартных параметров , этот метод поддерживает параметры, перечисленные в таблице параметров.
Запрос
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 | Идентификатор электронной почты аутентифицированного пользователя | |
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 .
# 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-обозреватель ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ. Альтернативно попробуйте автономный Проводник .