Segments: list

Wymaga autoryzacji

Zawiera listę segmentów, do których użytkownik ma dostęp. Wypróbuj teraz lub zobacz przykład.

Oprócz parametrów standardowych metoda ta obsługuje parametry wymienione w tabeli parametrów.

Prośba

Żądanie HTTP

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

Parametry

Nazwa parametru Wartość Opis
Opcjonalne parametry zapytania
max-results integer Maksymalna liczba segmentów do uwzględnienia w tej odpowiedzi.
start-index integer Indeks pierwszego segmentu do pobrania. Użyj tego parametru jako mechanizmu podziału na strony razem z parametrem max-results.

Upoważnienie

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

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

Treść żądania

Nie podawaj treści żądania za pomocą tej metody.

Odpowiedź

Odpowiedź zawiera jeden zasób Segment dla każdego segmentu zaawansowanego dostępnego dla użytkownika.

{
  "kind": "analytics#segments",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.segments Resource
  ]
}
nazwa usługi, Wartość Opis Uwagi
kind string Typ zbierania segmentów.
username string Identyfikator e-mail uwierzytelnionego użytkownika.
totalResults integer Łączna liczba wyników zapytania, niezależnie od liczby wyników w odpowiedzi.
startIndex integer Początkowy indeks zasobów, który ma domyślnie wartość 1 lub jest określony przez parametr zapytania start-index.
itemsPerPage integer Maksymalna liczba zasobów, które może zawierać odpowiedź, niezależnie od rzeczywistej liczby zwróconych zasobów. Ma ona zakres od 1 do 1000 i domyślnie przyjmuje wartość 1000, ale może też być określona przez parametr zapytania max-results.
items[] list Lista segmentów.

Przykłady

Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.

PHP

Wykorzystuje bibliotekę klienta 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

Używa biblioteki klienta Pythona.

# 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

Używa biblioteki klienta 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);
      }
    }
  }
}

Wypróbuj

Użyj eksploratora interfejsów API poniżej, aby wywołać tę metodę na aktywnych danych i zobaczyć odpowiedź. Możesz też wypróbować samodzielny eksplorator.