https://github.com/stape-io/tiktok-tag

TikTok Events API Tag for Google Tag Manager Server Side
https://github.com/stape-io/tiktok-tag

gtm gtm-custom-template gtm-server-side stape tiktok tiktok-api

Last synced: 7 months ago
JSON representation

TikTok Events API Tag for Google Tag Manager Server Side

• Host: GitHub
• URL: https://github.com/stape-io/tiktok-tag
• Owner: stape-io
• License: apache-2.0
• Created: 2021-07-26T17:22:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T19:25:14.000Z (almost 2 years ago)
• Last Synced: 2025-03-28T04:52:20.535Z (over 1 year ago)
• Topics: gtm, gtm-custom-template, gtm-server-side, stape, tiktok, tiktok-api
• Language: Smarty
• Homepage: https://stape.io/blog/how-to-set-up-tiktok-events-api
• Size: 265 KB
• Stars: 13
• Watchers: 8
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# TikTok Events API Tag for Google Tag Manager Server Container

The **TikTok Events API** tag for Google Tag Manager server container allows sending site or app events and parameters directly to TikTok server using [TikTok Events API](https://ads.tiktok.com/marketing_api/docs?rid=959icq5stjr&id=1701890979375106).

It can be used to track conversion events, collect custom audiences, dynamic product ads, campaigns optimization.

## How to use TikTok tag

The **TikTok Events API tag for GTM Server Side** allows sending user data (email, phone number, user ID, user IP, and user agent), properties, objects, and event parameters.

It automatically converts the required information to lowercase and hashes it using SHA-256.

- More about the [TikTok Events API](https://business-api.tiktok.com/portal/docs?id=1771100779668482).

- Detailed description of the [TikTok event API tag for the GTM server](https://stape.io/how-to-set-up-tiktok-events-api/)

### Getting started

1. Add **TikTok Events API tag** to the Google Tag Manager server container.

2. Create a Data Source in TikTok Events Manager.

3. Add the required parameters to the **TikTok Events API tag** tag inside the server GTM.

More detailed description of setting up the [TikTok events API tag in the sGTM](https://stape.io/how-to-set-up-tiktok-events-api/).

### Supported events

- `AddPaymentInfo`

- `AddToCart`

- `AddToWishlist`

- `ApplicationApproval`

- `CompleteRegistration`

- `Contact`

- `CustomizeProduct`

- `Download`

- `FindLocation`

- `InitiateCheckout`

- `Lead`

- `Pageview`

- `Purchase`

- `Schedule`

- `Search`

- `StartTrial`

- `SubmitApplication`

- `Subscribe`

- `ViewContent`

- `CompletePayment` (legacy - Use `Purchase` instead)

- `SubmitForm` (legacy - Use `Lead` instead)

- `ClickButton` (deprecated)

- `PlaceAnOrder` (deprecated)

## Open Source

The **TikTok Events API Tag for GTM Server Side** is developed and maintained by the [Stape Team](https://stape.io/) under the Apache 2.0 license.