From ec946a0450258acbde82ef005ee47816a46c1cc4 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Tue, 14 Nov 2023 16:47:00 -0500 Subject: [PATCH 1/5] added fields to structure --- packages/analytics/src/public-types.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/analytics/src/public-types.ts b/packages/analytics/src/public-types.ts index 930ba17b1eb..eca99afa78b 100644 --- a/packages/analytics/src/public-types.ts +++ b/packages/analytics/src/public-types.ts @@ -299,6 +299,10 @@ export interface EventParams { export interface ConsentSettings { /** Enables storage, such as cookies, related to advertising */ ad_storage?: ConsentStatusString; + /** */ + ad_user_storage?: ConsentStatusString; + /** */ + ad_personalization?: ConsentStatusString; /** Enables storage, such as cookies, related to analytics (for example, visit duration) */ analytics_storage?: ConsentStatusString; /** From 1aa346ebf3ef402e146ddaecb7206afb57aa2740 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Wed, 29 Nov 2023 09:15:04 -0500 Subject: [PATCH 2/5] ad_user_storage->ad_user_data --- packages/analytics/src/public-types.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/analytics/src/public-types.ts b/packages/analytics/src/public-types.ts index eca99afa78b..c2e4531b23a 100644 --- a/packages/analytics/src/public-types.ts +++ b/packages/analytics/src/public-types.ts @@ -300,7 +300,7 @@ export interface ConsentSettings { /** Enables storage, such as cookies, related to advertising */ ad_storage?: ConsentStatusString; /** */ - ad_user_storage?: ConsentStatusString; + ad_user_data?: ConsentStatusString; /** */ ad_personalization?: ConsentStatusString; /** Enables storage, such as cookies, related to analytics (for example, visit duration) */ From 17e493e8533ae2bca4f79dd9225008d7fe6b33e7 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Tue, 23 Jan 2024 08:17:57 -0500 Subject: [PATCH 3/5] added comments pulled from public docs --- packages/analytics/src/public-types.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/analytics/src/public-types.ts b/packages/analytics/src/public-types.ts index c2e4531b23a..09359fa0a75 100644 --- a/packages/analytics/src/public-types.ts +++ b/packages/analytics/src/public-types.ts @@ -299,9 +299,9 @@ export interface EventParams { export interface ConsentSettings { /** Enables storage, such as cookies, related to advertising */ ad_storage?: ConsentStatusString; - /** */ + /** Sets consent for sending user data to Google for advertising purposes. */ ad_user_data?: ConsentStatusString; - /** */ + /** Sets consent for personalized advertising. */ ad_personalization?: ConsentStatusString; /** Enables storage, such as cookies, related to analytics (for example, visit duration) */ analytics_storage?: ConsentStatusString; From 0accb466894259cbe2a4d0bb155e2f5c0cf008a7 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Tue, 23 Jan 2024 13:32:52 +0000 Subject: [PATCH 4/5] Update API reports --- common/api-review/analytics.api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/common/api-review/analytics.api.md b/common/api-review/analytics.api.md index 7b6e9cfb182..58cb8d4a0ce 100644 --- a/common/api-review/analytics.api.md +++ b/common/api-review/analytics.api.md @@ -25,7 +25,9 @@ export interface AnalyticsSettings { export interface ConsentSettings { // (undocumented) [key: string]: unknown; + ad_personalization?: ConsentStatusString; ad_storage?: ConsentStatusString; + ad_user_data?: ConsentStatusString; analytics_storage?: ConsentStatusString; functionality_storage?: ConsentStatusString; personalization_storage?: ConsentStatusString; From 8ba754d1123dff80cbb5c936ef06f13b8e65c1e9 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Tue, 23 Jan 2024 09:00:52 -0500 Subject: [PATCH 5/5] docgen results --- common/api-review/analytics.api.md | 2 ++ docs-devsite/analytics.consentsettings.md | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/common/api-review/analytics.api.md b/common/api-review/analytics.api.md index 7b6e9cfb182..58cb8d4a0ce 100644 --- a/common/api-review/analytics.api.md +++ b/common/api-review/analytics.api.md @@ -25,7 +25,9 @@ export interface AnalyticsSettings { export interface ConsentSettings { // (undocumented) [key: string]: unknown; + ad_personalization?: ConsentStatusString; ad_storage?: ConsentStatusString; + ad_user_data?: ConsentStatusString; analytics_storage?: ConsentStatusString; functionality_storage?: ConsentStatusString; personalization_storage?: ConsentStatusString; diff --git a/docs-devsite/analytics.consentsettings.md b/docs-devsite/analytics.consentsettings.md index 975d51d8bc6..9e01460a31a 100644 --- a/docs-devsite/analytics.consentsettings.md +++ b/docs-devsite/analytics.consentsettings.md @@ -22,12 +22,24 @@ export interface ConsentSettings | Property | Type | Description | | --- | --- | --- | +| [ad\_personalization](./analytics.consentsettings.md#consentsettingsad_personalization) | [ConsentStatusString](./analytics.md#consentstatusstring) | Sets consent for personalized advertising. | | [ad\_storage](./analytics.consentsettings.md#consentsettingsad_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to advertising | +| [ad\_user\_data](./analytics.consentsettings.md#consentsettingsad_user_data) | [ConsentStatusString](./analytics.md#consentstatusstring) | Sets consent for sending user data to Google for advertising purposes. | | [analytics\_storage](./analytics.consentsettings.md#consentsettingsanalytics_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to analytics (for example, visit duration) | | [functionality\_storage](./analytics.consentsettings.md#consentsettingsfunctionality_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage that supports the functionality of the website or app such as language settings | | [personalization\_storage](./analytics.consentsettings.md#consentsettingspersonalization_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to personalization such as video recommendations | | [security\_storage](./analytics.consentsettings.md#consentsettingssecurity_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to security such as authentication functionality, fraud prevention, and other user protection. | +## ConsentSettings.ad\_personalization + +Sets consent for personalized advertising. + +Signature: + +```typescript +ad_personalization?: ConsentStatusString; +``` + ## ConsentSettings.ad\_storage Enables storage, such as cookies, related to advertising @@ -38,6 +50,16 @@ Enables storage, such as cookies, related to advertising ad_storage?: ConsentStatusString; ``` +## ConsentSettings.ad\_user\_data + +Sets consent for sending user data to Google for advertising purposes. + +Signature: + +```typescript +ad_user_data?: ConsentStatusString; +``` + ## ConsentSettings.analytics\_storage Enables storage, such as cookies, related to analytics (for example, visit duration)