Yetkilendirme gerektirir
Kullanıcının erişebildiği segmentleri listeler. Hemen deneyin veya bir örneğe göz atın.
Bu yöntem, standart parametrelere ek olarak parametreler tablosunda listelenen parametreleri destekler.
İstek
HTTP isteği
GET https://www.googleapis.com/analytics/v3/management/segments
Parametreler
Parametre adı | Değer | Açıklama |
---|---|---|
İsteğe bağlı sorgu parametreleri | ||
max-results |
integer |
Bu yanıta dahil edilecek maksimum segment sayısı. |
start-index |
integer |
Alınacak ilk segmentin dizini. Bu parametreyi, max-results parametresiyle birlikte sayfalara ayırma mekanizması olarak kullanın. |
Yetkilendirme
Bu istek için aşağıdaki kapsamlardan en az biriyle yetkilendirme gerekir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
Kapsam |
---|
https://www.googleapis.com/auth/analytics |
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
İstek içeriği
Bu yöntemle bir istek gövdesi sağlamayın.
Yanıt
Yanıt, kullanıcının kullanabileceği her gelişmiş segment için bir Segment kaynağı içerir.
{ "kind": "analytics#segments", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.segments Resource ] }
Mülk adı | Değer | Açıklama | Notlar |
---|---|---|---|
kind |
string |
Segmentler için koleksiyon türü. | |
username |
string |
Kimliği doğrulanan kullanıcının e-posta kimliği | |
totalResults |
integer |
Yanıttaki sonuç sayısından bağımsız olarak sorgu için toplam sonuç sayısı. | |
startIndex |
integer |
Kaynakların başlangıç dizini (varsayılan olarak 1'dir veya start-index sorgu parametresi tarafından başka şekilde belirtilir). |
|
itemsPerPage |
integer |
Döndürülen gerçek kaynak sayısından bağımsız olarak yanıtın içerebileceği maksimum kaynak sayısı. Bu parametrenin değeri, varsayılan olarak 1.000 değeriyle veya max-results sorgu parametresiyle belirtilen 1 ile 1000 arasında değişir. |
|
previousLink |
string |
Bu segment koleksiyonu için önceki sayfanın bağlantısı. | |
nextLink |
string |
Bu segment koleksiyonu için sonraki sayfanın bağlantısı. | |
items[] |
list |
Segment listesi. |
Örnekler
Not: Bu yöntem için kullanıma sunulan kod örnekleri, desteklenen tüm programlama dillerini kapsamaz (Desteklenen dillerin listesi için istemci kitaplıkları sayfasını inceleyin).
PHP
PHP istemci kitaplığını kullanır.
/** * 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 istemci kitaplığını kullanır.
# 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 istemci kitaplığını kullanır.
/* * 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); } } } }
Deneyin.
Canlı verilerde bu yöntemi çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın. Alternatif olarak, bağımsız Gezgin'i deneyin.