EventParams interface

Standard gtag.js event parameters. For more information, see the GA4 reference documentation.

Signature:

export interface EventParams 

Properties

Property Type Description
affiliation string
checkout_option string
checkout_step number
content_type string
coupon string
currency string
description string
event_category string
event_label string
fatal boolean
firebase_screen_class string Firebase-specific. Use to log a screen_class to Firebase Analytics.
firebase_screen string Firebase-specific. Use to log a screen_name to Firebase Analytics.
item_id string
item_list_id string
item_list_name string
items Item[]
method string
number string
page_location string
page_path string
page_title string
payment_type string
promotion_id string
promotion_name string
promotions Promotion[]
screen_name string
search_term string
shipping_tier string
shipping Currency
tax Currency
transaction_id string
value number

EventParams.affiliation

Signature:

affiliation?: string;

EventParams.checkout_option

Signature:

checkout_option?: string;

EventParams.checkout_step

Signature:

checkout_step?: number;

EventParams.content_type

Signature:

content_type?: string;

EventParams.coupon

Signature:

coupon?: string;

EventParams.currency

Signature:

currency?: string;

EventParams.description

Signature:

description?: string;

EventParams.event_category

Signature:

event_category?: string;

EventParams.event_label

Signature:

event_label?: string;

EventParams.fatal

Signature:

fatal?: boolean;

EventParams.firebase_screen_class

Firebase-specific. Use to log a screen_class to Firebase Analytics.

Signature:

firebase_screen_class?: string;

EventParams.firebase_screen

Firebase-specific. Use to log a screen_name to Firebase Analytics.

Signature:

firebase_screen?: string;

EventParams.item_id

Signature:

item_id?: string;

EventParams.item_list_id

Signature:

item_list_id?: string;

EventParams.item_list_name

Signature:

item_list_name?: string;

EventParams.items

Signature:

items?: Item[];

EventParams.method

Signature:

method?: string;

EventParams.number

Signature:

number?: string;

EventParams.page_location

Signature:

page_location?: string;

EventParams.page_path

Signature:

page_path?: string;

EventParams.page_title

Signature:

page_title?: string;

EventParams.payment_type

Signature:

payment_type?: string;

EventParams.promotion_id

Signature:

promotion_id?: string;

EventParams.promotion_name

Signature:

promotion_name?: string;

EventParams.promotions

Signature:

promotions?: Promotion[];

EventParams.screen_name

Signature:

screen_name?: string;

EventParams.search_term

Signature:

search_term?: string;

EventParams.shipping_tier

Signature:

shipping_tier?: string;

EventParams.shipping

Signature:

shipping?: Currency;

EventParams.tax

Signature:

tax?: Currency;

EventParams.transaction_id

Signature:

transaction_id?: string;

EventParams.value

Signature:

value?: number;