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/v1alpha/{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

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

Die Dimensionen und Messwerte, die derzeit in Berichterstellungsmethoden akzeptiert werden.

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

string

Ressourcenname dieser Metadaten.
dimensions[]

object (DimensionMetadata)

Die Dimensionsbeschreibungen.
metrics[]

object (MetricMetadata)

Beschreibungen der Messwerte

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

DimensionMetadata

Erklärt eine Dimension.

JSON-Darstellung 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Felder
apiName

string

Der Name dieser Dimension. Kann in der Dimension name verwendet werden. Beispiel: eventName
uiName

string

Der Name dieser Dimension in der Google Analytics-Benutzeroberfläche. Beispiel: Event name.
description

string

Beschreibung, wie diese Dimension verwendet und berechnet wird.
deprecatedApiNames[]

string

Noch verwendbare, aber nicht mehr unterstützte Namen für diese Dimension. Wenn diese Dimension ausgefüllt ist, ist sie für einen bestimmten Zeitraum entweder von apiName oder von deprecatedApiNames verfügbar. Nach Ablauf des Einstellungszeitraums ist die Dimension nur noch bis zum apiName verfügbar.
customDefinition

boolean

Dieser Wert ist „True“, wenn die Dimension eine benutzerdefinierte Dimension für diese Property ist.

MetricMetadata

Erklärt eine Metrik.

JSON-Darstellung 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Felder
apiName

string

Einen Messwertnamen. Kann im name von Metric verwendet werden. Beispiel: eventCount
uiName

string

Der Name dieses Messwerts in der Google Analytics-Benutzeroberfläche. Beispiel: Event count.
description

string

Beschreibung, wie dieser Messwert verwendet und berechnet wird.
deprecatedApiNames[]

string

Noch verwendbare, aber eingestellte Namen für diesen Messwert. Wenn dieser Messwert ausgefüllt ist, ist er für einen bestimmten Zeitraum entweder von apiName oder von deprecatedApiNames verfügbar. Nach Ablauf des Einstellungszeitraums ist der Messwert nur noch ab dem apiName verfügbar.
type

enum (MetricType)

Der Typ dieses Messwerts.
expression

string

Der mathematische Ausdruck für diese abgeleitete Metrik. Kann im Feld expression des Messwerts für gleichwertige Berichte verwendet werden. Die meisten Messwerte sind keine Ausdrücke. Bei Nicht-Ausdrücken ist dieses Feld leer.
customDefinition

boolean

„True“, wenn der Messwert ein benutzerdefinierter Messwert für diese Property ist.