InstallReferrer (tracker 3.10.1 API)

java.lang.Object
- com.kochava.base.InstallReferrer

```
public final class InstallReferrer
extends java.lang.Object
```
Install Referrer.
The Google Install Referrer is based on information obtained from the Google Play Store about the app install. In many cases this indicates the Google Play Store thinks the install was organic but it can also include campaign data for attribution or a deferred deep link.
This information is made available to the host app for convenience purposes for dealing with deferred deep links and is typically available within a couple seconds of Tracker configuration.
Two methods of retrieving the Install Referrer exist. The legacy method using a Broadcast Receiver and the current API that uses the installreferrer library. The Kochava Tracker supports both methods with priority given to the new API with a fallback to the legacy version.

See Also:

Tracker.getInstallReferrer()

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InstallReferrer.InstallReferrerStatus
Install Referrer status messages.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstallReferrer.InstallReferrerStatus` Install Referrer status messages.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`attemptCount` Number of attempts it took to retrieve the install referrer.
`double`	`duration` Total amount of time (seconds) across all attempts that it took to retrieve the install referrer.
`java.lang.Boolean`	`googlePlayInstant` Boolean indicating if the user has interacted with the app's instant experience in the past 7 days.
`long`	`installBeginServerTime` Unix Timestamp for when the install began server-side in seconds.
`long`	`installBeginTime` Unix Timestamp for when the install began in seconds.
`java.lang.String`	`installVersion` The app's version at the time when the app was first installed.
`boolean`	`isLegacy` Indicates that this install referrer came from the legacy Broadcast Receiver.
`static java.lang.String`	`KEY_ATTEMPT_COUNT`
`static java.lang.String`	`KEY_DURATION`
`java.lang.String`	`referrer` The install referrer.
`long`	`referrerClickServerTime` Unix Timestamp for the ad click server-time in seconds.
`long`	`referrerClickTime` Unix Timestamp for the ad click in seconds.
`int`	`status` Status of this install referrer.
`static int`	`STATUS_DEVELOPER_ERROR` An error occurred with the implementation.
`static int`	`STATUS_FEATURE_NOT_SUPPORTED` Service is not supported on this device.
`static int`	`STATUS_MISSING_DEPENDENCY` An exception indicating the required google dependency is missing from the app.
`static int`	`STATUS_NOT_GATHERED` An attempt to gather has not yet been made.
`static int`	`STATUS_OK` Install Referrer data is valid.
`static int`	`STATUS_SERVICE_DISCONNECTED` The service got disconnected while attempting to gather.
`static int`	`STATUS_SERVICE_UNAVAILABLE` Service unavailable at this moment.
`static int`	`STATUS_TIMED_OUT` A timeout occurred when attempting to gather.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isGathered()` Returns if an install referrer gather attempt has been made.
`boolean`	`isSupported()` Returns if the install referrer is supported on this device.
`boolean`	`isValid()` Returns if the referrer contained by this object is valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATUS_SERVICE_DISCONNECTED
```
public static final int STATUS_SERVICE_DISCONNECTED
```
    The service got disconnected while attempting to gather.
    
    See Also:
    
    Constant Field Values
  - STATUS_OK
```
public static final int STATUS_OK
```
    Install Referrer data is valid.
    
    See Also:
    
    Constant Field Values
  - STATUS_SERVICE_UNAVAILABLE
```
public static final int STATUS_SERVICE_UNAVAILABLE
```
    Service unavailable at this moment. It may not exist or it may be updating.
    
    See Also:
    
    Constant Field Values
  - STATUS_FEATURE_NOT_SUPPORTED
```
public static final int STATUS_FEATURE_NOT_SUPPORTED
```
    Service is not supported on this device.
    
    See Also:
    
    Constant Field Values
  - STATUS_DEVELOPER_ERROR
```
public static final int STATUS_DEVELOPER_ERROR
```
    An error occurred with the implementation. This should never occur.
    
    See Also:
    
    Constant Field Values
  - STATUS_TIMED_OUT
