Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@slavkojos/react-native-google-play-install-referrer

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@slavkojos/react-native-google-play-install-referrer

Retrieve referral details on app install from play store

  • 1.0.8
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

react-native-google-play-install-referrer

Retrieve referral details on app install from Google Play.

The type of referral information we can get from Google Play by using Google Play Install Referrer:

  • The referrer URL of the installed package.
  • The timestamp, in seconds, of when a referrer click happened (both client- and server-side).
  • The timestamp, in seconds, of when an installation began (both client- and server-side).
  • The app's version at the time when the app was first installed.
  • Whether the user has interacted with your app's instant experience in the past 7 days.

Installation

npm install react-native-google-play-install-referrer

Usage

import useInstallReferrer from 'react-native-google-play-install-referrer';

export default function App() {
  const { isSuccess, isError, data, error } = useInstallReferrer();

  React.useEffect(() => {
    if (isSuccess)
      Alert.alert('Install Referrer Success', JSON.stringify(data));
    else if (isError) Alert.alert('Install Referrer Error', error);
  }, [isSuccess, isError, data, error]);
  return <></>;
}
import { getReferrer } from 'react-native-google-play-install-referrer';

export default function App() {

  React.useEffect(() => {
    try {
      const referrer = await getReferrer()
    }
    catch (err) {
      console.log(err)
    }
  }, []);
  return <></>;
}

On Success the data will have these values:

keyvalue typedescription
urlstringThe referrer URL of the installed package.
clickTimestringThe timestamp in seconds when referrer click happens.
appInstallTimestringThe timestamp in seconds when installation begins.
instantExperienceLaunchedbooleanBoolean indicating if the user has interacted with the app's instant experience in the past 7 days.

On Error it returns a Error Code used by google play installer api in error

Error Code

valuedescription
RUNTIME_EXCEPTIONError caused while constructing InstallReferrerClient
FEATURE_NOT_SUPPORTEDInstall Referrer API not supported by the installed Play Store app.
SERVICE_UNAVAILABLECould not initiate connection to the Install Referrer service.
DEVELOPER_ERRORGeneral errors caused by incorrect usage

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Keywords

FAQs

Package last updated on 15 Jun 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc