Secondary methods

Ad impression

The event is used for individual tracking of ad revenue on user devices. The method is used if there are CPI data available on the client device (they can be obtained from the ad network SDK).

Do not apply this method if you use ad networks that utilize the server-server protocol for sending ad revenue data (ironSource, AppLovin MAX, and Fyber networks) and you already set up this method of data collection because if you use both data sources, your revenue data may be duplicated.

Parameter

Type

Restrictions

Description

network

String

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

Double

from 0,0 to Double.max

Reward for banner display in USD

placement

String?

from 1 to 100 symbols, optional

Banner placement

unit

String?

from 1 to 100 symbols, optional

Banner name

DTDAnalytics.adImpression(network: "Network name",
                          revenue: 0.15,
                          placement: "Placement of the banner",
                          unit: "Banner title")

Parameter

Type

Restrictions

Description

network

NSString

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

double

from 0,0 to Double.max

Reward for banner display in USD

placement

NSString _Nullable

from 1 to 100 symbols, optional

Banner placement

unit

NSString _Nullable

from 1 to 100 symbols, optional

Banner name

[DTDAnalytics adImpressionWithNetwork:@"Network name"
                              revenue:0.15f
                            placement:@"Placement of the banner"
                                unit:@"Banner title"];

Parameter

Type

Restrictions

Description

network

String

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

Double

from 0,0 to Double.max

Reward for banner display in USD

placement

String?

from 1 to 100 symbols, optional

Banner placement

unit

String?

from 1 to 100 symbols, optional

Banner name

DTDAnalytics.adImpression(
    network = "Network name",
    revenue = 0.45,
    placement = "Placement of the banner",
    unit = "Banner title"
)

Parameter

Type

Restrictions

Description

network

String

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

Double

from 0,0 to Double.max

Reward for banner display in USD

placement

String?

from 1 to 100 symbols, optional

Banner placement

unit

String?

from 1 to 100 symbols, optional

Banner name

DTDAnalytics.INSTANCE.adImpression(
        "Network name",
        0.45,
        "Placement of the banner",
        "Banner title"
);

Parameter

Type

Restrictions

Description

network

String

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

Double

from 0,0 to Double.max

Reward for banner display in USD

placement

String?

from 1 to 100 symbols, optional

Banner placement

unit

String?

from 1 to 100 symbols, optional

Banner name

var network = "Network name";
var revenue = 0.15;
var placement = "Placement of the banner";
var unit = "Banner title";
DTDAnalytics.AdImpression(network, revenue, placement, unit);

Parameter

Type

Restrictions

Description

network

String

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

Double

from 0,0 to Double.max

Reward for banner display in USD

placement

String?

from 1 to 100 symbols, optional

Banner placement

unit

String?

from 1 to 100 symbols, optional

Banner name

var network = "Network name";
var revenue = 0.15;
var placement = "Placement of the banner";
var unit = "Banner title";
DTDAnalytics.AdImpression(network, revenue, placement, unit);

Parameter

Type

Restrictions

Description

socialNetwork

FString

from 1 to 100 symbols

The name of the ad network that delivered the impression.

revenue

float

form 0.0 to float.MaxValue

Reward for displaying a banner in USD.

placement

FString

from 1 to 100 symbols

Placement of the banner.

unit

FString

from 1 to 100 symbols

Banner title.

UDTDAnalyticsBPLibrary::AdImpression("NetworkName", 0.36, "BannerPlacement", "BannerTitle");

Parameter

Type

Restrictions

Description

network

String

from 1 to 100 symbols

Name of the ad network responsible for the impression

revenue

Float

from 0,0 to Double.max

Reward for banner display in USD

placement

String

from 1 to 100 symbols, optional

Banner placement

unit

String

from 1 to 100 symbols, optional

Banner name

DTDAnalytics.AdImpression("Network name", 0.15, "Placement of the banner", "Banner title")

The event is used to track connections to social media channels.

Use the following constants to specify a social network:

