Segments: list

अनुमति देना ज़रूरी है

उन सेगमेंट की सूची बनाता है जिनका ऐक्सेस उपयोगकर्ताओं के पास है. इसे अभी आज़माएं या उदाहरण देखें.

यह तरीका स्टैंडर्ड पैरामीटर के अलावा, पैरामीटर टेबल में दिए गए पैरामीटर के साथ भी काम करता है.

अनुरोध करें

एचटीटीपी अनुरोध

GET https://www.googleapis.com/analytics/v3/management/segments

पैरामीटर

पैरामीटर का नाम वैल्यू जानकारी
क्वेरी के वैकल्पिक पैरामीटर
max-results integer इस जवाब में शामिल सेगमेंट की ज़्यादा से ज़्यादा संख्या.
start-index integer वापस पाने के लिए पहले सेगमेंट का इंडेक्स. इस पैरामीटर का इस्तेमाल, ज़्यादा से ज़्यादा नतीजों वाले पैरामीटर के साथ-साथ, पेजों को क्रम में लगाने के तरीके के तौर पर करें.

अनुमति देना

इस अनुरोध के लिए, इनमें से कम से कम किसी एक दायरे की अनुमति ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).

अनुमति देने का
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 रिसॉर्स का शुरुआती इंडेक्स. यह डिफ़ॉल्ट रूप से एक है या start-index क्वेरी पैरामीटर से तय होता है.
itemsPerPage integer जवाब की संख्या ज़्यादा से ज़्यादा इतने संसाधन हो सकते हैं कि रिस्पॉन्स में कितने संसाधन शामिल हैं. इसकी वैल्यू 1 से 1,000 के बीच होती है. इसमें डिफ़ॉल्ट रूप से 1,000 की वैल्यू होती है. इसके अलावा, max-results क्वेरी पैरामीटर से तय की जा सकती है.
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);
      }
    }
  }
}

इसे आज़माएं!

इस तरीके को लाइव डेटा पर कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें. इसके अलावा, स्टैंडअलोन एक्सप्लोरर आज़माकर देखें.