Skip to content

useSetUserPropertiesMutation.mdx

Latest commit

 

History

History
31 lines (23 loc) · 681 Bytes

useSetUserPropertiesMutation.mdx

File metadata and controls

31 lines (23 loc) · 681 Bytes
Raw
title useSetUserPropertiesMutation

Set Google Analytics user properties for a Firebase Analytics instance.

Usage

import { getAnalytics } from "firebase/analytics";
import { useSetUserPropertiesMutation } from "@tanstack-query-firebase/react/analytics";

const analytics = getAnalytics(app);
const { mutate: setAnalyticsUserProperties } =
  useSetUserPropertiesMutation(analytics);

setAnalyticsUserProperties({
  properties: { plan: "premium", role: "admin" },
});

Global properties

Apply properties across all gtag properties on the page:

setAnalyticsUserProperties({
  properties: { plan: "free" },
  callOptions: { global: true },
});