Apptimize

Add a callback to be invoked when an Apptimize configuration is recalculated. The enrolled experiments may or may not have changed. The dynamic variable values may or may not have changed. Feature flag values may or may not have changed. This happens at various times:

• new information from server
• device properties or custom attributes changed
• and a few other cases

Inform Apptimize that a numeric metric was achieved. A numeric metric is a noteworthy event associated with a numeric value that you wish to track. Call this whenever a numeric metric has been achieved, and this data will then be displayed in your results at apptimize.com.

For example, if the event you're interested in is a purchase event, you could call this method when a purchase is made and provide the price as the value. Then when viewing your results at apptimize.com you would be able to see the sum of the purchase prices.

Stop forcing variants. Normal allocation will resume.

Stop forcing the variant with the given Id. If this is the only forced variant, normal allocation will resume.

Erase a user attribute from memory so it's no longer used for targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Disables Apptimize. This will prevent Apptimize from further receiving or sending data, until the Application is closed/destroyed, restarted, and the setup(android.content.Context, String) method is called. If setup(android.content.Context, String) method has not been called yet, this disable method does nothing. Note that this disable method is only activated the moment it is called. Any events after setup(android.content.Context, String) is called, and prior to this disable method is called, will still be tracked.

Get the double associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createDouble(String, Double) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

Options can be configured using the input ApptimizeOptions.

Get the double associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createDouble(String, Double) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling doubleForTest(String, double, ApptimizeOptions)

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, provide it as the input parameter value. For example, if the event is a purchase, the value might be the price. If there is no such value, use track(String) instead.

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, use track(String, double) instead.

Force the variant with the given ID to be enabled.

All variants forced using this method will be treated as though they underwent experiment selection, and will be reflected on your results dashboard. Forced variants are persistent across application launches and will not be reset except by calls to clearForcedVariant or clearAllForcedVariants.

If called multiple times, all variants supplied to invocations of this method will be turned on.

setForceVariantsShowWinnersAndInstantUpdates(boolean) determines whether winners and instant-updates will be shown. By default, this setting is off, so change your call to Apptimize.setup to turn it on as needed. Note that the "Advanced Verify" feature on the dashboard will only work when winners and instant-updates are being shown, because "Advanced Verify" works by sending an instant update to the paired device.

Get the current Apptimize-created anonymous user ID

This anonymous user ID will be used if-and-only-if the customer-specified user ID is null. A single anonymous user ID is created. If the customerUserId is set to a non-null value, then set back to null, Apptimize will use the same anonymous user ID as before.

Get the current customer-specified userId

User IDs are arbitrary strings. If the customer-specified user ID is null, then Apptimize will create and use an anonymous user ID for tracking purposes. The initial default value of the customer-specified user ID is null.

Get the String associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createString(String, String) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling stringForTest(String, String, ApptimizeOptions).

Returns information about all winning Apptimize A/B tests and Instant Updates that the device is using.

The returned java.util.Map will contain one entry for each A/B test and instant update that the device showing. The key will be the name of the test or instant update, and the value will be the ApptimizeInstantUpdateOrWinnerInfo containing information about it. The return will be empty if this device has no winners or instant updates set.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Returns information about all winning Apptimize A/B tests and Instant Updates that the device is using.

The returned java.util.Map will contain one entry for each winning A/B test and instant update that the device showing. The key will be the name of the test or instant update, and the value will be the ApptimizeInstantUpdateOrWinnerInfo containing information about it. The return will be empty if this device has no winners or instant updates set.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Returns information about all Apptimize A/B tests and Feature Flags that the device is enrolled in. Note that this does NOT include information about Apptimize A/B tests or Feature Flags that are running but that this device is not enrolled in.

The returned java.util.Map will contain one entry for each A/B test and Feature Flag that the device is enrolled in. The key will be the name of the test or Feature Flag and the value will be the ApptimizeTestInfo containing information about this test. The return will be empty if this device is enrolled in no tests.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Returns information about all Apptimize A/B tests and Feature Flags that the device is enrolled in. Note that this does NOT include information about Apptimize A/B tests or Feature Flags that are running but that this device is not enrolled in.

The returned java.util.Map will contain one entry for each A/B test and Feature Flag that the device is enrolled in. The key will be the name of the test or Feature Flag, and the value will be the ApptimizeTestInfo containing information about this test. The return will be empty if this device is enrolled in no tests.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Get the value of a user attribute boolean.

Get the value of a user attribute double.

Get the value of a user attribute integer.

Get the value of a user attribute string.

Returns the java.lang.String user ID that uniquely identifies this device to Apptimize. This method will return null if the user ID could not be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called. In rare cases this method could return the empty string, like in the case where you have remotely disabled the Apptimize library.

return information about all variants launched.

The returned java.util.Map will contain one entry for each variant in a currently running experiment. The returned java.util.Map will have the key as the variant's ID, and the value as another java.util.Map that maps java.lang.String key to their corresponding java.lang.Object values:
("variantId" : Long, "variantName" : String, "experimentId" : Long, "experimentName" : String). The return will be empty if there are no running experiments.

In rare cases where results come from old verions of Apptimize, the field 'experimentId' may be null;

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

return information about all variants launched.

The returned java.util.Map will contain one entry for each variant in a currently running experiment. The returned java.util.Map will have the key as the variant's ID, and the value as another java.util.Map that maps java.lang.String key to their corresponding java.lang.Object values:
("variantId" : Long, "variantName" : String, "experimentId" : Long, "experimentName" : String). The return will be empty if there are no running experiments.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Inform Apptimize a metric was achieved. Call this whenever a metric has been achieved. Note: This method will soon be deprecated. Use track(String) instead.

