Method: properties.getMetadata

Zwraca metadane wymiarów i danych dostępnych w metodach raportowania. Służy do przeglądania wymiarów i danych. W ramach tej metody w żądaniu jest określony identyfikator usługi Google Analytics 4 w GA4, a odpowiedź metadanych zawiera niestandardowe wymiary i dane, a także metadane Universal.

Jeśli np. zarejestrowano w usłudze dane niestandardowe o nazwie parametru levels_unlocked, odpowiedź metadanych będzie zawierać parametr customEvent:levels_unlocked. Uniwersalne metadane to wymiary i dane stosowane w dowolnej usłudze, np. country i 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 liczbowy identyfikator usługi w GA4 w Google Analytics. Dowiedz się, gdzie znaleźć identyfikator usługi.

Przykład: właściwość/1234/metadata

W przypadku wymiarów i danych wspólnych dla wszystkich usług ustaw identyfikator usługi na 0. W tym trybie specjalnym 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 akceptowane obecnie w metodach raportowania.

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

string

Nazwa zasobu tych metadanych.
dimensions[]

object (DimensionMetadata)

opis wymiaru;
metrics[]

object (MetricMetadata)

Opisy danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

DimensionMetadata

Objaśnienie wymiaru.

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

string

Nazwa tego wymiaru. Można go użyć w elemencie name wymiaru. Na przykład: eventName.
uiName

string

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

string

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

string

Nazwy tego wymiaru są nadal używane, ale zostały wycofane. Jeśli ten wymiar jest wypełniony, jest dostępny przez określony czas przez element apiName lub jeden z elementów typu deprecatedApiNames. Po okresie wycofywania ten wymiar będzie dostępny tylko przez apiName.
customDefinition

boolean

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

MetricMetadata

Objaśnia dane.

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

string

Nazwa danych. Można go używać w polu name Wskaźnik. Na przykład: eventCount.
uiName

string

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

string

Opis sposobu korzystania i obliczania tych danych.
deprecatedApiNames[]

string

Nazwy tych danych są nadal użyteczne, ale zostały wycofane. Jeśli dane zostaną wypełnione, będą przez określony czas dostępne przez apiName lub jeden z elementów interfejsu deprecatedApiNames. Po okresie wycofywania te dane będą dostępne tylko przez apiName.
type

enum (MetricType)

Typ tego wskaźnika.
expression

string

Wyrażenie matematyczne dla tego pochodnego wskaźnika. Można jej używać w polu expression w polu Dane w odpowiadających im raportach. Większość wskaźników nie jest wyrażeniami, a w przypadku wartości innych niż wyrażenia to pole jest puste.
customDefinition

boolean

Prawda, jeśli te dane są danymi niestandardowymi w tej usłudze.