Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time

ADBMobileConfig.json config file

Information to help you use the ADBMobile JSON Config file.

The SDK currently has support for multiple Adobe Experience Cloud Solutions, including Analytics, Target, and Audience Manager. Methods are prefixed according to the solution. Configuration methods are prefixed with "Config."

  • rsids

    (Required by Analytics) One or more report suites to receive Analytics data. Multiple report suite IDs should be comma-separated with no space between.

    • Here is the syntax for this method:

      "rsids" : "rsid"
      "rsids" : "rsid1,rsid2"
  • server

    (Required by Analytics and Audience Management). Analytics or Audience Management server, based on the parent node. This variable should be populated with the server domain, without an "https://" or "https://" protocol prefix. The protocol prefix is handled automatically by the library based on the ssl variable.

    If ssl is true, a secure connection is made to this server. If sslis false, a non-secure connection is made to this server.

  • charset

    Defines the character set you are using for the data sent to Analytics. The charset is used to convert incoming data into UTF-8 for storage and reporting. For more information, see the charSet variable in the Adobe Analytics documentation.

  • ssl

    Enables (true) or disables (false) sending measurement data via SSL (HTTPS). The default value is false.

  • offlineEnabled

    When enabled (true), hits are queued while the device is offline and sent later when the device is online. Your report suite must be timestamp-enabled to use offline tracking.

    If time stamps are enabled on your report suite, your offlineEnabled configuration property must be true. if your report suite is not timestamp enabled, your offlineEnabled configuration property must be false.

    If this is not configured correctly, data will be lost. If you are unsure whether a report suite is timestamp enabled, contact Customer Care. If you are currently reporting AppMeasurement data to a report suite that also collects data from JavaScript, you might need to set up a separate report suite for mobile data or include a custom timestamp on all JavaScript hits using the s.timestamp variable.

    The default value is false.

  • lifecycleTimeout

    Specifies the length of time, in seconds, that must elapse between app launches before the launch is considered a new session. This timeout also applies when your application is sent to the background and reactivated. The time that your app spends in the background is not included in the session length.

    The default value is 300 seconds.

  • batchLimit

    Send hits in batches.

    For example, if set to 50, hits are queued until 50 are stored, then all queued hits are sent. Requires offlineEnabled=true, and the default value is 0 (No batching).

  • privacyDefault

    The options are:

    • optedin - hits are sent immediately.

    • optedout - hits are discarded.

    • optunknown - If your report suite is timestamp-enabled, hits are saved until the privacy status changes to opt-in (then hits are sent) or opt-out (then hits are discarded). If your report suite is not timestamp-enabled, hits are discarded until the privacy status changes to opt in.

      This sets the default value only. If this value is ever set or changed in code, then the value set by the code is saved in local storage and is used going forward until it is changed, or the app is uninstalled and then reinstalled.

      The default value is optedin.

  • poi

    Each POI array holds the POI name, latitude, longitude, and radius (in meters) for the area of the point. The POI name can be any string. When a trackLocation call is sent, if the current coordinates are within a defined POI, a context data variable is populated and sent with the trackLocation call.

    • Here is the code sample for this variable:

       "poi" [ 
                ["san francisco",37.757144,-122.44812,7000], 
                ["santa cruz",36.972935,-122.01725,600] 
  • clientCode

    (Required by Target) Your assigned client code.

  • timeout

    Determines how long target waits for a response.

The following is an example of an ADBMobileConfig.json file:

    "version" : "1.0",
    "analytics" : {
        "rsids" : "coolApp",
        "server" : "",
        "charset" : "UTF-8",
        "ssl" : true,
        "offlineEnabled" : true,
        "lifecycleTimeout" : 5,
        "privacyDefault" : "optedin",
        "poi" : [ 
                    ["san francisco",37.757144,-122.44812,7000],
                    ["santa cruz",36.972935,-122.01725,600]
 "target" : {
  "clientCode" : "myTargetClientCode",
  "timeout" : 1
 "audienceManager" : {
  "server" : ""