Method: properties.getMetadata

Gibt Metadaten für Dimensionen und Messwerte zurück, 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-GA4-Property-ID angegeben und 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 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. Property ist eine numerische Google Analytics GA4-Property-ID. Weitere Informationen dazu, wo Sie Ihre 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 werden von dieser Methode keine benutzerdefinierten Dimensionen und Messwerte zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die derzeit in Berichterstellungsmethoden akzeptierten Dimensionen, Messwerte und Vergleiche.

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 Dimensionsbeschreibungen.
metrics[]

object (MetricMetadata)

Beschreibungen der Messwerte
comparisons[]

object (ComparisonMetadata)

Die Beschreibungen des Vergleichs.

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 von Comparison verwendet werden. Beispiel: „comparisons/1234“.
uiName

string

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

string

Die Beschreibung dieses Vergleichs.