Microsoft.BingAds.UETSdk.Win32 1.3.6

Microsoft.BingAds.UETSdk.Win32

Overview

Welcome to the Bing Ads UET (Universal Event Tracking) SDK! This SDK allows you to integrate UET tracking into your Win32 applications developed in C++ or .NET. UET enables you to track and measure user interactions and events, allowing you to gain valuable insights and optimize your application's performance.

Documentation

For detailed instructions and comprehensive documentation on the UET SDK, please refer to the official UET SDK documentation.

The documentation provides information on:

• SDK initialization and configuration options.
• Methods and APIs for event tracking.
• Custom event creation.
• Retrieving and analyzing event data.

Using the UET SDK

Prerequisites

The UET SDK requires the latest version of the Microsoft Visual C++ Redistributable. Depending on your application's distribution and packaging model, there are several options to ensure the latest Visual C++ Runtime is available on the target machine.

The C++ UET SDK library supports Visual Studio 2017 and newer versions.

The UET SDK has been tested on Windows 10 version 1507 and later.

Initialize UET SDK at application level on app launch

First, we initialize the SDK with three arguments:

1. registryKey A globally unique name for your app.
2. productId Your Microsoft Store product ID.
3. tagId Your UET tag ID.

The definition for this constructor is:

C++ Sample Code

UETSdk(const std::wstring &registryKey, const std::wstring &productId, long tagId);

For example, assume we have an app named ContosoDesktop with store ID 88888ASDF and UET tag ID 123456, then in app launch we would create the UET SDK instance like:

//include header file
#include <UETSdk.h>

// Defined elsewhere
using namespace Microsoft::BingAds::UETSdkWin32;

UETSdk* uetSdk = NULL;

// At app launch, create the UET SDK instance
uetSdk = new UETSdk(L"ContosoDesktop", L"88888ASDF", 123456);

Track event goals in your app

uetSdk->TrackGoal(L"click", L"Buy Coins", L"Other", 5, L"USD");

Get ClickId if the app is installed via ad campaign

⚠️ Caution: Avoid using the API immediately after initialization, make use of GetClickId later in the application lifecycle.

std::wstring clickId = uetSdk->GetClickId();

C# .Net Sample Code

using Microsoft.BingAds.UETSdk;
....
UETSdk sdk = new UETSdk("your_registry_key","your_product_ID", your_UET_tag_ID);

sdk.TrackGoal("click", "Buy Coins", "Other", 5, "USD");
...

Remove the registry when uninstalling

The UET SDK reads and writes to the registry at HKEY_CURRENT_USER\Software\{registryKey} to determine first app launch.

You must clean up the registry at HKEY_CURRENT_USER\Software\{registryKey} when uninstalling your application.

If the registry is not cleaned up, the SDK will not send the firstLaunch event when the app is reinstalled and opened.

Troubleshooting SDK

SDK logs all important events to EventViewer under Windows Logs -> Application.

Notes on registry

• {registryKey} is the name of your application passed in when creating the UET SDK. For instance, if you set registryKey as ContosoDesktop, as in the example above, then the registry path is HKEY_CURRENT_USER\Software\ContosoDesktop.
• HKEY_CURRENT_USER is for the user currently logged into Windows. By using this path the app does not need to be run as administrator to modify the registry.