Method: properties.getMetadata

Zwraca metadane wymiarów i danych dostępnych w metodach raportowania. Służy do analizowania wymiarów i danych. W tej metodzie w żądaniu jest podany identyfikator usługi w Google Analytics 4, a odpowiedź metadanych obejmuje niestandardowe wymiary i dane oraz metadane Universal.

Jeśli np. w usłudze zarejestrowane są dane niestandardowe o nazwie parametru levels_unlocked, odpowiedź metadanych będzie zawierać wartość customEvent:levels_unlocked. Metadane uniwersalne to wymiary i dane obowiązujące w przypadku dowolnej usługi, np. country czy totalUsers.

Żądanie HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Nazwa zasobu metadanych do pobrania. To pole nazwy jest określone w ścieżce adresu URL, a nie w parametrach adresu URL. Usługa to numeryczny identyfikator usługi w GA4. Więcej informacji znajdziesz w artykule, gdzie znaleźć identyfikator usługi.

Przykład: properties/1234/metadata

W przypadku wymiarów i danych wspólnych dla wszystkich usług ustaw Identyfikator usługi na 0. W tym specjalnym trybie ta metoda nie zwraca niestandardowych wymiarów ani danych.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Wymiary i dane obecnie akceptowane w metodach raportowania.

Zapis JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Pola
name

string

Nazwa zasobu tych metadanych.
dimensions[]

object (DimensionMetadata)

opisy wymiarów.
metrics[]

object (MetricMetadata)

Opisy danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

DimensionMetadata

Wyjaśnia wymiar.

Zapis JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Pola
apiName

string

Nazwa tego wymiaru. Używany w elemencie name wymiaru. Na przykład: eventName.
uiName

string

Nazwa tego wymiaru w interfejsie Google Analytics. Na przykład: Event name.
description

string

Opis użycia i obliczania tego wymiaru.
deprecatedApiNames[]

string

Nazwy tego wymiaru są nadal używane, ale zostały wycofane. Jeśli jest wypełniony, ten wymiar jest dostępny przez apiName lub jeden z tych wymiarów: deprecatedApiNames. Po zakończeniu okresu wycofywania wymiar będzie dostępny tylko na poziomie apiName.
customDefinition

boolean

Prawda, jeśli wymiar jest wymiarem niestandardowym w tej usłudze.

MetricMetadata

Wyjaśnia dane.

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

string

Nazwa danych. Używany w name wskaźnika Metric. Na przykład: eventCount.
uiName

string

Nazwa tych danych w interfejsie Google Analytics. Na przykład: Event count.
description

string

Opis sposobu wykorzystywania i obliczania tych danych.
deprecatedApiNames[]

string

Nazwy tych danych są nadal używane, ale zostały wycofane. Jeśli te dane są wypełnione, dane są dostępne w wybranym okresie przez apiName lub deprecatedApiNames. Po okresie wycofywania dane będą dostępne dopiero apiName.
type

enum (MetricType)

Typ danych.
expression

string

Wyrażenie matematyczne tego wskaźnika derywowanego. Można jej używać w polu expression w polu Dane na potrzeby generowania równoważnych raportów. Większość danych nie jest wyrażeniami, a w przypadku elementów niebędących wyrażeniami to pole jest puste.
customDefinition

boolean

Prawda, jeśli są to dane niestandardowe w przypadku tej usługi.