Skip to content

Commit de64028

Browse files
authored
feat: support google tag manager template (#45)
1 parent 17d59a3 commit de64028

File tree

4 files changed

+744
-0
lines changed

4 files changed

+744
-0
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ jobs:
4141
files: |
4242
dist/clickstream-web.min.js
4343
dist/clickstream-web.min.js.map
44+
gtm-template/ClickstreamAnalytics-gtm-template.tpl
4445
tag_name: "v${{ env.NEW_VERSION }}"
4546
prerelease: true
4647
generate_release_notes: true

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,19 @@ ClickstreamAnalytics.updateConfigure({
209209
});
210210
```
211211

212+
## Implementing Clickstream Web SDK in Google Tag Manager Using Template
213+
214+
1. Download the Clickstream SDK template file (.tpl) from the [SDK Release Page](https://github.com/awslabs/clickstream-web/releases).
215+
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.
216+
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.
217+
4. The ClickstreamAnalytics tag currently supports four tag types:
218+
* Initialize SDK
219+
* Record Custom Event
220+
* Set User ID
221+
* Set User Attribute
222+
223+
Note: Ensure that you initialize the SDK tag first before use other ClickstreamAnalytics tag types.
224+
212225
## How to integrate and test locally
213226

214227
### Integrate the `.tgz` file

0 commit comments

Comments
 (0)