device.json•2.68 kB
{
"namespace": "device",
"description": "Describes device attributes.\n",
"attributes": {
"device.id": {
"description": "A unique identifier representing the device\n",
"type": "string",
"note": "Its value SHOULD be identical for all apps on a device and it SHOULD NOT change if an app is uninstalled and re-installed.\nHowever, it might be resettable by the user for all apps on a device.\nHardware IDs (e.g. vendor-specific serial number, IMEI or MAC address) MAY be used as values.\n\nMore information about Android identifier best practices can be found [here](https://developer.android.com/training/articles/user-data-ids).\n\n> [!WARNING]\n>\n> This attribute may contain sensitive (PII) information. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply,\n> ensure you do your own due diligence.\n>\n> Due to these reasons, this identifier is not recommended for consumer applications and will likely result in rejection from both Google Play and App Store.\n> However, it may be appropriate for specific enterprise scenarios, such as kiosk devices or enterprise-managed devices, with appropriate compliance clearance.\n> Any instrumentation providing this identifier MUST implement it as an opt-in feature.\n>\n> See [`app.installation.id`](/docs/registry/attributes/app.md#app-installation-id) for a more privacy-preserving alternative.\n",
"stability": "development",
"examples": ["123456789012345", "01:23:45:67:89:AB"]
},
"device.manufacturer": {
"description": "The name of the device manufacturer\n",
"type": "string",
"note": "The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.\n",
"stability": "development",
"examples": ["Apple", "Samsung"]
},
"device.model.identifier": {
"description": "The model identifier for the device\n",
"type": "string",
"note": "It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device.\n",
"stability": "development",
"examples": ["iPhone3,4", "SM-G920F"]
},
"device.model.name": {
"description": "The marketing name for the device model\n",
"type": "string",
"note": "It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative.\n",
"stability": "development",
"examples": ["iPhone 6s Plus", "Samsung Galaxy S6"]
}
}
}