REST Resource: properties.keyEvents

Zasób: KeyEvent

Kluczowe zdarzenie w usłudze w Google Analytics.

Zapis JSON
{
  "name": string,
  "eventName": string,
  "createTime": string,
  "deletable": boolean,
  "custom": boolean,
  "countingMethod": enum (CountingMethod),
  "defaultValue": {
    object (DefaultValue)
  }
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu tego kluczowego zdarzenia. Format: properties/{property}/keyEvents/{keyEvent}

eventName

string

Niezmienna. Nazwa zdarzenia dla tego kluczowego zdarzenia. Przykłady: „kliknięcie”, „zakup”

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia tego kluczowego zdarzenia w usłudze.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

deletable

boolean

Tylko dane wyjściowe. Jeśli ma wartość Prawda, to wydarzenie można usunąć.

custom

boolean

Tylko dane wyjściowe. Jeśli ma wartość „true”, to kluczowe zdarzenie odnosi się do zdarzenia niestandardowego. Jeśli wartość jest ustawiona na „false”, to kluczowe zdarzenie odnosi się do domyślnego zdarzenia w GA. Domyślne zdarzenia mają zwykle specjalne znaczenie w GA. Zazwyczaj są one tworzone przez system GA, ale w niektórych przypadkach mogą być tworzone przez administratorów usługi. Zdarzenia niestandardowe wliczają się do maksymalnej liczby niestandardowych kluczowych zdarzeń, które można utworzyć w usłudze.

countingMethod

enum (CountingMethod)

Wymagane. Metoda zliczania kluczowych zdarzeń w przypadku wielu zdarzeń w sesji.

defaultValue

object (DefaultValue)

Opcjonalnie. Określa domyślną wartość lub walutę kluczowego zdarzenia.

CountingMethod

Metoda zliczania kluczowych zdarzeń w przypadku wielu zdarzeń w sesji.

Wartości w polu enum
COUNTING_METHOD_UNSPECIFIED Nie określono metody zliczania.
ONCE_PER_EVENT Każda instancja zdarzenia jest uznawana za kluczowe zdarzenie.
ONCE_PER_SESSION Instancja zdarzenia jest uznawana za kluczowe zdarzenie co najwyżej raz na sesję na użytkownika.

DefaultValue

Określa domyślną wartość lub walutę kluczowego zdarzenia.

Zapis JSON
{
  "numericValue": number,
  "currencyCode": string
}
Pola
numericValue

number

Wymagane. Będzie ona używana do wypełniania parametru „value” we wszystkich wystąpieniach tego kluczowego zdarzenia (określonego przez eventName), w których ten parametr nie jest ustawiony.

currencyCode

string

Wymagane. Gdy wystąpienie tego kluczowego zdarzenia (określonego przez eventName) nie ma ustawionej waluty, ta waluta zostanie zastosowana jako domyślna. Musi być w formacie kodu waluty ISO 4217.

Więcej informacji znajdziesz na stronie https://en.wikipedia.org/wiki/ISO_4217.

Metody

create

Tworzy kluczowe zdarzenie.

delete

Usuwa kluczowe zdarzenie.

get

Pobieranie pojedynczego kluczowego zdarzenia.

list

Zwraca listę kluczowych zdarzeń we wskazanej usłudze nadrzędnej.

patch

Aktualizuje kluczowe zdarzenie.