.facebook, .vkontakte , .twitter, .googleplus, .whatsapp, .viber, .evernote, .googlemail, .linkedin, .pinterest, .qzone, .reddit, .renren, .tumblr

Or create an object with the desired social media name.

let network = DTDSocialNetwork(name: "NetworkName")
DTDAnalytics.socialNetworkConnect(socialNetwork: network)

Use the following constants to specify a social network:

.facebook, .vkontakte , .twitter, .googleplus, .whatsapp, .viber, .evernote, .googlemail, .linkedin, .pinterest, .qzone, .reddit, .renren, .tumblr

Or create an object with the desired social media name.

DTDSocialNetwork *network = [[DTDSocialNetwork alloc] initWithName:@"NetworkName"];
[DTDAnalytics socialNetworkConnect:network];

Use the following constants to specify a social network:

DTDSocialNetwork.facebook, DTDSocialNetwork.vkontakte , DTDSocialNetwork.twitter, DTDSocialNetwork.googleplus, DTDSocialNetwork.whatsapp, DTDSocialNetwork.viber, DTDSocialNetwork.evernote, DTDSocialNetwork.googlemail, DTDSocialNetwork.linkedin, DTDSocialNetwork.pinterest, DTDSocialNetwork.qzone, DTDSocialNetwork.reddit, DTDSocialNetwork.renren, DTDSocialNetwork.tumblr

Or create an object with the desired social media name.

DTDAnalytics.socialNetworkPost(
    socialNetwork = DTDSocialNetwork.facebook
)

Use the following constants to specify a social network:

DTDSocialNetwork.Companion.getFacebook(), DTDSocialNetwork.Companion.getVkontakte(), DTDSocialNetwork.Companion.getTwitter(), DTDSocialNetwork.Companion.getGoogleplus(), DTDSocialNetwork.Companion.Whatsapp(), DTDSocialNetwork.Companion.getViber(), DTDSocialNetwork.Companion.getEvernote(), DTDSocialNetwork.Companion.getGooglemail(), DTDSocialNetwork.Companion.getLinkedin(), DTDSocialNetwork.Companion.getPinterest(), DTDSocialNetwork.Companion.getQzone(), DTDSocialNetwork.Companion.getReddit(), DTDSocialNetwork.Companion.getRenren(), DTDSocialNetwork.Companion.getTumblr()

Or create an object with the desired social media name.

DTDAnalytics.INSTANCE.socialNetworkConnect(DTDSocialNetwork.Companion.getFacebook());

Use the following constants to specify a social network:

Or create an object with the desired social media name:

var network = new DTDSocialNetwork(name: "NetworkName");
DTDAnalytics.SocialNetworkConnect(socialNetwork: network);

Use the following constants to specify a social network:

Or create an object with the desired social media name:

var network = new DTDSocialNetwork(name: "NetworkName");
DTDAnalytics.SocialNetworkConnect(socialNetwork: network);

Argument

Type

Description

socialNetwork

EDTDSocialNetwork

Predefined social network.

UDTDAnalyticsBPLibrary::SocialNetworkConnect(EDTDSocialNetwork::Linkedin);

Or use special method for custom social network:

UDTDAnalyticsBPLibrary::SocialNetworkConnectCustom("SocialNetworkName");

Argument

Type

Description

socialNetwork

FString

Custom social network.

Use the following constants to specify a social network:

.facebook, .vkontakte , .twitter, .googleplus, .whatsapp, .viber, .evernote, .googlemail, .linkedin, .pinterest, .qzone, .reddit, .renren, .tumblr

DTDAnalytics.SocialNetworkConnect(GDDTDSocialNetwork.Facebook())

Or create an object with the desired social media name.

let network = GDDTDSocialNetwork(name: "NetworkName")
DTDAnalytics.SocialNetworkConnect(network)

Track social media posts and analyze their effectiveness and virality. Pass the event after the post has been approved by social media.

