REST Resource: properties.keyEvents

Ressource: KeyEvent

Ein Schlüsselereignis in einer Google Analytics-Property.

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

string

Nur Ausgabe. Ressourcenname dieses Schlüsselereignisses. Format: properties/{property}/keyEvents/{keyEvent}

eventName

string

Nicht veränderbar. Der Ereignisname für dieses Schlüsselereignis. Beispiele: „click“ (Klick) und „purchase“ (Kauf)

createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem dieses Schlüsselereignis in der Property erstellt wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

deletable

boolean

Nur Ausgabe. Wenn „true“ festgelegt ist, kann dieses Ereignis gelöscht werden.

custom

boolean

Nur Ausgabe. Wenn diese Option auf „wahr“ gesetzt ist, bezieht sich dieses Schlüsselereignis auf ein benutzerdefiniertes Ereignis. Wenn „false“ festgelegt ist, bezieht sich dieses Schlüsselereignis auf ein Standardereignis in Google Analytics. Standardereignisse haben in Google Analytics in der Regel eine besondere Bedeutung. Sie werden in der Regel vom Google Analytics-System für Sie erstellt, können aber in einigen Fällen auch von Property-Administratoren erstellt werden. Benutzerdefinierte Ereignisse werden auf die maximale Anzahl von benutzerdefinierten Schlüsselereignissen angerechnet, die pro Property erstellt werden können.

countingMethod

enum (CountingMethod)

Erforderlich. Die Methode, mit der Schlüsselereignisse über mehrere Ereignisse innerhalb einer Sitzung gezählt werden.

defaultValue

object (DefaultValue)

Optional. Hiermit wird ein Standardwert/eine Standardwährung für ein Schlüsselereignis definiert.

CountingMethod

Die Methode, mit der Schlüsselereignisse über mehrere Ereignisse innerhalb einer Sitzung gezählt werden.

Enums
COUNTING_METHOD_UNSPECIFIED Zählmethode nicht angegeben.
ONCE_PER_EVENT Jede Ereignisinstanz wird als Schlüsselereignis betrachtet.
ONCE_PER_SESSION Eine Ereignisinstanz wird höchstens einmal pro Sitzung und pro Nutzer als Schlüsselereignis betrachtet.

DefaultValue

Hiermit wird ein Standardwert/eine Standardwährung für ein Schlüsselereignis definiert.

JSON-Darstellung
{
  "numericValue": number,
  "currencyCode": string
}
Felder
numericValue

number

Erforderlich. Dieser Wert wird verwendet, um den Parameter „value“ für alle Vorkommnisse dieses Schlüsselereignisses (angegeben durch „eventName“) auszufüllen, bei denen dieser Parameter nicht festgelegt ist.

currencyCode

string

Erforderlich. Wenn für ein Auftreten dieses Schlüsselereignisses (angegeben durch „eventName“) keine Währung festgelegt ist, wird diese Währung als Standard angewendet. Muss im Format des ISO 4217-Währungscodes angegeben werden.

Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/ISO_4217.

Methoden

create

Erstellt ein Schlüsselereignis.

delete

Löscht ein Schlüsselereignis.

get

Ein einzelnes Schlüsselereignis abrufen

list

Gibt eine Liste der wichtigen Ereignisse in der angegebenen übergeordneten Property zurück.

patch

Aktualisiert ein Schlüsselereignis.