```
public static final int STATUS_TIMED_OUT
```
    A timeout occurred when attempting to gather.
    
    See Also:
    
    Constant Field Values
  - STATUS_MISSING_DEPENDENCY
```
public static final int STATUS_MISSING_DEPENDENCY
```
    An exception indicating the required google dependency is missing from the app.
    
    See Also:
    
    Constant Field Values
  - STATUS_NOT_GATHERED
```
public static final int STATUS_NOT_GATHERED
```
    An attempt to gather has not yet been made.
    
    See Also:
    
    Constant Field Values
  - KEY_ATTEMPT_COUNT
```
public static final java.lang.String KEY_ATTEMPT_COUNT
```
    See Also:
    
    Constant Field Values
  - KEY_DURATION
```
public static final java.lang.String KEY_DURATION
```
    See Also:
    
    Constant Field Values
  - referrer
```
public final java.lang.String referrer
```
    The install referrer.
  - installBeginTime
```
public final long installBeginTime
```
    Unix Timestamp for when the install began in seconds.
    Will be 0 when isLegacy is true.
  - installBeginServerTime
```
public final long installBeginServerTime
```
    Unix Timestamp for when the install began server-side in seconds.
    Will be 0 when isLegacy is true.
    Note: This is only available on 2.1+ versions of the install referrer library.
  - referrerClickTime
```
public final long referrerClickTime
```
    Unix Timestamp for the ad click in seconds.
    Will be 0 when isLegacy is true or if Google Play considers the install organic.
  - referrerClickServerTime
```
public final long referrerClickServerTime
```
    Unix Timestamp for the ad click server-time in seconds.
    Will be 0 when isLegacy is true or if Google Play considers the install organic.
    Note: This is only available on 2.1+ versions of the install referrer library.
  - googlePlayInstant
```
public final java.lang.Boolean googlePlayInstant
```
    Boolean indicating if the user has interacted with the app's instant experience in the past 7 days.
    Note: This is only available on 1.1+ versions of the install referrer library.
  - installVersion
```
public final java.lang.String installVersion
```
    The app's version at the time when the app was first installed.
    Note: This is only available on 2.1+ versions of the install referrer library.
  - status
```
public final int status
```
    Status of this install referrer.
  - isLegacy
```
public final boolean isLegacy
```
    Indicates that this install referrer came from the legacy Broadcast Receiver.
    A legacy install referrer will have 0 for both the installBeginTime and referrerClickTime
  - attemptCount
```
public final int attemptCount
```
    Number of attempts it took to retrieve the install referrer.
  - duration
```
public final double duration
```
    Total amount of time (seconds) across all attempts that it took to retrieve the install referrer.
- Method Detail
  - isValid
```
public final boolean isValid()
```
    Returns if the referrer contained by this object is valid.
    
    Returns:
    
    True if install referrer is valid. False if not.
  - isSupported
```
public final boolean isSupported()
```
    Returns if the install referrer is supported on this device.
    Note: The device is considered supported prior to an attempt being made.
    
    Returns:
    
    True if the device is supported, False if not.
  - isGathered
```
public final boolean isGathered()
```
    Returns if an install referrer gather attempt has been made.
    
    Returns:
    
    True if a gather attempt has been made, False if not.

Class InstallReferrer

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_SERVICE_DISCONNECTED

STATUS_OK

STATUS_SERVICE_UNAVAILABLE

STATUS_FEATURE_NOT_SUPPORTED

STATUS_DEVELOPER_ERROR

STATUS_TIMED_OUT

STATUS_MISSING_DEPENDENCY

STATUS_NOT_GATHERED

KEY_ATTEMPT_COUNT

KEY_DURATION

referrer

installBeginTime

installBeginServerTime

referrerClickTime

referrerClickServerTime

googlePlayInstant

installVersion

status

isLegacy

attemptCount

duration

Method Detail

isValid

isSupported

isGathered