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

string

Nazwa zasobu tych metadanych.
dimensions[]

object (DimensionMetadata)

Opisy wymiarów.
metrics[]

object (MetricMetadata)

Opisy danych.
comparisons[]

object (ComparisonMetadata)

Opisy porównania.
conversions[]

object (ConversionMetadata)

opisy konwersji;

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Pola
apiName

string

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

string

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

string

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

string

Nadal używane, ale wycofane nazwy tego wymiaru. Jeśli ten wymiar jest wypełniony, jest dostępny przez okres czasu w przypadku wartości apiName lub jednej z wartości deprecatedApiNames. Po okresie wycofania wymiar będzie dostępny tylko w przypadku apiName.
customDefinition

boolean

Wartość „prawda”, jeśli wymiar jest niestandardowy w tej usłudze. Obejmuje to wymiary niestandardowe o zakresie użytkownika, zdarzenia i produktu. Więcej informacji o wymiarach niestandardowych znajdziesz na stronie https://support.google.com/analytics/answer/14240153. Dotyczy to również niestandardowych grup kanałów. Więcej informacji o niestandardowych grupach kanałów znajdziesz na stronie https://support.google.com/analytics/answer/13051316.
category

string

Wyświetlana nazwa kategorii, do której należy ten wymiar. Podobne wymiary i dane są pogrupowane w kategorie.
sections[]

enum (Section)

Określa sekcje Google Analytics, do których odnosi się ten wymiar.

MetricMetadata

Wyjaśnia dane.

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

string

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

string

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

string

Opis sposobu używania i obliczania tych danych.
deprecatedApiNames[]

string

Nadal używane, ale wycofane nazwy tego rodzaju danych. Jeśli te dane są wypełnione, są dostępne w przypadku wartości apiName lub jednej z wartości deprecatedApiNames przez określony czas. Po okresie wycofania ten rodzaj danych będzie dostępny tylko w ramach apiName.
type

enum (MetricType)

Typ tych danych.
expression

string

Wyrażenie matematyczne tego wskaźnika pochodnego. Można go używać w polu expression danych w równoważnych raportach. Większość rodzajów danych nie jest wyrażeniami, więc w przypadku tych rodzajów danych to pole jest puste.
customDefinition

boolean

Wartość „prawda”, jeśli dane są danymi niestandardowymi w tej usłudze.
blockedReasons[]

enum (BlockedReason)

Jeśli podano przyczyny, dostęp do tych danych w tej usłudze jest zablokowany. Żądania interfejsu API wysyłane przez Ciebie do tej usługi w przypadku tych danych będą realizowane, ale raport będzie zawierać w przypadku tych danych tylko zera. Żądania do interfejsu API z filtrami danych dotyczącymi zablokowanych danych będą się kończyć niepowodzeniem. Jeśli pole „Przyczyny” jest puste, masz dostęp do tych danych.

Więcej informacji znajdziesz w artykule Zarządzanie dostępem i ograniczeniami dotyczącymi danych.
category

string

Wyświetlana nazwa kategorii, do której należą te dane. Podobne wymiary i dane są pogrupowane w kategorie.
sections[]

enum (Section)

Określa sekcje Google Analytics, do których odnoszą się te dane.

BlockedReason

Uzasadnienie, dlaczego te dane są zablokowane.

Wartości w polu enum
BLOCKED_REASON_UNSPECIFIED Nigdy nie będzie określony w odpowiedzi interfejsu API.
NO_REVENUE_METRICS Jeśli jest on widoczny, oznacza to, że nie masz dostępu do danych związanych z przychodami w tej usłudze, a te dane są związane z przychodami.
NO_COST_METRICS Jeśli występuje, Twój dostęp do danych związanych z kosztami w tej usłudze jest zablokowany, a te dane są związane z kosztami.

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.

ConversionMetadata

Metadane pojedynczej konwersji.

Zapis JSON 
{
  "conversionAction": string,
  "displayName": string
}
Pola
conversionAction

string

Unikalny identyfikator działania powodującego konwersję. Ten identyfikator służy do określania, które konwersje mają być uwzględniane w raporcie. W tym celu należy wypełnić pole conversionActions w ConversionsSpec żądania raportu. Na przykład „conversionActions/1234”.
displayName

string

Nazwa tej konwersji w interfejsie Google Analytics.