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: usługi/{usługa}/zdarzenia kluczowe/{zdarzenie_kluczowe}

eventName

string

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

createTime

string (Timestamp format)

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

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. 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 zdarzenie można usunąć.

custom

boolean

Tylko dane wyjściowe. Jeśli wartość to Prawda, to kluczowe zdarzenie odnosi się do zdarzenia niestandardowego. Jeśli wartość to false, to kluczowe zdarzenie odnosi się do zdarzenia domyślnego w GA. Zdarzenia domyślne mają w GA zwykle specjalne znaczenie. Zdarzenia domyślne są zwykle 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 poszczególnych usługach.

countingMethod

enum (CountingMethod)

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

defaultValue

object (DefaultValue)

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

CountingMethod

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

Wartości w polu enum
COUNTING_METHOD_UNSPECIFIED Metoda zliczania nie została określona.
ONCE_PER_EVENT Każda instancja zdarzenia jest uważana za kluczowe zdarzenie.
ONCE_PER_SESSION Wystąpienie zdarzenia jest uznawane za kluczowe zdarzenie maksymalnie 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. Parametr ten będzie służyć do wypełniania parametru „value” we wszystkich wystąpieniach tego kluczowego zdarzenia (określonego przez eventName), w których parametr ten nie ma określonej wartości.

currencyCode

string

Wymagane. Jeśli wystąpienie tego kluczowego zdarzenia (określone przez parametr eventName) nie ma określonej waluty, zostanie zastosowana ta waluta 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ń w określonej usłudze nadrzędnej.

patch

Aktualizuje kluczowe zdarzenie.