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 alle Properties wie country und totalUsers anwendbar sind.

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 in Google Analytics. Weitere Informationen zum Ermitteln der Property-ID

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

Dimensionen, Messwerte und Vergleiche, die derzeit in Berichtsmethoden akzeptiert werden

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

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

string

Ressourcenname dieser Metadaten.

dimensions[]

object (DimensionMetadata)

Die Dimensionsbeschreibungen.

metrics[]

object (MetricMetadata)

Die Messwertbeschreibungen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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