Skip to content

Commit

Permalink
docs(analytics): note possible problems with event parameters (#8243)
Browse files Browse the repository at this point in the history
* docs(analytics): note possible problems with event parameters

* docs(dynamic-links): avoid use of invalid markdown for warning

github markdown syntax doesn't work in the more general markdown tooling
the docs site renders with
  • Loading branch information
mikehardy authored Jan 22, 2025
1 parent ffb1f92 commit 87b9e8d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
11 changes: 11 additions & 0 deletions docs/analytics/usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ Analytics automatically logs some [events](https://support.google.com/analytics/

Analytics offers a wealth of [Predefined Events](#predefined-events) to track user behavior. Analytics also offers folks the ability to log [Custom Events](#custom-events) . If you're already familiar with Google Analytics, this method is equivalent to using the event command in [gtag.js](https://developers.google.com/gtagjs/).

## Event Parameters

Please pay very special attention to what parameters you send in for _any_ events - custom, predefined or otherwise.

> **WARNING**
> Parameters are _not_ validated and incorrect parameters will _silently_ be accepted but then _fail to log an event_ in the Analytics console.
It is the developer's responsibility to verify that their parameters are correct and are being logged correctly.

Different event types require different parameters (some require no parameters, some require an array of strings, most require just a string, etc). The developer must examine the reference for each type of event and send the correct parameters. You may watch device logs and the Analytics console to make sure the events are correctly sent to Google Analytics.

## Custom Events

Below is an example showing how a custom event can be logged. Please be aware that primitive data types or arrays of primitive data types are logged in your Firebase Analytics console.
Expand Down
3 changes: 1 addition & 2 deletions docs/dynamic-links/usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ next: /in-app-messaging/usage
previous: /database/presence-detection
---

> [!WARNING]
> Deprecated: Firebase Dynamic Links is deprecated and should not be adopted in projects that don't already use it. Functionality for the primary use cases of store/web routing and deferred/regular deep-linking will shut down on August 25, 2025. Firebase Authentication currently uses Firebase Dynamic Links to customize Authentication links, but the Firebase team will provide an update to ensure that this functionality continues working after the Firebase Dynamic Links service is shut down. See the [Dynamic Links Deprecation FAQ](https://firebase.google.com/support/dynamic-links-faq) for more information.
> **Deprecated:** Firebase Dynamic Links is deprecated and should not be adopted in projects that don't already use it. Functionality for the primary use cases of store/web routing and deferred/regular deep-linking will shut down on August 25, 2025. Firebase Authentication currently uses Firebase Dynamic Links to customize Authentication links, but the Firebase team will provide an update to ensure that this functionality continues working after the Firebase Dynamic Links service is shut down. See the [Dynamic Links Deprecation FAQ](https://firebase.google.com/support/dynamic-links-faq) for more information.
# Installation

Expand Down

0 comments on commit 87b9e8d

Please sign in to comment.