From dc11a27618819396944368f421dcbcb62c395f07 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 30 Jan 2024 13:32:54 -0800 Subject: [PATCH] update page-view links in analytics docs (#7994) --- docs-devsite/analytics.gtagconfigparams.md | 12 ++++++------ docs-devsite/analytics.md | 4 ++-- packages/analytics-types/index.d.ts | 2 +- packages/analytics/src/api.ts | 2 +- packages/analytics/src/public-types.ts | 6 +++--- packages/firebase/compat/index.d.ts | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs-devsite/analytics.gtagconfigparams.md b/docs-devsite/analytics.gtagconfigparams.md index f5138b8b65e..c2931e4f637 100644 --- a/docs-devsite/analytics.gtagconfigparams.md +++ b/docs-devsite/analytics.gtagconfigparams.md @@ -29,9 +29,9 @@ export interface GtagConfigParams | [cookie\_flags](./analytics.gtagconfigparams.md#gtagconfigparamscookie_flags) | string | Appends additional flags to the cookie when set. See [Cookies and user identification](https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id) | | [cookie\_prefix](./analytics.gtagconfigparams.md#gtagconfigparamscookie_prefix) | string | Defaults to _ga. See [Cookies and user identification](https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id) | | [cookie\_update](./analytics.gtagconfigparams.md#gtagconfigparamscookie_update) | boolean | If set to true, will update cookies on each page load. Defaults to true. See [Cookies and user identification](https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id) | -| [page\_location](./analytics.gtagconfigparams.md#gtagconfigparamspage_location) | string | The URL of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view) | -| [page\_title](./analytics.gtagconfigparams.md#gtagconfigparamspage_title) | string | The title of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view) | -| [send\_page\_view](./analytics.gtagconfigparams.md#gtagconfigparamssend_page_view) | boolean | Whether or not a page view should be sent. If set to true (default), a page view is automatically sent upon initialization of analytics. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view) | +| [page\_location](./analytics.gtagconfigparams.md#gtagconfigparamspage_location) | string | The URL of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views) | +| [page\_title](./analytics.gtagconfigparams.md#gtagconfigparamspage_title) | string | The title of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views) | +| [send\_page\_view](./analytics.gtagconfigparams.md#gtagconfigparamssend_page_view) | boolean | Whether or not a page view should be sent. If set to true (default), a page view is automatically sent upon initialization of analytics. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views) | ## GtagConfigParams.allow\_ad\_personalization\_signals @@ -105,7 +105,7 @@ If set to true, will update cookies on each page load. Defaults to true. See [Co ## GtagConfigParams.page\_location -The URL of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view) +The URL of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views) Signature: @@ -115,7 +115,7 @@ The URL of the page. See [Page views](https://developers.google.com/analytics/de ## GtagConfigParams.page\_title -The title of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view) +The title of the page. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views) Signature: @@ -125,7 +125,7 @@ The title of the page. See [Page views](https://developers.google.com/analytics/ ## GtagConfigParams.send\_page\_view -Whether or not a page view should be sent. If set to true (default), a page view is automatically sent upon initialization of analytics. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view) +Whether or not a page view should be sent. If set to true (default), a page view is automatically sent upon initialization of analytics. See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views) Signature: diff --git a/docs-devsite/analytics.md b/docs-devsite/analytics.md index 5427a2c90b7..fe4fa13a68d 100644 --- a/docs-devsite/analytics.md +++ b/docs-devsite/analytics.md @@ -42,7 +42,7 @@ The Firebase Analytics Web SDK. This SDK does not work in a Node.js environment. | [logEvent(analyticsInstance, eventName, eventParams, options)](./analytics.md#logevent_800159e) | Sends a Google Analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device.See [Measure exceptions](https://developers.google.com/analytics/devguides/collection/ga4/exceptions). | | [logEvent(analyticsInstance, eventName, eventParams, options)](./analytics.md#logevent_9c11aa9) | Sends a Google Analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device.List of recommended event parameters can be found in [the GA4 reference documentation](https://developers.google.com/gtagjs/reference/ga4-events). | | [logEvent(analyticsInstance, eventName, eventParams, options)](./analytics.md#logevent_1f3f282) | Sends a Google Analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device.List of recommended event parameters can be found in [the GA4 reference documentation](https://developers.google.com/gtagjs/reference/ga4-events). | -| [logEvent(analyticsInstance, eventName, eventParams, options)](./analytics.md#logevent_0792e28) | Sends a Google Analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device.See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view). | +| [logEvent(analyticsInstance, eventName, eventParams, options)](./analytics.md#logevent_0792e28) | Sends a Google Analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device.See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views). | | [setAnalyticsCollectionEnabled(analyticsInstance, enabled)](./analytics.md#setanalyticscollectionenabled_494179c) | Sets whether Google Analytics collection is enabled for this app on this device. Sets global window['ga-disable-analyticsId'] = true; | | [setCurrentScreen(analyticsInstance, screenName, options)](./analytics.md#setcurrentscreen_a6168fa) | Use gtag config command to set screen_name. | | [setUserId(analyticsInstance, id, options)](./analytics.md#setuserid_86d82f6) | Use gtag config command to set user_id. | @@ -780,7 +780,7 @@ void Sends a Google Analytics event with given `eventParams`. This method automatically associates this logged event with this Firebase web app instance on this device. -See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/page-view). +See [Page views](https://developers.google.com/analytics/devguides/collection/ga4/views). Signature: diff --git a/packages/analytics-types/index.d.ts b/packages/analytics-types/index.d.ts index b502af099bd..9a9f27499ae 100644 --- a/packages/analytics-types/index.d.ts +++ b/packages/analytics-types/index.d.ts @@ -197,7 +197,7 @@ export interface FirebaseAnalytics { * automatically associates this logged event with this Firebase web * app instance on this device. * See - * {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view + * {@link https://developers.google.com/analytics/devguides/collection/ga4/views * | Page views}. */ logEvent( diff --git a/packages/analytics/src/api.ts b/packages/analytics/src/api.ts index f44cbad2de9..baf136b3e35 100644 --- a/packages/analytics/src/api.ts +++ b/packages/analytics/src/api.ts @@ -441,7 +441,7 @@ export function logEvent( * app instance on this device. * @public * See - * {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view + * {@link https://developers.google.com/analytics/devguides/collection/ga4/views * | Page views}. */ export function logEvent( diff --git a/packages/analytics/src/public-types.ts b/packages/analytics/src/public-types.ts index 09359fa0a75..188f3c097e7 100644 --- a/packages/analytics/src/public-types.ts +++ b/packages/analytics/src/public-types.ts @@ -27,17 +27,17 @@ export interface GtagConfigParams { * Whether or not a page view should be sent. * If set to true (default), a page view is automatically sent upon initialization * of analytics. - * See {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view | Page views } + * See {@link https://developers.google.com/analytics/devguides/collection/ga4/views | Page views } */ 'send_page_view'?: boolean; /** * The title of the page. - * See {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view | Page views } + * See {@link https://developers.google.com/analytics/devguides/collection/ga4/views | Page views } */ 'page_title'?: string; /** * The URL of the page. - * See {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view | Page views } + * See {@link https://developers.google.com/analytics/devguides/collection/ga4/views | Page views } */ 'page_location'?: string; /** diff --git a/packages/firebase/compat/index.d.ts b/packages/firebase/compat/index.d.ts index 3b58814f73b..4b2bc1e8a47 100644 --- a/packages/firebase/compat/index.d.ts +++ b/packages/firebase/compat/index.d.ts @@ -4959,7 +4959,7 @@ declare namespace firebase.analytics { * automatically associates this logged event with this Firebase web * app instance on this device. * See - * {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view + * {@link https://developers.google.com/analytics/devguides/collection/ga4/views * | Page views}. */ logEvent(