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) diff --git a/packages/analytics/src/public-types.ts b/packages/analytics/src/public-types.ts index 930ba17b1eb..09359fa0a75 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; + /** 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; /**