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.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. 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 auf „true“ gesetzt, kann dieses Ereignis gelöscht werden.

custom

boolean

Nur Ausgabe. Wenn auf „true“ gesetzt, bezieht sich dieses Schlüsselereignis auf ein benutzerdefiniertes Ereignis. Wenn auf „false“ gesetzt, bezieht sich dieses Schlüsselereignis auf ein Standardereignis in Google Analytics. Standardereignisse haben in Google Analytics in der Regel eine besondere Bedeutung. Sie werden normalerweise vom Google Analytics-System erstellt, in einigen Fällen aber auch von Property-Administratoren. 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 oder eine 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 wird maximal einmal pro Sitzung und Nutzer als Schlüsselereignis betrachtet.

DefaultValue

Definiert einen Standardwert oder eine Standardwährung für ein Schlüsselereignis.

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

number

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

currencyCode

string

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

Ruft ein einzelnes Schlüsselereignis ab.

list

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

patch

Aktualisiert ein Schlüsselereignis.