Method: properties.getMetadata

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

Jeśli np. w usłudze zarejestrowany jest rodzaj danych niestandardowych o nazwie parametru levels_unlocked, odpowiedź metadanych będzie zawierać customEvent:levels_unlocked. Metadane uniwersalne to wymiary i dane, które mają zastosowanie do każdej usługi, 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

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 Google Analytics. 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 wymiarów ani danych niestandardowych.

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

string

Nazwa zasobu tych metadanych.
dimensions[]

object (DimensionMetadata)

Opisy wymiarów.
metrics[]

object (MetricMetadata)

Opisy danych.
comparisons[]

object (ComparisonMetadata)

Opisy porównania.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

ComparisonMetadata

Metadane dotyczące pojedynczego porównania.

Zapis JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Pola
apiName

string

Nazwa zasobu tego porównania. Można go używać w polu comparison porównania. Na przykład „comparisons/1234”.
uiName

string

Nazwa tego porównania w interfejsie Google Analytics.
description

string

Opis tego porównania.