Method: properties.getMetadata

Gibt Metadaten für Dimensionen und Messwerte zurück, die in Berichtsmethoden verfügbar sind. Damit lassen sich Dimensionen und Messwerte untersuchen. Bei dieser Methode wird in der Anfrage eine Google Analytics-GA4-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 ein Attribut registriert ist, enthält die Metadatenantwort customEvent:levels_unlocked. Universelle Metadaten sind Dimensionen und Messwerte, die für jede Property 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 im URL-Parameter angegeben. Die Property ist eine numerische GA4-Property-ID für Google Analytics. Weitere Informationen dazu, wo Sie die Property-ID finden

Beispiel: properties/1234/metadata

Legen Sie die Property-ID für Dimensionen und Messwerte, die für alle Properties gelten, 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 derzeit in Berichtsmethoden akzeptierten Dimensionen, Messwerte und Vergleiche

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

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

string

Ressourcenname dieser Metadaten.
dimensions[]

object (DimensionMetadata)

Die Dimensionsbeschreibungen
metrics[]

object (MetricMetadata)

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. Verwendbar im Feld comparison von Comparison. Beispiel: „vergleiche/1234“.
uiName

string

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

string

Die Beschreibung dieses Vergleichs.