Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

EventParams interface

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

Signature:

typescript

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 <code>screen_class</code> to Firebase Analytics.
firebase_screen	string	Firebase-specific. Use to log a <code>screen_name</code> 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:

typescript

affiliation?: string;

EventParams.checkout_option

Signature:

typescript

checkout_option?: string;

EventParams.checkout_step

Signature:

typescript

checkout_step?: number;

EventParams.content_type

Signature:

typescript

content_type?: string;

EventParams.coupon

Signature:

typescript

coupon?: string;

EventParams.currency

Signature:

typescript

currency?: string;

EventParams.description

Signature:

typescript

description?: string;

EventParams.event_category

Signature:

typescript

event_category?: string;

EventParams.event_label

Signature:

typescript

event_label?: string;

EventParams.fatal

Signature:

typescript

fatal?: boolean;

EventParams.firebase_screen_class

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

Signature:

typescript

firebase_screen_class?: string;

EventParams.firebase_screen

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

Signature:

typescript

firebase_screen?: string;

EventParams.item_id

Signature:

typescript

item_id?: string;

EventParams.item_list_id

Signature:

typescript

item_list_id?: string;

EventParams.item_list_name

Signature:

typescript

item_list_name?: string;

EventParams.items

Signature:

typescript

items?: Item[];

EventParams.method

Signature:

typescript

method?: string;

EventParams.number

Signature:

typescript

number?: string;

EventParams.page_location

Signature:

typescript

page_location?: string;

EventParams.page_path

Signature:

typescript

page_path?: string;

EventParams.page_title

Signature:

typescript

page_title?: string;

EventParams.payment_type

Signature:

typescript

payment_type?: string;

EventParams.promotion_id

Signature:

typescript

promotion_id?: string;

EventParams.promotion_name

Signature:

typescript

promotion_name?: string;

EventParams.promotions

Signature:

typescript

promotions?: Promotion[];

EventParams.screen_name

Signature:

typescript

screen_name?: string;

EventParams.search_term

Signature:

typescript

search_term?: string;

EventParams.shipping_tier

Signature:

typescript

shipping_tier?: string;

EventParams.shipping

Signature:

typescript

shipping?: Currency;

EventParams.tax

Signature:

typescript

tax?: Currency;

EventParams.transaction_id

Signature:

typescript

transaction_id?: string;

EventParams.value

Signature:

typescript

value?: number;