DTDAnalytics.socialNetworkPost(socialNetwork: .facebook, 
                                      reason: "New level reached")

Argument

Type

Description

socialNetwork

EDTDSocialNetwork

Predefined social network.

UDTDAnalyticsBPLibrary::SocialNetworkPost(EDTDSocialNetwork::Linkedin, "PostReason");

Argument

Type

Description

socialNetwork

FString

Custom social network.

UDTDAnalyticsBPLibrary::SocialNetworkPostCustom("SocialNetworkName", "PostReason");

Referrer

If you have referral information, you can pass it using the following method:

let referrerData = [DTDReferralProperty.source: "AdWords",
                    DTDReferralProperty.medium: "CPI",
                    DTDReferralProperty.content: "Snow Boots",
                    DTDReferralProperty.campaign: "Warm Snow Boots",
                    DTDReferralProperty.term: "shoes+boots"]
                    
DTDAnalytics.referrer(utmData: referrerData)

NSDictionary <DTDReferralProperty *, NSString *> * referrerData = @{
  DTDReferralProperty.source: @"AdWords",
  DTDReferralProperty.medium: @"CPI",
  DTDReferralProperty.content: @"Snow Boots",
  DTDReferralProperty.campaign: @"Warm Snow Boots",
  DTDReferralProperty.term: @"shoes+boots",
};
[DTDAnalytics referrer:referrerData];

enum class DTDReferralProperty {
    Source,
    Campaign,
    Content,
    Medium,
    Term;
}

val referrer = mapOf(
        DTDReferralProperty.Medium to "some value",
        DTDReferralProperty.Campaign to "some value"
)    
DTDAnalytics.referrer(utmData = referrer)

public final enum class DTDReferralProperty {
    Source,
    Campaign,
    Content,
    Medium,
    Term;
}

Map<DTDReferralProperty, String> propertyStringHashMap = new HashMap<>();
propertyStringHashMap.put(DTDReferralProperty.Medium, "some value");
propertyStringHashMap.put(DTDReferralProperty.Campaign, "some value");
DTDAnalytics.INSTANCE.referrer(propertyStringHashMap);

var referrer = new Dictionary<DTDReferralProperty, string>
{
    [DTDReferralProperty.Medium] = "some value",
    [DTDReferralProperty.Campaign] = "some value"
};
DTDAnalytics.Referrer(referrer: referrer);

var referrer = new Dictionary<DTDReferralProperty, string>
{
    [DTDReferralProperty.Medium] = "some value",
    [DTDReferralProperty.Campaign] = "some value"
};
DTDAnalytics.Referrer(referrer: referrer);

var referrer = {
    source: "some source",
    term: "some term",
    medium: "some medium",
    source: "some source",
    content: "some content",
    campaign: "some campaign",
};
window.devtodev.referrer(referrer)

Argument

Type

Description

utmData

TMap<EDTDReferralProperty, FString>

UTM data.

TMap<EDTDReferralProperty, FString> referrer;
referrer.Add(EDTDReferralProperty::Source, "Source");
referrer.Add(EDTDReferralProperty::Medium, "Medium ");
referrer.Add(EDTDReferralProperty::Content, "Content ");
referrer.Add(EDTDReferralProperty::Campaign, "Campaign ");
referrer.Add(EDTDReferralProperty::Term, "Term ");
UDTDAnalyticsBPLibrary::Referrer(referrer);

var reffer = GDDTDReferralProperty.new()
reffer.AddCampaign("Warm Snow Boots")
reffer.AddContent("Snow Boots")
reffer.AddMedium("CPI")
reffer.AddSource("AdWords")
reffer.AddTerm("shoes+boots")

DTDAnalytics.Referrer(reffer)

Force dispatch of accumulated events

To send an event packet before it is full (10 events, by default) or before the end of the period of its formation (2 minutes, by default), you can use immediate dispatch.

We don’t recommend using this method unless absolutely necessary! When the Real payment event is created, the forced dispatch of the packet occurs automatically.

