Custom Metrics: list

Wymaga autoryzacji

Wyświetla listę danych niestandardowych, do których użytkownik ma dostęp. Wypróbuj teraz lub zobacz przykład.

Prośba

Żądanie HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customMetrics

Parametry

Nazwa parametru	Wartość	Opis
Parametry ścieżki
accountId	string	Identyfikator konta na potrzeby danych niestandardowych do pobrania.
webPropertyId	string	Identyfikator usługi internetowej, do której pobierane są dane niestandardowe.
Opcjonalne parametry zapytania
max-results	integer	Maksymalna liczba wskaźników niestandardowych, które mają być uwzględnione w tej odpowiedzi.
start-index	integer	Indeks pierwszej encji 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.readonly
https://www.googleapis.com/auth/analytics

Treść żądania

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

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

{
  "kind": "analytics#customMetrics",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customMetrics Resource
  ]
}

nazwa usługi,	Wartość	Opis	Uwagi
kind	string	Typ kolekcji.
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 lub jest określona w inny sposób przez parametr zapytania „max-results”.
previousLink	string	Link do poprzedniej strony dotyczącej tej kolekcji danych niestandardowych.
nextLink	string	Link do następnej strony dotyczącej tej kolekcji danych niestandardowych.
items[]	list	Zbieranie danych niestandardowych.

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.

Java

Używa biblioteki klienta Java.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 */

/**
 * This request lists all custom metrics for the authorized user.
 */
try {
  CustomMetrics metrics = analytics.management.customMetrics
      .list("12345", "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * The results of the list method are stored in the metrics object.
 * The following code shows how to iterate through them.
 */
for (CustomMetric metric : metrics.getItems()) {
  System.out.println("Metric Kind: " + metric.getKind());
  System.out.println("Metric Id: " + metric.getId());
  System.out.println("Account ID: " + metric.getAccountId());
  System.out.println("Property ID: " + metric.getWebPropertyId());
  System.out.println("Metric Name: " + metric.getName());
  System.out.println("Metric Index: " + metric.getIndex());
  System.out.println("Metric Scope: " + metric.getScope());
  System.out.println("Metric Active: " + metric.getActive());
  System.out.println("Metric Type: " + metric.getType());
  System.out.println("Metric Created: " + metric.getCreated());
  System.out.println("Metric Updated: " + metric.getUpdated());
}

Python

Używa biblioteki klienta Pythona.

# Note: This code assumes you have an authorized Analytics service object.

# This request lists all custom metrics for the authorized user.
try:
  metrics = analytics.management().customMetrics().list(
      accountId='123456',
      webPropertyId='UA-123456-1',
  ).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))


# The results of the list method are stored in the metrics object.
# The following code shows how to iterate through them.
for metric in metrics.get('items', []):
  print 'Metric Kind = %s' % metric.get('kind')
  print 'Metric Id = %s' % metric.get('id')
  print 'Account ID = %s' % metric.get('accountId')
  print 'Property ID = %s' % metric.get('webPropertyId')
  print 'Metric Name = %s' % metric.get('name')
  print 'Metric Index = %s' % metric.get('index')
  print 'Metric Scope = %s' % metric.get('scope')
  print 'Metric Active = %s' % metric.get('active')
  print 'Metric Type = %s' % metric.get('type')
  print 'Metric Created = %s' % metric.get('created')
  print 'Metric Updated = %s' % metric.get('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.