Skip to content

App Data Parameters

Updated: Oct 2, 2024

Use these parameters to share app data and device information with the Conversions API.

See the Conversions API for App Events documentation for guidance on integrating app events.

ParameterDescription
advertiser_tracking_enabled booleanRequired for app events Use this field to specify ATT permission on an iOS 14.5+ device. Set to 0 for disabled or 1 for enabled.
application_tracking_enabled booleanOptional A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use 0 for disabled, 1 for enabled.
extinfo object Expand the row to view the full list of extinfo values.Required for app events Extended device information, such as screen width and height. This parameter is an array. Separate the values with commas. When using extinfo, all values are required and must be in the order indexed below. If a value is missing, fill with an empty string as a placeholder. Note: * version must be a2 for Android * version must be i2 for iOS
0 stringRequired extinfo version Example: i2
1 stringapp package name Example: com.facebook.sdk.samples.hellofacebook
2 stringshort version (int or string) Example: 1.0
3 stringlong version Example: 1.0 long
4 stringRequired OS version Example: 13.4.1
5 stringdevice model name Example: iPhone5,1
6 stringlocale Example: En_US
7 stringtimezone abbreviation Example: PDT
8 stringcarrier Example: AT&T
9 stringscreen width Example: 320
10 stringscreen height Example: 568
11 stringscreen density Example: 2
12 stringCPU cores Example: 2
13 stringexternal storage size in GB Example: 13
14 stringfree space on external storage in GB Example: 8
15 stringdevice timezone Example: USA/New York
campaign_ids stringOptional An encrypted string and non-user metadata appended to the outbound URL (for example, ad_destination_url) or deep link (for App Aggregated Event Measurement) when a user clicked on a link from Facebook. Graph API definition: Parameter passed via the deep link for Mobile App Engagement campaigns.
install_referrer stringOptional Third party install referrer, currently available for Android only, see here for more⁠.
installer_package stringOptional Used internally by the Android SDKs.
url_schemes arrayOptional Used internally by the iOS and Android SDKs.
vendor_id stringOptional Vendor ID.
windows_attribution_id stringOptional Attribution token used for Windows 10.

Unofficial mirror for reference/search purposes. All content originates from developers.facebook.com — see the source link at the top of each page. Machine-readable indexes: llms.txt · llms-full.txt · About