Skip to content

chore: Add README for cookie consent configurations #228

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

Open
tyiuhc wants to merge 1 commit into
base: web/cookie-consent
Choose a base branch
from
Open

chore: Add README for cookie consent configurations #228

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 18 additions & 7 deletions packages/experiment-tag/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,24 @@

This is the Web Experimentation SDK for Amplitude Experiment.

## Generate example
## Cookie Consent Configuration

To generate an example snippet with custom flag configurations:
1. Set `apiKey` (your Amplitude Project API key), `initialFlags` and `serverZone` in `example/build_example.js`
2. Run `yarn build` to build minified UMD `experiment-tag.umd.js` and example `script.js`
To run the script with respect to cookie consent, you can pass in the `consentOptions` in the `config` object.

To test the snippet's behavior on web pages relevant to your experiment, the pages should:
1. Include `script.js`
2. Have the Amplitude Analytics SDK loaded (see [examples](https://github.com/amplitude/Amplitude-TypeScript/tree/main/packages/analytics-browser))
```js
window.experimentConfig = {
consentOptions: {
status: 0, // 0: rejected, 1: granted, 2: pending
},
};
```

If the consent status is `REJECTED`, the script will not be executed.
If the consent status is `PENDING`, the script will be executed but the data will not be persisted in the browser's local storage.
If the consent status is `GRANTED`, the script will be executed and the data will be persisted in the browser's local storage.

To update the consent status, you can call the `setConsentStatus` method on the `webExperiment` object.

```js
webExperiment.setConsentStatus(ConsentStatus.GRANTED);
```