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. Wenn sie auf „true“ gesetzt ist, verweist dieses Schlüsselereignis auf ein benutzerdefiniertes Ereignis. Wenn es auf „false“ gesetzt ist, verweist es auf ein Standardereignis in Google Analytics. Standardereignisse haben in Google Analytics normalerweise eine besondere Bedeutung. Standardereignisse werden normalerweise vom Google Analytics-System für Sie erstellt, in manchen Fällen aber auch von Property-Administratoren. 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 für mehrere Ereignisse innerhalb einer Sitzung gezählt werden.

defaultValue

object (DefaultValue)

Optional. Definiert den Standardwert bzw. die Standardwährung 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 gilt höchstens einmal pro Sitzung und Nutzer als Schlüsselereignis.

DefaultValue

Definiert den Standardwert bzw. die Standardwährung für ein Schlüsselereignis.

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

number

Erforderlich. Dieses Feld wird verwendet, um den Wert -Parameter für alle Vorkommen dieses Schlüsselereignisses (durch eventName angegeben), wobei der Parameter nicht festgelegt ist.

currencyCode

string

Erforderlich. Wenn für dieses Schlüsselereignis (durch eventName angegeben) keine Währung festgelegt ist, wird diese Währung als Standardwährung verwendet. Muss im Währungscodeformat 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

Einzelnes Schlüsselereignis abrufen.

list

Gibt eine Liste von Schlüsselereignissen in der angegebenen übergeordneten Eigenschaft zurück.

patch

Aktualisiert ein Schlüsselereignis.