Custom Metrics: list

Autorisierung erforderlich

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

Anfragen

HTTP-Anfrage

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

Parameter

Parametername	Wert	Beschreibung
Pfadparameter
accountId	string	Konto-ID für die abzurufenden benutzerdefinierten Messwerte.
webPropertyId	string	Web-Property-ID für die abzurufenden benutzerdefinierten Messwerte.
Optionale Abfrageparameter
max-results	integer	Die maximale Anzahl von benutzerdefinierten Messwerten, die in dieser Antwort enthalten sein können.
start-index	integer	Ein Index der ersten abzurufenden Entität. 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.readonly
https://www.googleapis.com/auth/analytics

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

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

Name der Eigenschaft	Wert	Beschreibung	Hinweise
kind	string	Sammlungstyp.
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 Startindex-Abfrageparameter 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. Der Wert ist standardmäßig 1.000 oder wird über den Abfrageparameter „max-results“ festgelegt.
previousLink	string	Link zur vorherigen Seite für diese Sammlung von benutzerdefinierten Messwerten.
nextLink	string	Link zur nächsten Seite für diese Sammlung von benutzerdefinierten Messwerten.
items[]	list	Sammlung benutzerdefinierter Messwerte.

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.

Java

Verwendet die Java-Clientbibliothek.

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

Verwendet die Python-Clientbibliothek.

# 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')

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.