Skip to content

feat: support google tag manager template #45

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 8 commits into from
Mar 5, 2024
Merged

feat: support google tag manager template #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ab8c4ae
feat: add template file
Mar 1, 2024
d6d3194
ci: add tpl to release file
Mar 1, 2024
c828805
fix: change file type
Mar 1, 2024
70a78b4
fix: change file type
Mar 1, 2024
2f5932e
fix: revert ci test code
Mar 1, 2024
0e445fb
fix: revert test code
Mar 1, 2024
047751d
Merge branch 'main' into gtm-template
zhu-xiaowei Mar 5, 2024
28636ee
feat: add Google Tag Manager template usage guide
Mar 5, 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
1 change: 1 addition & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ jobs:
files: |
dist/clickstream-web.min.js
dist/clickstream-web.min.js.map
gtm-template/ClickstreamAnalytics-gtm-template.tpl
tag_name: "v${{ env.NEW_VERSION }}"
prerelease: true
generate_release_notes: true
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,19 @@ ClickstreamAnalytics.updateConfigure({
});
```

## Implementing Clickstream Web SDK in Google Tag Manager Using Template

1. Download the Clickstream SDK template file (.tpl) from the [SDK Release Page](https://github.com/awslabs/clickstream-web/releases).
2. Refer to the Google Tag Manager [Import Guide](https://developers.google.com/tag-platform/tag-manager/templates#export_and_import) for instructions on importing the .tpl file as a custom template in your tag manager console.
3. Refer to the [Use your new tag](https://developers.google.com/tag-platform/tag-manager/templates#use_your_new_tag) to add ClickstreamAnalytics tag to your container.
4. The ClickstreamAnalytics tag currently supports four tag types:
* Initialize SDK
* Record Custom Event
* Set User ID
* Set User Attribute

Note: Ensure that you initialize the SDK tag first before use other ClickstreamAnalytics tag types.

## How to integrate and test locally

### Integrate the `.tgz` file
Expand Down
Loading