adattributionkit

Measure ad effectiveness with privacy-preserving attribution using AdAttributionKit. Use when registering ad impressions, handling attribution postbacks, updating conversion values, implementing re-engagement attribution, configuring publisher or advertiser apps, or replacing SKAdNetwork with AdAttr

By dpearson2699 · 2,625 installs

npx skills add dpearson2699/swift-ios-skills --skill adattributionkit

Source repository · Upstream listing

AdAttributionKit Privacy preserving ad attribution for iOS 17.4+. AdAttributionKit lets ad networks measure conversions (installs and re engagements) without exposing user level data. It supports the App Store and alternative marketplaces, and interoperates with SKAdNetwork. Three roles exist in the attribution flow: the ad network (signs impressions, receives postbacks), the publisher app (displays ads), and the advertised app (the app being promoted). Contents [Overview and Privacy Model]( overview and privacy model) [Publisher App Setup]( publisher app setup) [Advertiser App Setup]( advertiser app setup) [Impressions]( impressions) [Postbacks]( postbacks) [Conversion Values]( conversion values) [Re engagement]( re engagement) [Common Mistakes]( common mistakes) [Review Checklist]( review checklist) [References]( references) Overview and Privacy Model AdAttributionKit preserves user privacy through several mechanisms: Crowd anonymity tiers the device limits postback data granularity based on the crowd size associated with the ad, ranging from Tier 0 (minimal data) to Tier 3 (most data including publisher ID and country code). Time delayed postbacks postbacks are sent 24 48 hours after conversion window close (first window) or 24 144 hours (second/third windows). No user level identifiers postbacks contain aggregate source identifiers and conversion values, not device or user IDs. Hierarchical source identifiers 2, 3, or 4 digit source IDs where the number of digits returned depends on the crowd anonymity tier. In migration and interoperability reviews, explicitly state that the system evaluates AdAttributionKit and SKAdNetwork impressions together, only one impression wins per conversion, click through beats view through, and recency breaks ties within click through impressions before falling back to the most recent view through impression. Publisher App Setup A publisher app displays ads from registered ad networks. Add each ad network's ID to the app's Info.plist so its impressions qualify for install validation. Add ad network identifiers Ad network IDs must be lowercase. SKAdNetwork IDs (ending in .skadnetwork ) are also accepted the frameworks share IDs. Display a UIEventAttributionView For click through custom rendered ads, place one UIEventAttributionView over each tappable ad/control. It must cover the tappable area and stay above views that would intercept touches before handleTap() succeeds. Advertiser App Setup The advertised app is the app someone installs or re engages with after seeing an ad. It must call a conversion value update at least once to begin the postback conversion window. Opt in to receive winning postback copies Add AttributionCopyEndpoint under the top level AdAttributionKit Info.plist dictionary so the device sends a copy of the winning postback to your server: The system derives the well known endpoint from the registrable domain in the URL, ignoring subdomains: Configure your server to accept HTTPS POST requests at that path. The domain must have a valid SSL certificate. Opt in for re engagement postback copies Add a second key in the same AdAttributionKit dictionary to also receive copies of winning re engagement postbacks: Update conversion value on first launch Call a conversion value update as early as possible after first launch to begin the conversion window: Impressions Ad networks create signed impressions using JWS (JSON Web Signature). The publisher app uses AppImpression to register and handle those impressions. Create an impression from a JWS The JWS contains the ad network ID, advertised item ID, publisher item ID, source identifier, timestamp, and optional re engagement eligibility flag. See [references/adattributionkit patterns.md](references/adattributionkit patterns.md) for JWS generation details. Check device support View through impressions Record a view impression when the ad content has been displayed and dismissed: For long lived ad views, use beginView() and endView() to track view duration: Click through impressions Respond to ad taps by calling handleTap() within 15 minutes of creating the AppImpression ; otherwise request a fresh impression. If the advertised app is not installed, the system opens its App Store or marketplace page. If installed, the system launches it directly. A UIEventAttributionView must overlay the ad for handleTap() to succeed. StoreKit rendered ads Pass the impression to StoreKit overlay or product view controller APIs. StoreKit automatically records view through impressions after 2 seconds of display and click through impressions on tap. Postbacks Postbacks are attribution reports the device sends to ad networks (and optionally to the advertised app developer) after a conversion event. Conversion windows Winning attributions can produce multiple postbacks across conversion windows; lower data tiers and nonwinning attributions disclose less. Load [references/adattributionkit patterns.md](references/adattributionkit patterns.md) for the current window and delay matrix. Time windows for events Attribution eligibility windows are distinct from conversion/postback windows. Configure and verify view through, click through, install update, and re engagement limits from the current documentation and the reference; do not merge the two concepts. Lock conversion values early Lock the postback to finalize a conversion value before the window ends and receive the postback sooner: After locking, the system ignores further updates in that conversion window. Postback data by tier Disclosure grows with the system assigned data tier. Code and analytics must tolerate absent source digits, fine/coarse conversion values, publisher item ID, and country. The reference owns the detailed tier matrix. Conversion Values Fine grained values Fine values are integers from 0...63 (6 bits). They are available only in the first postback and only at Tier 2 or higher: Coarse values Three levels for lower tiers and second/third postbacks: Update by conversion type (iOS 18+) Separate conversion values for install vs. re engagement postbacks. In server JSON, use "conversion type": "re engagement" with the hyphen; Swift APIs use .reengagement without it. Conversion tags (iOS 18.4+) Use conversion tags to selectively update specific postbacks when overlapping conversion windows exist: The system delivers the conversion tag through the re engagement URL's AdAttributionKitReengagementOpen query parameter. Re engagement Re engagement tracks users who already have the advertised app installed and interact with an ad to return to it. Mark impressions as re engagement eligible Set eligible for re engagement to true in the JWS payload when generating the impression. Handle re engagement taps with a URL Pass a universal link that the system opens in the advertised app: The system appends AdAttributionKitReengagementOpen as a query parameter. The advertised app checks for this parameter to detect AdAttributionKit driven opens: Re engagement limits Only click through interactions create re engagement postbacks (not view through). The device enforces monthly per app and yearly per device re engagement limits. The AdAttributionKitReengagementOpen parameter is always present on the URL, even when the system does not create a postback. Common Mistakes Mistake Fix First launch never updates conversion value Call the canonical first launch update before the intended window elapses. Ad network ID contains uppercase characters Use the exact lowercase network identifier. handleTap() uses a stale impression or lacks the current attribution view tap Cover the ad with UIEventAttributionView , keep the impression fresh, and call from the validated tap flow. Tap errors are discarded Handle expired impression and missing view cases explicitly. Postback endpoint delays or drops the response Accept, persist/queue processing, and return the expected success promptly. Review Checklist [ ] Publisher app includes all ad network IDs in AdNetworkIdentifiers (lowercase) [ ] Ad network IDs match between publisher app's Info.plist and JWS kid [ ] UIEventAttributionView overlays each tappable click through ad/control [ ] Click through AppImpression is no older than 15 minutes at handleTap() [ ] Advertised app calls updateConversionValue on first launch [ ] Server endpoint at well known path accepts HTTPS POST with valid SSL [ ] Postback verification uses correct Apple public key for environment [ ] Duplicate postbacks filtered by postback identifier [ ] Server responds with HTTP 200 to postback requests [ ] Re engagement URL is a registered universal link for the advertised app [ ] Conversion value strategy accounts for all three conversion windows [ ] AppImpression.isSupported checked before attempting impression APIs References [references/adattributionkit patterns.md](references/adattributionkit patterns.md) postback verification, server handling, testing, SKAdNetwork migration, alternative marketplaces, attribution rules configuration [Apple: AdAttributionKit](https://sosumi.ai/documentation/adattributionkit) [Apple: Presenting ads in your app](https://sosumi.ai/documentation/adattributionkit/presenting ads in your app) [Apple: Receiving ad attributions and postbacks](https://sosumi.ai/documentation/adattributionkit/receiving ad attributions and postbacks) [Apple: Verifying a postback](https://sosumi.ai/documentation/adattributionkit/verifying a postback) [Apple: SKAdNetwork interoperability](https://sosumi.ai/documentation/adattributionkit/adattributionkit skadnetwork interoperability)