For the complete documentation index, see llms.txt. This page is also available as Markdown.

TossAds Pixel Integration

If you are using Toss Ads, you can install Toss Pixel in the Apps in Toss mini app to collect conversion events. Based on the collected data, you can optimize ad performance.

Toss Pixel only works in a Web environment

It is not supported in React Native environments.

1. Get a conversion tracking code

Please log in to the Toss Ads Console with the account you were given.

Please select Ads Tools > Conversion and Tracking Integration menu.

Please create a conversion tracking code. Conversion tracking codes are issued per ad account.

Please copy the generated conversion tracking code ID.

2. Install the pixel script

To use the pixel, add the script below to the HTML's inside <head>, section.

3. Integrate events

To collect accurate data, you need to call pixel events according to when the event occurs.

Use one conversion tracking code

You can manage all events with a single conversion tracking code.

Category
Event name
Event label

Payment

Payment product detail page view

PRODUCT_VIEW

Payment completed

PURCHASE

First purchase completed

FIRST_PURCHASE

Subscription completed

SUBSCRIBE

Ads

In-app ad impression

AD_IMPRESSION

Login

Toss Login completed

SIGNIN

Page view

Conversion-driving page view

PAGE_VIEW

Custom

Custom event

-

4. How to integrate by event

Payment

If you use in-app payments or Toss Pay, you can collect payment data.

Payment product detail page view(PRODUCT_VIEW)

Please call it when the product detail page is viewed.

Payment completed(PURCHASE)

Please call it immediately after the payment is successfully completed.

First purchase completed(FIRST_PURCHASE)

Please call it when the user's first purchase is completed.

Subscription completed(SUBSCRIBE)

Please call it when the subscription payment begins.


Ads

In-app ad impression(AD_IMPRESSION)

When the ad is displayed (e.g., show call immediately after the function call).


Login

Toss Login completed(SIGNIN)

Please call it when Toss Login is completed.


Page view

Conversion-driving page view(PAGE_VIEW)

Please call it when a specific page is visited. It is useful for measuring pages closely related to conversions.


Custom event

It is used to track conversions that do not fall under standard events. You can define the event name freely.


Custom properties

You can add custom_param1 to custom_param5 to all events (standard events, custom events).

It is used to pass additional information that is hard to express with standard parameters. For example, you can include campaign identifiers, promotion codes, A/B test groups, traffic sources, and more.


5. Test it

With Toss Pixel Helper, you can check whether pixel events work correctly in a local environment.

Install Toss Pixel Helper

Toss Pixel Helper is a Chrome extension that lets you check whether the Toss Pixel installed on your website is working properly.

  • It automatically detects websites where Toss Pixel is installed.

  • You can check in real time whether events such as payments, ads, and logins are being collected.

Toss Pixel Helper Chrome extension on the page Add to Chrome Please click the button to install it.

Check in the Chrome browser

  1. Please run the project with the command below.

  1. Please access the local service in the Chrome browser.

    http://localhost:5173

  2. Please click the Toss Pixel Helper icon at the top right of the browser.

  3. If Toss Pixel is installed correctly, a list of events being collected (PURCHASE, PAGE_VIEW, etc.) will be displayed. You can also check whether events are being sent and whether parameters (amount, ID, etc.) are included.


Frequently asked questions

If the SDK script fails to load, does it affect the mini app?

No, it doesn't. If SDK loading fails, only TossPixel calls are ignored, and it does not affect the normal operation of the mini app.

If I refresh on the purchase completion page, will the event be sent twice?

It may be sent twice. You need to prevent duplicate calls based on the order ID.

Do I need to send parameters?

Yes. All parameters are optional. It will be collected properly even if you only call the method.

However, if you send the parameters together, you can analyze ad performance more accurately.

Last updated

Was this helpful?