Method: properties.getMetadata

Hiermit werden Metadaten für Dimensionen und Messwerte zurückgegeben, die in Berichtsmethoden verfügbar sind. Wird verwendet, um die Dimensionen und Messwerte zu untersuchen. Bei dieser Methode wird in der Anfrage eine Google Analytics-Property-ID angegeben. Die Metadatenantwort enthält benutzerdefinierte Dimensionen und Messwerte sowie universelle Metadaten.

Wenn beispielsweise ein benutzerdefinierter Messwert mit dem Parameternamen levels_unlocked für eine Property registriert ist, enthält die Metadatenantwort customEvent:levels_unlocked. Universelle Metadaten sind Dimensionen und Messwerte, die für alle Properties wie country und totalUsers gelten.

HTTP-Anfrage

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname der abzurufenden Metadaten. Dieses Namensfeld wird im URL-Pfad und nicht in URL-Parametern angegeben. Property ist eine numerische Kennung für eine Google Analytics-Property. Weitere Informationen finden Sie unter Property-ID ermitteln.

Beispiel: properties/1234/metadata

Legen Sie für Dimensionen und Messwerte, die für alle Properties gelten, die Property-ID auf „0“ fest. In diesem speziellen Modus gibt diese Methode keine benutzerdefinierten Dimensionen und Messwerte zurück.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Dimensionen, Messwerte und Vergleiche, die derzeit in Berichtsmethoden zulässig sind.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
Felder
name

string

Ressourcenname dieser Metadaten.
dimensions[]

object (DimensionMetadata)

Die Dimensionenbeschreibungen.
metrics[]

object (MetricMetadata)

Die Messwertbeschreibungen.
comparisons[]

object (ComparisonMetadata)

Die Vergleichsbeschreibungen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ComparisonMetadata

Die Metadaten für einen einzelnen Vergleich.

JSON-Darstellung 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Felder
apiName

string

Der Ressourcenname dieses Vergleichs. Kann im Feld comparison des Vergleichs verwendet werden. Beispiel: „comparisons/1234“.
uiName

string

Der Name dieses Vergleichs in der Google Analytics-Benutzeroberfläche.
description

string

Die Beschreibung dieses Vergleichs.