Configures Firebase Analytics to use custom gtag or dataLayer names.
Intended to be used if gtag.js script has been installed on
this page independently of Firebase Analytics, and is using non-default
names for either the gtag function or for dataLayer.
Must be called before calling firebase.analytics() or it won't
have any effect.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-09-28 UTC."],[],[],null,["# analytics | JavaScript SDK\n\n- [firebase](/docs/reference/js/v8/firebase).\n- analytics\n=========================================================\n\nThe Analytics SDK does not work in a Node.js environment.\n\n### Callable\n\n- analytics ( app ? : [App](/docs/reference/js/v8/firebase.app.App) ) : [Analytics](/docs/reference/js/v8/firebase.analytics.Analytics)\n- Gets the [`Analytics`](/docs/reference/js/v8/firebase.analytics.Analytics) service.\n\n `firebase.analytics()` can be called with no arguments to access the default\n app's [`Analytics`](/docs/reference/js/v8/firebase.analytics.Analytics) service.\n\n The Analytics SDK does not work in a Node.js environment.\n\n example\n :\n\n // Get the Analytics service for the default app\n const defaultAnalytics = firebase.analytics();\n\n\n #### Parameters\n\n -\n\n ##### Optional app: [App](/docs/reference/js/v8/firebase.app.App)\n\n The app to create an analytics service for.\n If not passed, uses the default app.\n\n #### Returns [Analytics](/docs/reference/js/v8/firebase.analytics.Analytics)\n\nIndex\n-----\n\n### Enumerations\n\n- [EventName](/docs/reference/js/v8/firebase.analytics.EventName)\n\n### Interfaces\n\n- [Analytics](/docs/reference/js/v8/firebase.analytics.Analytics)\n- [AnalyticsCallOptions](/docs/reference/js/v8/firebase.analytics.AnalyticsCallOptions)\n- [ControlParams](/docs/reference/js/v8/firebase.analytics.ControlParams)\n- [CustomParams](/docs/reference/js/v8/firebase.analytics.CustomParams)\n- [EventParams](/docs/reference/js/v8/firebase.analytics.EventParams)\n- [Item](/docs/reference/js/v8/firebase.analytics.Item)\n- [Promotion](/docs/reference/js/v8/firebase.analytics.Promotion)\n- [SettingsOptions](/docs/reference/js/v8/firebase.analytics.SettingsOptions)\n\n### Type aliases\n\n- [Currency](/docs/reference/js/v8/firebase.analytics#currency)\n- [CustomEventName](/docs/reference/js/v8/firebase.analytics#customeventname)\n- [EventNameString](/docs/reference/js/v8/firebase.analytics#eventnamestring)\n\n### Functions\n\n- [isSupported](/docs/reference/js/v8/firebase.analytics#issupported)\n- [settings](/docs/reference/js/v8/firebase.analytics#settings)\n\nType aliases\n------------\n\n### Currency\n\nCurrency: string \\| number\n\n### CustomEventName\n\nCustomEventName\\\u003cT\\\u003e: T extends EventNameString ? never : T\n\n#### Type parameters\n\n-\n\n #### T\n\n### EventNameString\n\nEventNameString: \"add_payment_info\" \\| \"add_shipping_info\" \\| \"add_to_cart\" \\| \"add_to_wishlist\" \\| \"begin_checkout\" \\| \"checkout_progress\" \\| \"exception\" \\| \"generate_lead\" \\| \"login\" \\| \"page_view\" \\| \"purchase\" \\| \"refund\" \\| \"remove_from_cart\" \\| \"screen_view\" \\| \"search\" \\| \"select_content\" \\| \"select_item\" \\| \"select_promotion\" \\| \"set_checkout_option\" \\| \"share\" \\| \"sign_up\" \\| \"timing_complete\" \\| \"view_cart\" \\| \"view_item\" \\| \"view_item_list\" \\| \"view_promotion\" \\| \"view_search_results\" \nType for standard gtag.js event names. `logEvent` also accepts any\ncustom string and interprets it as a custom event name.\n\nFunctions\n---------\n\n### isSupported\n\n- isSupported ( ) : Promise \\\u003c boolean \\\u003e\n- An async function that returns true if current browser context supports initialization of analytics module\n (`firebase.analytics()`).\n\n Returns false otherwise.\n\n #### Returns Promise\\\u003cboolean\\\u003e\n\n### settings\n\n- settings ( settings : [SettingsOptions](/docs/reference/js/v8/firebase.analytics.SettingsOptions) ) : void\n- Configures Firebase Analytics to use custom `gtag` or `dataLayer` names.\n Intended to be used if `gtag.js` script has been installed on\n this page independently of Firebase Analytics, and is using non-default\n names for either the `gtag` function or for `dataLayer`.\n Must be called before calling `firebase.analytics()` or it won't\n have any effect.\n\n #### Parameters\n\n -\n\n ##### settings: [SettingsOptions](/docs/reference/js/v8/firebase.analytics.SettingsOptions)\n\n #### Returns void"]]
The Analytics SDK does not work in a Node.js environment.