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 eine Google Analytics-Property-ID in der Anfrage angegeben und die Metadatenantwort enthält benutzerdefinierte Dimensionen und Messwerte sowie Universal-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 jede Property gelten, z. B. country und totalUsers.

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 in URL-Parametern angegeben. „Property“ ist eine numerische Google Analytics-Property-Kennung. Weitere Informationen

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 keine benutzerdefinierten Dimensionen und Messwerte zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die 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)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
Felder
name

string

Ressourcenname dieser Metadaten.
dimensions[]

object (DimensionMetadata)

Die Dimensionsbeschreibungen.
metrics[]

object (MetricMetadata)

Die Messwertbeschreibungen.
comparisons[]

object (ComparisonMetadata)

Die Vergleichsbeschreibungen.
conversions[]

object (ConversionMetadata)

Die Conversion-Beschreibungen.

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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Felder
apiName

string

Der Name dieser Dimension. Kann in name der Dimension 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

Weiterhin verwendbare, aber verworfene Namen für diese Dimension. Wenn diese Dimension erfasst wird, ist sie für einen bestimmten Zeitraum entweder nach apiName oder nach einer der deprecatedApiNames verfügbar. Nach dem Ende des Einstellungszeitraums ist die Dimension nur noch über apiName verfügbar.
customDefinition

boolean

„True“, wenn die Dimension für diese Property benutzerdefiniert ist. Dazu gehören benutzerdefinierte Dimensionen auf Nutzer-, Ereignis- und Artikelebene. https://support.google.com/analytics/answer/14240153 Das gilt auch für benutzerdefinierte Channelgruppen. Weitere Informationen zu benutzerdefinierten Channelgruppen finden Sie unter https://support.google.com/analytics/answer/13051316.
category

string

Der Anzeigename der Kategorie, zu der diese Dimension gehört. Ähnliche Dimensionen und Messwerte werden in Kategorien zusammengefasst.
sections[]

enum (Section)

Gibt die Google Analytics-Bereiche an, auf die sich diese Dimension bezieht.

MetricMetadata

Erklärt einen Messwert.

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

string

Ein Messwertname. Kann in name des Messwerts verwendet werden. Beispiel: eventCount
uiName

string

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

string

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

string

Weiterhin verwendbare, aber verworfene Namen für diesen Messwert. Wenn dieser Messwert erfasst wird, ist er entweder über apiName oder über einen der deprecatedApiNames-Werte für einen bestimmten Zeitraum verfügbar. Nach dem Zeitraum für die Einstellung ist der Messwert nur noch über apiName verfügbar.
type

enum (MetricType)

Der Typ dieses Messwerts.
expression

string

Der mathematische Ausdruck für diesen abgeleiteten Messwert. Kann im Feld expression des Messwerts für entsprechende Berichte verwendet werden. Die meisten Messwerte sind keine Ausdrücke. Für Messwerte, die keine Ausdrücke sind, ist dieses Feld leer.
customDefinition

boolean

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

enum (BlockedReason)

Wenn Gründe angegeben sind, wird der Zugriff auf diese Messwerte für diese Property blockiert. API-Anfragen von Ihnen für diesen Messwert für diese Property sind erfolgreich. Der Bericht enthält jedoch nur Nullen für diesen Messwert. API-Anfragen mit Messwertfiltern für blockierte Messwerte schlagen fehl. Wenn „reasons“ leer ist, haben Sie Zugriff auf diesen Messwert.

Weitere Informationen finden Sie unter Verwaltung von Zugriffs- und Dateneinschränkungen.
category

string

Der Anzeigename der Kategorie, zu der dieser Messwert gehört. Ähnliche Dimensionen und Messwerte werden in Kategorien zusammengefasst.
sections[]

enum (Section)

Gibt die Google Analytics-Bereiche an, auf die sich dieser Messwert bezieht.

BlockedReason

Begründungen dafür, warum dieser Messwert blockiert wird.

Enums
BLOCKED_REASON_UNSPECIFIED Wird niemals in der API-Antwort angegeben.
NO_REVENUE_METRICS Wenn diese Meldung angezeigt wird, haben Sie keinen Zugriff auf umsatzbezogene Messwerte für diese Property. Der Messwert ist umsatzbezogen.
NO_COST_METRICS Wenn vorhanden, ist Ihr Zugriff auf kostenbezogene Messwerte für diese Property gesperrt und dieser Messwert ist kostenbezogen.

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

string

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

string

Die Beschreibung dieses Vergleichs.

ConversionMetadata

Die Metadaten für eine einzelne Conversion.

JSON-Darstellung 
{
  "conversionAction": string,
  "displayName": string
}
Felder
conversionAction

string

Die eindeutige ID der Conversion-Aktion. Mit dieser ID wird angegeben, welche Conversions in einen Bericht aufgenommen werden sollen. Dazu wird das Feld conversionActions im ConversionsSpec einer Berichtsanfrage ausgefüllt. Beispiel: „conversionActions/1234“.
displayName

string

Der Name dieser Conversion in der Google Analytics-Benutzeroberfläche.