DTDAnalytics.sendBufferedEvents()

Setters & Getters

When working with getters you should take into account that the new devtodev SDK is completely asynchronous. The execution result must be processed within the completionHandler.

All set and get methods need to be called only after the initialization of the SDK.

It is also worth remembering that the SDK will call the callback in background queues, so we recommend that you transfer the processing of return values to the queue you need.

For example:

DispatchQueue.main.async{}

Argument

Type

Description

onResult

FAnalyticsDynamicGetterStringDelegate
FDTDGetterStringDelegate

Callback.

auto onResult = new FDTDGetterStringDelegate();
onResult->BindLambda([](const FString& value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::GetUserId(*onResult);

This method denies/allows tracking of user data and also implements the right to be forgotten in accordance with the requirements of the GDPR.

When this method is called with the 'false' value, the SDK sends a command to the server to delete all personal user data that was collected by devtodev in this application, blocking further user data collection.

The user will remain in the devtodev system only as an impersonal unit in the previously aggregated metrics.

If it is set to ‘true', tracking can be enabled again. In this case, the user will be considered new.

To enable/disable user tracking by the devtodev system. Bool type.

DTDAnalytics.setTrackingAvailability(value: true)

Getting device ID

Get device ID. String type.

DTDAnalytics.getDeviceId { deviceId in
  // your code
}

Argument

Type

Description

onResult

FAnalyticsDynamicGetterStringDelegate
FDTDGetterStringDelegate

Callback.

auto onResult = new FDTDGetterStringDelegate();
onResult->BindLambda([](const FString& value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::GetDeviceId(*onResult);

Getting the devtodev SDK version

Get the version of the integrated devtodev SDK. String type.

DTDAnalytics.getSDKVersion { sdkVersion in
  // your code
}

Argument

Type

Description

onResult

FAnalyticsDynamicGetterStringDelegate
FDTDGetterStringDelegate

Callback.

// Some codecauto onResult = new FDTDGetterStringDelegate();
onResult->BindLambda([](const FString& value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::GetSdkVersion(*onResult);

Retrieving the saved state of the user tracking permission by the devtodev system. See “Setting User Tracking Status”. Bool type.

DTDAnalytics.getTrackingAvailability { trackingAvailability in
  // your code
}

Argument

Type

Description

onResult

FAnalyticsDynamicGetterBoolDelegate
FDTDGetterBoolDelegate

Callback.

auto onResult = new FDTDGetterBoolDelegate();
onResult->BindLambda([](bool value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::GetTrackingAvailability(*onResult);

Getting devtodev ID

devtodev ID is the primary numeric identifier for the device/user account in the devtodev database. Using devtodev ID, you are sure to find the user in devtodev.

The identifier will be received from the server some time after the initialization of the SDK.

If you have set counting by users, a separate devtodev id will be issued for each device user.

To obtain the devtodev ID, you need to pass the listener to DTDAnalytics:

DTDAnalytics.setIdentifiersListener(listener: self)

The delegate must implement the func didReceiveDevtodevId(with devtodevId: Int)

func didReceiveDevtodevId(with devtodevId: Int) {
  /// your code
}

The didReceiveDevtodevId method will be called with every ID change on the server side.

To obtain the devtodev ID, you need to pass the listener to DTDAnalytics:

@interface Controller ()  <DTDIdentifiersListener>
[DTDAnalytics setIdentifiersListenerWithListener:self];

The delegate must implement the (void)didReceiveDevtodevIdWith:(NSInteger)devtodevId;

- (void)didReceiveDevtodevIdWith:(NSInteger)devtodevId {
  // your code
}

The didReceiveDevtodevId method will be called with every ID change on the server side.

To obtain the devtodev ID, you need to pass the DTDIdentifiersListener listener to DTDAnalytics:

DTDAnalytics.setIdentifiersListener(object : DTDIdentifiersListener {
            override fun didReceiveDevtodevId(devtodevId: Long) {
               /// your code
            }
        })

The didReceiveDevtodevId method will be called with every ID change on the server side.

To obtain the devtodev ID, you need to pass the DTDIdentifiersListener listener to DTDAnalytics:

DTDAnalytics.INSTANCE.setIdentifiersListener(new DTDIdentifiersListener() {
            @Override
            public void didReceiveDevtodevId(long devtodevId) {
                // your code
            }
});

The didReceiveDevtodevId method will be called with every ID change on the server side.

To obtain the devtodev ID, you need to pass the DTDIdentifiersListener listener delegate to DTDAnalytics:

DTDAnalytics.SetIdentifiersListener(devtodevId =>
{
    // Your code...
});

The delegate method will be called with every ID change on the server side.

To obtain the devtodev ID, you need to pass the DTDIdentifiersListener listener delegate to DTDAnalytics:

DTDAnalytics.SetIdentifiersListener(devtodevId =>
{
    // Your code...
});

The delegate method will be called with every ID change on the server side.

Argument

Type

Description

listener

FAnalyticsDynamicGetterLongDelegate
FDTDGetterLongDelegate

devtodev ID Listener.

auto listener = new FDTDGetterLongDelegate();
listener->BindLambda([](int64 value)
{
	// Your code...
});
UDTDAnalyticsBPLibrary::SetIdentifiersListener(*listener);

To obtain the devtodev ID, you need to pass the Callable to DTDAnalytics:

DTDAnalytics.SetIdentifiersCallback(identifiersUpdated)

func identifiersUpdated(devtodevID: int):
    print("SetIdentifiersCallback DevtodevID is " + str(devtodevID))

The didReceiveDevtodevId method will be called with every ID change on the server side.

Initialization callback

To receive a callback when the SDK initialization is complete, you can use a method that will implement the initialization callback. When the SDK completes the initialization, the callback will be called on the main application thread.

We recommend implementing a callback before calling initialization.

DTDAnalytics.setInitializationCompleteCallback {
  print("Initialized has been finished.")
}
let config = DTDAnalyticsConfiguration()
config.logLevel = .error
DTDAnalytics.initialize(applicationKey: "App ID", configuration: config)

[DTDAnalytics setInitializationCompleteCallback:^{
  NSLog(@"%@", @"Initialized has been finished.");
}];
DTDAnalyticsConfiguration *config = [[DTDAnalyticsConfiguration alloc] init];
config.logLevel = DTDLogLevelError;
[DTDAnalytics applicationKey:@"App ID" configuration:config];

DTDAnalytics.setInitializationCompleteCallback {
    Log.d("TAG", "Initialized has been finished.")
}
val config = DTDAnalyticsConfiguration()
config.logLevel = DTDLogLevel.Error
DTDAnalytics.initialize(appKey = "App ID", analyticsConfiguration = config, context = this)

DTDAnalytics.INSTANCE.setInitializationCompleteCallback(() -> {
    Log.d("TAG", "Initialized has been finished.");
    return null;
});
DTDAnalyticsConfiguration config = new DTDAnalyticsConfiguration();
config.setLogLevel(DTDLogLevel.Error);
DTDAnalytics.INSTANCE.initialize("App ID", config, this);

func initCompleteCallback():
  print("Initialized has been finished.")

func _ready():
  DTDAnalytics.SetInitializationCompleteCallback(initCompleteCallback)
  var config = GDDTDAnalyticsConfiguration.new()
  config.logLevel = GDDTDLogLevel.Error
  DTDAnalytics.InitializeWithConfig(appKey, config)

PreviousBasic methods NextUser profile

Last updated 1 year ago

Was this helpful?

Ad impression

Connecting to social networks

Posting to social networks

Referrer

Force dispatch of accumulated events

Setters & Getters

Setting User Tracking Status (GDPR)

Getting device ID

Getting the devtodev SDK version

Obtaining user tracking status (GDPR)

Getting devtodev ID

Initialization callback