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“, „purchase“

createTime

string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

deletable

boolean

Nur Ausgabe. Wenn die Richtlinie auf „true“ gesetzt ist, kann dieses Ereignis gelöscht werden.

custom

boolean

Nur Ausgabe. Ist die Richtlinie auf „true“ gesetzt, bezieht sich dieses Schlüsselereignis auf ein benutzerdefiniertes Ereignis. Ist die Richtlinie auf „false“ gesetzt, bezieht sich dieses Schlüsselereignis auf ein Standardereignis in GA. Standardereignisse haben in Google Analytics in der Regel eine besondere Bedeutung. Sie werden normalerweise vom 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 benutzerdefinierter Schlüsselereignisse angerechnet, die pro Property erstellt werden können.

countingMethod

enum (CountingMethod)

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

defaultValue

object (DefaultValue)

Optional. Definiert einen Standardwert bzw. eine Standardwert für ein Schlüsselereignis.

CountingMethod

Die Methode, mit der Schlüsselereignisse für 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 nur einmal pro Sitzung und Nutzer als Schlüsselereignis betrachtet.

DefaultValue

Definiert einen Standardwert bzw. eine Standardwert für ein Schlüsselereignis.

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

number

Erforderlich. Hiermit wird der Parameter „value“ für alle Vorkommen dieses Schlüsselereignisses (angegeben durch eventName) ausgefüllt, wenn der 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 Währungscode gemäß ISO 4217 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 Schlüsselereignisse in der angegebenen übergeordneten Property zurück.

patch

Aktualisiert ein Schlüsselereignis.