📀SDK

Our SDK collects non-identifiable device and environment data to improve ad attribution accuracy and analytics. Our goal is to provide precise, real-time insights while ensuring user privacy. Below is a detailed breakdown of the data points collected, with examples from our reference dataset.

{
  "os": "Mac OSX",
  "osVersion": "10_15_7",
  "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Safari/605.1.15",
  "cores": 8,
  "touch": false,
  "language": "en-US",
  "timezone": -7,
  "ipAddress": "192.0.2.123",
  "city": "San Francisco",
  "country": "USA",
  "apiToGetLocation": "https://ip-address-k1d5.onrender.com/get-country-from-ip?ip=ip_value",
  "pluginNames": [
    "PDF Viewer",
    "Chrome PDF Viewer",
    "Chromium PDF Viewer",
    "Microsoft Edge PDF Viewer",
    "WebKit built-in PDF"
  ],
  "pluginsLength": 5,
  "screenWidth": 1920,
  "screenHeight": 1080,
  "availWidth": 1920,
  "availHeight": 1080,
  "colorDepth": 24,
  "devicePixelRatio": 2,
  "localStorage": {
    "luci_session": "{\"id\":\"63314cf2-9ef1-4454-a51d-f57fde036a66\",\"hash\":\"dbdb9b22ac85a2f7f3b2474651e1575b76e2f133c80ad2f72c054aa738899957\",\"expiryTime\":1720567074158}"
  },
  "indexedDB": {},
  "uniqueHash": "55a42021c6079a5dbbd03fc420c028066237019402bca8aa2a42ad84dac16157",
  "isMetaMaskInstalled": false,
  "screenOrientationType": "landscape-primary",
  "screenOrientationAngle": 0
}

Data Points Collected

Device and Operating System Information

• Operating System (os) / (osVersion): The SDK collects information about the user’s operating system, which helps identify the platform for compatibility analysis.

  • Example: "Mac OSX"

    • "10.15.7"

• User Agent (agent): The SDK captures the full user agent string to provide additional details about the operating system and browser.

  • Example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Safari/605.1.15"

---

System Specifications

• CPU Cores (cores): Indicates the number of processor cores available, useful for understanding device performance capabilities.

  • Example: 8

• Touch Capability (touch): A Boolean value indicating whether the device supports touch input.

  • Example: false (No touch support)

---

Localization and Language

• Language (language): Captures the browser's language setting to support content localization and analytics.

  • Example: "en-US"

• Timezone (timezone): The user’s time zone offset from UTC, which is useful for time-based targeting and analytics.

  • Example: 7 (Pacific Time)

• City and Country: Derived from the user’s IP address using an external API. This information helps improve regional targeting and analytics.

  • Example: “San Francisco, USA”

---

Browser and Display Details

• Browser Plugins (pluginNames): Lists the names of installed browser plugins, aiding in device fingerprinting and compatibility checks.

  • Example: ["PDF Viewer", "Chrome PDF Viewer", "Chromium PDF Viewer", "Microsoft Edge PDF Viewer", "WebKit built-in PDF"]

• Number of Plugins (pluginsLength): The total count of installed browser plugins.

  • Example: 5

• Screen Width (screenWidth) and Height (screenHeight): The device’s screen dimensions, which help in content layout optimization.

  • Example: 1920 (width) and 1080 (height)

• Available Screen Width (availWidth) and Height (availHeight): The actual visible screen area, excluding browser UI elements.

  • Example: 1920 (width) and 1080 (height)

• Color Depth (colorDepth): Specifies the number of bits used for color display, helping optimize content quality.

  • Example: 24

• Device Pixel Ratio (devicePixelRatio): The ratio between physical and device-independent pixels, used for scaling visual elements.

  • Example: 2

---

Storage Information

• Local Storage (localStorage): Stores session-related data securely. This information is used to maintain user sessions and provide a seamless experience.

json
Copy code
{
  "luci_session": "{\"id\":\"63314cf2-9ef1-4454-a51d-f57fde036a66\",\"hash\":\"dbdb9b22ac85a2f7f3b2474651e1575b76e2f133c80ad2f72c054aa738899957\",\"expiryTime\":1720567074158}"
}

• IndexedDB (indexedDB): Used for structured storage of larger datasets, allowing efficient data handling while preserving user privacy.

  • Example: {} (Empty in this case, but available for larger data storage needs)

---

Unique Device Identifiers

• Unique Hash (uniqueHash): An anonymized, hash-based identifier for each device or session, used for accurate tracking without revealing PII.

  • Example: "55a42021c6079a5dbbd03fc420c028066237019402bca8aa2a42ad84dac16157"

---

Browser Extension Detection

• MetaMask Installation (isMetaMaskInstalled): A Boolean indicating whether the MetaMask extension is installed, relevant for Web3 applications.

  • Example: false (MetaMask not installed)

---

Screen Orientation

• Screen Orientation Type (screenOrientationType): Describes the device’s screen orientation, useful for optimizing content presentation.

  • Example: "landscape-primary"

• Screen Orientation Angle (screenOrientationAngle): The rotation angle of the device's screen.

  • Example: 0 (No rotation)

---

Network and Location Data

• IP Address (ipAddress): Captured temporarily to derive geographic information. The IP address itself is not stored permanently but is used to fetch location data through an API.

  • Example: "192.0.2.123"

• City (city): The approximate city determined using the user’s IP address via an external API.

  • Example: "San Francisco"

• Country (country): The country associated with the user’s IP address, also retrieved using an external API.

  • Example: "USA"

• API to Get Location (apiToGetLocation): The API endpoint used to retrieve city and country details from the IP address. This API ensures accurate location data for regional analytics and targeting while maintaining user privacy.

  • Example: "<https://ip-address-k1d5.onrender.com/get-country-from-ip?ip=ip_value>"

  Usage

  The IP address is used solely for fetching approximate geographic information, improving location-based analytics and targeting. The data is anonymized, and the IP address is not stored permanently, ensuring that we maintain user privacy while providing accurate regional insights.

---

Usage and Privacy

The Lucia Protocol SDK collects essential data to enhance ad performance analysis while prioritizing user privacy. Sensitive session information is securely stored, and no personally identifiable information (PII) is collected. Location data derived from the IP address is anonymized and used solely for regional analytics.