- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- DimensionMetadata
- MetricMetadata
- Testen!
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/v1alpha/{name=properties/*/metadata}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
name |
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
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Die derzeit in Berichtsmethoden akzeptierten Dimensionen und Messwerte
JSON-Darstellung | |
---|---|
{ "name": string, "dimensions": [ { object ( |
Felder | |
---|---|
name |
Ressourcenname dieser Metadaten. |
dimensions[] |
Die Dimensionsbeschreibungen |
metrics[] |
Messwertbeschreibungen |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
DimensionMetadata
Beschreibt eine Dimension.
JSON-Darstellung | |
---|---|
{ "apiName": string, "uiName": string, "description": string, "deprecatedApiNames": [ string ], "customDefinition": boolean } |
Felder | |
---|---|
apiName |
Name dieser Dimension. Verfügbar in |
uiName |
Name dieser Dimension in der Google Analytics-Benutzeroberfläche. Beispiel: |
description |
Hier wird beschrieben, wie diese Dimension verwendet und berechnet wird. |
deprecatedApiNames[] |
Immer noch verwendbare, aber eingestellte Namen für diese Dimension. Wenn das Feld ausgefüllt ist, ist diese Dimension für einen bestimmten Zeitraum entweder für |
customDefinition |
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 ( |
Felder | |
---|---|
apiName |
Ein Messwertname. Verfügbar im |
uiName |
Name dieses Messwerts in der Google Analytics-Benutzeroberfläche. Beispiel: |
description |
Beschreibung, wie dieser Messwert verwendet und berechnet wird. |
deprecatedApiNames[] |
Immer noch verwendbare, aber eingestellte Namen für diesen Messwert. Wenn dieser Messwert ausgefüllt ist, ist er entweder von |
type |
Der Typ dieses Messwerts. |
expression |
Der mathematische Ausdruck für diesen abgeleiteten Messwert. Kann im Feld |
customDefinition |
„True“, wenn der Messwert ein benutzerdefinierter Messwert für diese Property ist. |