Custom Dimensions: list

Autorisierung erforderlich

Listet benutzerdefinierte Dimensionen auf, auf die der Nutzer Zugriff hat. Jetzt ausprobieren oder Beispiel ansehen

Anfragen

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Pfadparameter
accountId string Die Konto-ID für die abzurufenden benutzerdefinierten Dimensionen.
webPropertyId string Web-Property-ID für die abzurufenden benutzerdefinierten Dimensionen.
Optionale Suchparameter
max-results integer Die maximale Anzahl der benutzerdefinierten Dimensionen, die in dieser Antwort enthalten sein sollen.
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).

Umfang
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#customDimensions",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customDimensions 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 vom 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. Sein Wert reicht von 1 bis 1000, wobei der Wert standardmäßig 1000 beträgt oder anderweitig durch den Abfrageparameter "max-results" angegeben wird.
items[] list Sammlung benutzerdefinierter Dimensionen.

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 dimensions for the authorized user.
 */
try {
  CustomDimensions dimensions = analytics.management.customDimensions
      .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 dimensions object.
 * The following code shows how to iterate through them.
 */
for (CustomDimension dimension : dimensions.getItems()) {
  System.out.println("Dimension Kind: " + dimension.getKind());
  System.out.println("Dimension Id: " + dimension.getId());
  System.out.println("Account ID: " + dimension.getAccountId());
  System.out.println("Property ID: " + dimension.getWebPropertyId());
  System.out.println("Dimension Name: " + dimension.getName());
  System.out.println("Dimension Index: " + dimension.getIndex());
  System.out.println("Dimension Scope: " + dimension.getScope());
  System.out.println("Dimension Active: " + dimension.getActive());
  System.out.println("Dimension Created: " + dimension.getCreated());
  System.out.println("Dimension Updated: " + dimension.getUpdated());
}

Python

Verwendet die Python-Clientbibliothek.

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

# This request lists all custom dimensions for the authorized user.
try:
  dimensions = analytics.management().customDimensions().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 dimensions object.
# The following code shows how to iterate through them.
for dimension in dimensions.get('items', []):
  print 'Dimension Kind = %s' % dimension.get('kind')
  print 'Dimension Id = %s' % dimension.get('id')
  print 'Account ID = %s' % dimension.get('accountId')
  print 'Property ID = %s' % dimension.get('webPropertyId')
  print 'Dimension Name = %s' % dimension.get('name')
  print 'Dimension Index = %s' % dimension.get('index')
  print 'Dimension Scope = %s' % dimension.get('scope')
  print 'Dimension Active = %s' % dimension.get('active')
  print 'Dimension Created = %s' % dimension.get('created')
  print 'Dimension Updated = %s' % dimension.get('updated')

Testen!

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen. Alternativ können Sie den eigenständigen Explorer ausprobieren.