HOME.en.md

---

RuStore Install Referrer Unity Plugin — an attribution tool for advertising and analytics systems

The Install Referrer SDK is an attribution tool for advertising and analytics systems. It allows you to track the number of installs of your app downloaded from RuStore via advertising links. Unity versions 6000+ are supported.

Connecting to the project

From a network location (recommended)

RuStore packages are published in the npm registry and can be added to the project via Package Manager without downloading archives manually.

1. Open the settings: Edit → Project Settings → Package Manager.
2. In the Scoped Registries section, click + and fill in the fields:
   • Name — RuStore Nexus.
   • URL — https://nexus-external.vkteam.ru/repository/npm-unity-rustore-exposed/.
   • Scopes — ru.rustore.
3. Open Window → Package Manager — the RuStore Nexus registry will appear in the list of sources.
4. Select RuStore Nexus and install the ru.rustore.installreferrer package with the Install button. The ru.rustore.core dependency will be installed automatically.

From a local location

Installation via Package Manager

1. To connect, download the packages from the releases page:
   • ru.rustore.core-version.tgz.
   • ru.rustore.installreferrer-version.tgz.
2. Import the packages into the project via Package Manager (Window → Package Manager → + → Add package from tarball…).

*Installation via .unitypackage

1. Download the RuStoreUnityInstallReferrerSDK-version.unitypackage file from the releases page.
2. Import it into the project (Assets → Import Package → Custom Package…).

Cloning the repository

To install from source code, use the cloning instructions.

For each artifact in the release, checksum (.sha256) and digital signature (.sig) files are available. These can be used to verify the integrity and authenticity of the artifact after downloading.

Tip

If you use the macOS operating system, change the archive utility settings. In the Archive Utility settings, uncheck Keep expanding if possible. Otherwise, the project archive will be downloaded incorrectly.

Project setup

To correctly handle SDK dependencies, apply the following settings.

1. Open the project settings: Edit → Project Settings → Player → Android Settings.
2. In the Publishing Settings section, enable the following settings.
   • Custom Main Manifest.
   • Custom Main Gradle Template.
   • Custom Gradle Properties Template.
3. In the Other Settings section, configure:
   • package name.
   • Minimum API Level = 24.
   • Target API Level = 34.

Adding dependencies

After installation, update the project dependencies using External Dependency Manager (Assets → External Dependency Manager → Android Resolver → Force Resolve).

Open External Dependency Manager settings: Assets → External Dependency Manager → Android Resolver → Settings, and enable the following settings:

• Use Jetifier.
• Patch mainTemplate.gradle.
• Patch gradleTemplate.properties.

VKR analytics

VKR (VK Referrer Analytics) is additional analytics that automatically sends referrer data when GetInstallReferrer() is called.

VKR works only if the following meta tag is added to the application’s AndroidManifest.xml:

<meta-data
    android:name="ru.rustore.sdk.install.referrer.ENABLE_VKR_ANALYTICS"
    android:value="true" />

SDK initialization

Before calling library methods, you must initialize the client singleton.

InstallReferrerClient.Instance.Init();

Start exploring the RuStore library documentation with the methods of the InstallReferrerClient class. Or use the online guide.

Technical support

Additional help and instructions are available in the RuStore documentation and by email at support@rustore.ru.

Distribution terms

This software, including source code, binary libraries, and other files, is distributed under the MIT license. Licensing information is available in the MIT-LICENSE document.