Segments: list

Autorisierung erforderlich

Listet Segmente auf, auf die der Nutzer Zugriff hat. Probieren Sie es gleich aus oder sehen Sie sich ein Beispiel an.

Bei dieser Methode werden zusätzlich zu den Standardparametern die in der Parametertabelle aufgeführten Parameter unterstützt.

Anfragen

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Optionale Abfrageparameter
max-results integer Die maximale Anzahl von Segmenten, die in diese Antwort aufgenommen werden sollen.
start-index integer Ein Index des ersten abzurufenden Segments. Verwenden Sie diesen Parameter als Paginierungsmechanismus zusammen mit dem Parameter „max-results“.

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Bereich
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Die Antwort enthält eine Segmentressource für jedes erweiterte Segment, das dem Nutzer zur Verfügung steht.

{
  "kind": "analytics#segments",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.segments Resource
  ]
}
Property-Name Wert Beschreibung Hinweise
kind string Sammlungstyp für Segmente.
username string E-Mail-ID des authentifizierten Nutzers
totalResults integer Die Gesamtzahl der Ergebnisse für die Abfrage, unabhängig von der Anzahl der Ergebnisse in der Antwort.
startIndex integer Der Startindex der Ressourcen, der standardmäßig 1 ist oder anderweitig durch den Abfrageparameter start-index angegeben wird.
itemsPerPage integer Die maximale Anzahl von Ressourcen, die die Antwort enthalten kann, unabhängig von der tatsächlichen Anzahl der zurückgegebenen Ressourcen. Der Wert reicht von 1 bis 1.000, wobei der Wert standardmäßig 1.000 ist oder anderweitig durch den Abfrageparameter max-results angegeben wird.
items[] list Eine Liste mit Segmenten.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

PHP

Verwendet die PHP-Clientbibliothek.

/**
 * 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

Verwendet die Python-Clientbibliothek.

# 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

Es wird die JavaScript-Clientbibliothek verwendet.

/*
 * 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);
      }
    }
  }
}

Jetzt testen

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen. Probieren Sie alternativ den eigenständigen Explorer aus.