-
Notifications
You must be signed in to change notification settings - Fork 424
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reapply "Report Apple Ad attribution using pixel" #2702
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| // | ||
| // AdAttributionPixelReporter.swift | ||
| // DuckDuckGo | ||
| // | ||
| // Copyright © 2024 DuckDuckGo. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import Foundation | ||
| import Core | ||
|
|
||
| protocol PixelFiring { | ||
| static func fire(pixel: Pixel.Event, withAdditionalParameters params: [String: String]) async throws | ||
| } | ||
|
|
||
| final class AdAttributionPixelReporter { | ||
|
|
||
| static let isAdAttributionReportingEnabled = false | ||
|
|
||
| static var shared = AdAttributionPixelReporter() | ||
|
|
||
| private var fetcherStorage: AdAttributionReporterStorage | ||
| private let attributionFetcher: AdAttributionFetcher | ||
| private let pixelFiring: PixelFiring.Type | ||
|
|
||
| init(fetcherStorage: AdAttributionReporterStorage = UserDefaultsAdAttributionReporterStorage(), | ||
| attributionFetcher: AdAttributionFetcher = DefaultAdAttributionFetcher(), | ||
| pixelFiring: PixelFiring.Type = Pixel.self) { | ||
| self.fetcherStorage = fetcherStorage | ||
| self.attributionFetcher = attributionFetcher | ||
| self.pixelFiring = pixelFiring | ||
| } | ||
|
|
||
| @discardableResult | ||
| func reportAttributionIfNeeded() async -> Bool { | ||
| guard await fetcherStorage.wasAttributionReportSuccessful == false else { | ||
| return false | ||
| } | ||
|
|
||
| if let attributionData = await self.attributionFetcher.fetch() { | ||
| if attributionData.attribution { | ||
| let parameters = self.pixelParametersForAttribution(attributionData) | ||
| do { | ||
| try await pixelFiring.fire(pixel: .appleAdAttribution, withAdditionalParameters: parameters) | ||
| } catch { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| await fetcherStorage.markAttributionReportSuccessful() | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| private func pixelParametersForAttribution(_ attribution: AdServicesAttributionResponse) -> [String: String] { | ||
| var params: [String: String] = [:] | ||
|
|
||
| params[PixelParameters.adAttributionAdGroupID] = attribution.adGroupId.map(String.init) | ||
| params[PixelParameters.adAttributionOrgID] = attribution.orgId.map(String.init) | ||
| params[PixelParameters.adAttributionCampaignID] = attribution.campaignId.map(String.init) | ||
| params[PixelParameters.adAttributionConversionType] = attribution.conversionType | ||
| params[PixelParameters.adAttributionAdGroupID] = attribution.adGroupId.map(String.init) | ||
| params[PixelParameters.adAttributionCountryOrRegion] = attribution.countryOrRegion | ||
| params[PixelParameters.adAttributionKeywordID] = attribution.keywordId.map(String.init) | ||
| params[PixelParameters.adAttributionAdID] = attribution.adId.map(String.init) | ||
|
|
||
| return params | ||
| } | ||
| } | ||
|
|
||
| extension Pixel: PixelFiring { | ||
| static func fire(pixel: Event, withAdditionalParameters params: [String: String]) async throws { | ||
|
|
||
| try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, Error>) in | ||
| Pixel.fire(pixel: pixel, withAdditionalParameters: params) { error in | ||
| if let error { | ||
| continuation.resume(throwing: error) | ||
| } else { | ||
| continuation.resume() | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
38 changes: 38 additions & 0 deletions
38
DuckDuckGo/AdAttribution/AdAttributionReporterStorage.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // | ||
| // AdAttributionReporterStorage.swift | ||
| // DuckDuckGo | ||
| // | ||
| // Copyright © 2024 DuckDuckGo. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import Core | ||
| import Foundation | ||
|
|
||
| protocol AdAttributionReporterStorage { | ||
| var wasAttributionReportSuccessful: Bool { get async } | ||
|
|
||
| func markAttributionReportSuccessful() async | ||
| } | ||
|
|
||
| final class UserDefaultsAdAttributionReporterStorage: AdAttributionReporterStorage { | ||
| @MainActor | ||
| @UserDefaultsWrapper(key: .appleAdAttributionReportCompleted, defaultValue: false) | ||
| var wasAttributionReportSuccessful: Bool | ||
|
|
||
| @MainActor | ||
| func markAttributionReportSuccessful() async { | ||
| wasAttributionReportSuccessful = true | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've add flag here so it's easy to flip the switch once needed.