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/v1beta/{name=properties/*/metadata}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

To pole jest 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

Wymiary, dane i porównania obecnie akceptowane w metodach raportowania.

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

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