Install Referrer Library Reference | Samsung Developer 2025-01-05, 6:39 PM

Samsung Wallet
Search Dashboard
Dashboard
Galaxy
Galaxy
News
Code
See
Design
Forums
allLab
andStore
Store
mobile
System
Updates
products
Dev
Foldables
Support
One
TV Seller
Events
UI
and Office
Large
Remote
One
Screens
Samsung
UI Watch
Test
Galaxy
LabDeveloper
Store
OneSmart
UI
Games
Samsung
Beta
Conference
TV Android
Instant
USB Plays
Driver Galaxy Emulator Skin
Learn
Learn Develop
Develop Design
Design Distribute
Distribute Support
Support Connect
Connect Blog
Blog

Galaxy
Galaxy Store
Store Overview Docs

Filter Galaxy Store / Install Referrer Library Guide On This Page

Classes

Install Referrer Library Interface

Response

Reference
Install
Install Referrer
Referrer Library
Library Guide
Guide

Overview

Usage

Reference
Classes
InstallReferrerClient - Main interface for communication between the library and user application
code.
InstallReferrerClient.Builder - Builder to configure and create an InstallReferrer instance.
ReferrerDetails - Represents the install referrer information.
SInstallReferrer - SInstallReferrer SDK version code and version name.

InstallReferrerClient

Method Type Description

Close the connection and

release all held resources,
such as service
connections, in order to
endConnection() abstract void avoid leaks and
performance problems.
Used after the install
referrer information is
obtained.

Get install referrer

getInstallReferrer() abstract ReferrerDetails
information.

Verifies that the client is

currently connected to the
isReady() abstract boolean service so that requests to
other methods will
succeed.

Constructs a new
static
newBuilder(Context context) InstallReferrerClient.Builder
InstallReferrerClient.Builder
instance.

Starts the

https://developer.samsung.com/galaxy-store/login/install-referrer/reference.html Page 1 of 3
Install Referrer Library Reference | Samsung Developer 2025-01-05, 6:39 PM

startConnection(InstallReferrerStateListener abstract void InstallReferrerClient setup

listener) process ssynchronously.

InstallReferrerClient.Builder

Method Type Description

Creates an install referrer client instance.

build() InstallReferrerClient After creation, the client will not be ready to use. You must initiate the
setup by calling startConnection(InstallReferrerStateListener)
and waiting for the setup to complete.

ReferrerDetails

Method Type Description

The referrer content in the URL used by the customer to

getInstallReferrer() string
access your app’s detail page in Galaxy Store.

The timestamp, in seconds, when the install button in

getReferrerClickTimestampSeconds() long
your app’s detail page is clicked by the customer.

The timestamp, in seconds, when installation of your

getInstallBeginTimestampSeconds() long
app begins.

SInstallReferrer

Method Type Description

getVersionCode() static int SDK versionCode.

getVersionName() static string SDK version.

Interface
InstallReferrerStateListener - Callback for the setup process.

InstallReferrerStateListener

Method Type Description

abstract Called to check if the connection to install referrer

onInstallReferrerServiceDisconnected()
void service has been lost.

https://developer.samsung.com/galaxy-store/login/install-referrer/reference.html Page 2 of 3
Install Referrer Library Reference | Samsung Developer 2025-01-05, 6:39 PM

Called to check if the connection setup has

completed.
onInstallReferrerSetupFinished(int abstract
responseCode) void responseCode:
InstallReferrerClient.InstallReferrerRespon
se which returns the status of the setup process.

Response codes
InstallReferrerClient.InstallReferrerResponse - Install referrer return codes

InstallReferrerClient.InstallReferrerResponse

Response Code Type Value Description

The connection with the Install Referrer client has

OK int 0
succeeded.

Could not initiate the connection to the Install

SERVICE_UNAVAILABLE int 1 Referrer service. Samsung recommends you try to
connect 2-3 more times before giving up.

The Install Referrer service is not supported by the

Galaxy Store app on this device. The Install
FEATURE_NOT_SUPPORTED int 2
Referrer service is supported on Galaxy Store
version 4.5.20.1 or higher.

There was an error caused by incorrect usage of

DEVELOPER_ERROR int 3
the Install Referrer API.

Quick Link Family Site Legal

Samsung Developer

Android USB Driver Remote Test Lab Bixby Samsung Research Terms

Code Lab Dev Support Knox Samsung Open Source Privacy

Galaxy Emulator Skin SmartThings Samsung Dev Spain Open Source License

Foldables and Large Screens Tizen Cookie

Copyright © 2025 SAMSUNG. All rights reserved.

https://developer.samsung.com/galaxy-store/login/install-referrer/reference.html Page 3 of 3