Get the int associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createInteger(String, Integer) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling integerForTest(String, int, ApptimizeOptions).

Get the int associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createInteger(String, Integer) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

Options can be configured using the input ApptimizeOptions.

Inform Apptimize a metric was achieved. Call this whenever a metric has been achieved. Note: This method will soon be deprecated. Use track(String) instead.

Remove an observer to be invoked when an Apptimize configuration is recalculated.

Simulates a fresh install of Apptimize. For use in testing. All persisted data and attributes will disappear.

Executes an experiment. The code to run an experiment can be easily obtained from the Apptimize administration website. In it, you specify the experiment and variant names and it gives you code to paste into your app. It's best to cut and paste from the website to avoid typos. A single method on ApptimizeExperiment will be called synchronously (i.e. before the method returns). No reference to the ApptimizeExperiment instance is held or ever called again, unless you call runExperiment again. So in terms of control flow, this method works exactly like an if statement. Rather than using a code block test, we recommend controlling flow by creating an ApptimizeVar (whose value can be changed by A/B experiments) and then having an if/else or switch statement based on the value of the ApptimizeVar. Note: This method will soon be deprecated. Use runTest(String, ApptimizeTest) instead. This method's options can be configured by instead calling runTest(String, ApptimizeTest, ApptimizeOptions).

Executes a code block test. The code to run a test can be easily obtained from the Apptimize administration website. In it, you specify the test and variant names and it gives you code to paste into your app. It's best to cut and paste from the website to avoid typos. A single method on ApptimizeTest will be called synchronously (i.e. before the method returns). No reference to the ApptimizeTest instance is held or ever called again, unless you call runTest again. So in terms of control flow, this method works exactly like an if statement. Rather than using a code block test, we recommend controlling flow by creating an ApptimizeVar (whose value can be changed by A/B experiments) and then having an if/else or switch statement based on the value of the ApptimizeVar. Options can be configured using the input ApptimizeOptions.

Executes a code block test. The code to run a test can be easily obtained from the Apptimize administration website. In it, you specify the test and variant names and it gives you code to paste into your app. It's best to cut and paste from the website to avoid typos. A single method on ApptimizeTest will be called synchronously (i.e. before the method returns). No reference to the ApptimizeTest instance is held or ever called again, unless you call runTest again. So in terms of control flow, this method works exactly like an if statement. Rather than using a code block test, we recommend controlling flow by creating an ApptimizeVar (whose value can be changed by A/B experiments) and then having an if/else or switch statement based on the value of the ApptimizeVar. This method's options can be configured by instead calling runTest(String, ApptimizeTest, ApptimizeOptions).

Set the active code block for a specific experiment

Set the active value for a dynamic variable

Set the current customer-specified user ID

User IDs are arbitrary strings, except that they cannot be the empty string "". When the customer-specified user ID is null, then Apptimize creates and uses an anonymous user ID for tracking purposes. If the customerUserId is set to a non-null value, then set back to null, Apptimize will use the same anonymous user ID as before. The initial default value of the customer-specified user ID is null.

Inform Apptimize that a numeric metric was achieved. A numeric metric is a noteworthy event associated with a numeric value that you wish to track. Call this whenever a numeric metric has been achieved, and this data will then be displayed in your results at apptimize.com.

For example, if the event you're interested in is a purchase event, you could call this method when a purchase is made and provide the price as the value. Then when viewing your results at apptimize.com you would be able to see the sum of the purchase prices.

Set whether Apptimize should be in offline mode.

The default value for this setting is false. If set to true, Apptimize will not receive or send data until this setting is reset to false. This setting will persist across app restarts; e.g., if it is set to true and the app is restarted, Apptimize will still be in offline mode until this method is called with a value of false.

You may call this method before or after the Apptimize.setup() call. However, note that if you call this method and then do not call Apptimize.setup() before the app is destroyed, your requested setting will NOT be persisted for the next time the app is created.

Register a callback to be invoked when Apptimize has completed setup and tests are available to be run.

Register a callback to be invoked when an Apptimize A/B test is run.

Register a callback to be invoked when an Apptimize A/B test enrollment has changed.

Register a callback to be invoked when an Apptimize A/B test is run.

Activate the Apptimize SDK test mode (used for unit testing)

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup(). Passing null as the value (the string parameter) has the same effect as calling clearUserAttribute.

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Initializes Apptimize with the default options. You should either call Apptimize.setup(this, "your app key") in all of your activities' onCreate methods or in your Application subclass. The latter is easier since you only need to add code in one place, but many Android apps do not specify a custom Application class (via http://developer .android.com/guide/topics/manifest/application-element.html#nm). Apptimize.setup() can be safely called multiple times and should be called on the main thread.

Initializes Apptimize with the given options. You should either call Apptimize.setup(this, "your app key") in all of your activities' onCreate methods or in your Application subclass. The latter is easier since you only need to add code in one place, but many Android apps do not specify a custom Application class (via http://developer .android.com/guide/topics/manifest/application-element.html#nm). Apptimize.setup() can be safely called multiple times and should be called on the main thread.

Get the String associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createString(String, String) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

Options can be configured using the input ApptimizeOptions.

Get the String associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using createString(String, String) and then calling its value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling stringForTest(String, String, ApptimizeOptions).

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, use track(String, double) instead.

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, provide it as the input parameter value. For example, if the event is a purchase, the value might be the price. If there is no such value, use track(String) instead.