Skip to content

[Analytics] Add ad_personalization and ad_user_data constent settings #7975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 26, 2024
Merged

[Analytics] Add ad_personalization and ad_user_data constent settings #7975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ec946a0
added fields to structure
DellaBitta Nov 14, 2023
27f6ecd
Merge branch 'master' into ddb-analytics-update
DellaBitta Nov 29, 2023
1aa346e
ad_user_storage->ad_user_data
DellaBitta Nov 29, 2023
b91c825
Merge branch 'master' into ddb-analytics-update
DellaBitta Jan 8, 2024
98d6bac
Merge branch 'master' into ddb-analytics-update
DellaBitta Jan 23, 2024
17e493e
added comments pulled from public docs
DellaBitta Jan 23, 2024
0accb46
Update API reports
DellaBitta Jan 23, 2024
8ba754d
docgen results
DellaBitta Jan 23, 2024
f49580a
Merge remote-tracking branch 'refs/remotes/origin/ddb-analytics-updat…
DellaBitta Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions common/api-review/analytics.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
22 changes: 22 additions & 0 deletions docs-devsite/analytics.consentsettings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

```typescript
ad_personalization?: ConsentStatusString;
```

## ConsentSettings.ad\_storage

Enables storage, such as cookies, related to advertising
Expand All @@ -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.

<b>Signature:</b>

```typescript
ad_user_data?: ConsentStatusString;
```

## ConsentSettings.analytics\_storage

Enables storage, such as cookies, related to analytics (for example, visit duration)
Expand Down
4 changes: 4 additions & 0 deletions packages/analytics/src/public-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down