Install Tracking in Firefox for iOS with the Adjust SDK - my-swift-lab/firefox-ios GitHub Wiki

If there is anything in this document that is not clear, is incorrect, or that requires more detail, please file a request through a Github or Bugzilla. Also feel free to submit corrections or additional information.

Firefox for iOS tracks certain types of installs using a third-party install tracking framework called Adjust. The intention is to determine the origin of Firefox for iOS installs by answering the question, “Did this user on this device install Firefox for iOS in response to a specific advertising campaign performed by Mozilla?”

The framework consists of a software development kit (SDK) linked into Firefox for iOS and a data-collecting Internet service backend run by the German company adjust GmbH. The Adjust SDK is open source and MIT licensed. It is hosted at https://github.com/adjust/ios_sdk. Firefox for iOS pulls in an unmodified copy of the SDK via Carthage. The Cartfile contains the version of the framework that is being used. The SDK is documented at https://docs.adjust.com.

Adjust Integration

The Adjust framework is abstracted via the AdjustIntegration class. All interaction with Adjust happens via this class.

Adjust Messages

The Adjust SDK collects and sends one type of message to the Adjust backend:

At the start of a new application session, a Session Message is sent with basic system info and how often the app has been used since the last time.

The message is documented below in more detail of what is sent in each HTTP request. All messages are posted to a secure endpoint at https://app.adjust.com. They are all application/x-www-form-urlencoded HTTP POST requests.

Session Message

Request

bundle_id:               org.mozilla.ios.Firefox
tracking_enabled:        0
language:                en
country:                 CA
app_version:             0
device_name:             iPad6,3
cpu_type:                CPU_SUBTYPE_ARM64_V8
app_version_short:       2.0
needs_response_details:  0
ios_uuid:                7B7B1164-A403-4E6E-A303-38571958EB33
attribution_deeplink:    1
session_count:           1
os_name:                 ios
event_buffering_enabled: 0
persistent_ios_uuid:     F9E80AC5-C2E7-4330-B706-25E67D61D37C
idfv:                    8D452BFB-0692-4E8C-9DE0-7578486A872E
hardware_name:           J127AP
app_token:               xxxxxxxxxxxx
os_version:              10.1
environment:             production
created_at:              2016-11-10T20:34:39.720Z-0500
device_type:             iPad
idfa:                    00000000-0000-0000-0000-000000000000
sent_at:                 2016-11-10T20:34:39.787Z-0500

These parameters (including ones not exposed to Mozilla) are documented at https://partners.adjust.com/placeholders/

Response

If the application was successfully attributed to a specific campaign, details for that campaign are sent back as a JSON response:

{ "app_token": "xxxxxxxxxxxx",
  "adid": "00000000000000000000",
  "attribution" { "tracker_token": "xxxxxx",
                  "tracker_name": "Network::CAMPAIGN::ADGROUP::CREATIVE",
                  "network": "Network",
                  "campaign":"CAMPAIGN",
                  "adgroup":"ADGROUP",
                  "creative":"CREATIVE" } }

The application has no use for this information and ignores it.