Trigger search result ad clicked event on iOS

Author: aseren

ios/brave-ios/Sources/Brave/Frontend/Browser/BrowserViewController/BVC+WKNavigationDelegate.swift

@@ -330,8 +330,15 @@ extension BrowserViewController: WKNavigationDelegate {
         tab?.loadRequest(modifiedRequest)
         return (.cancel, preferences)
       }
-
-      tab?.braveSearchResultAdManager = BraveSearchResultAdManager(url: requestURL, rewards: rewards, isPrivateBrowsing: isPrivateBrowsing)
+        
+      if let braveSearchResultAdManager = tab?.braveSearchResultAdManager,
+         braveSearchResultAdManager.isSearchResultAdClickedURL(requestURL),
+         navigationAction.navigationType == .linkActivated {
+        braveSearchResultAdManager.maybeTriggerSearchResultAdClickedEvent(requestURL)
+        tab?.braveSearchResultAdManager = nil
+      } else {
+        tab?.braveSearchResultAdManager = BraveSearchResultAdManager(url: requestURL, rewards: rewards, isPrivateBrowsing: isPrivateBrowsing)
+      }
 
       // We fetch cookies to determine if backup search was enabled on the website.
       let profile = self.profile

ios/brave-ios/Sources/Brave/Frontend/Browser/Search/BraveSearchResultAdManager.swift

@@ -7,23 +7,67 @@ import BraveCore
 
 // A helper class to handle Brave Search Result Ads.
 class BraveSearchResultAdManager: NSObject {
+  private let searchResultAdClickedUrlPath = "/a/redirect"
+
+  private let placementId = "placement_id"
+
   private let rewards: BraveRewards
 
+  private var searchResultAds = [String: BraveAds.SearchResultAdInfo]()
+
   init?(url: URL, rewards: BraveRewards, isPrivateBrowsing: Bool) {
     if !BraveAds.shouldSupportSearchResultAds() ||
-       !BraveSearchManager.isValidURL(url) ||
-       isPrivateBrowsing ||
-       rewards.isEnabled {
+      !BraveSearchManager.isValidURL(url) ||
+      isPrivateBrowsing ||
+      rewards.isEnabled {
       return nil
     }
 
     self.rewards = rewards
   }
 
-  func triggerSearchResultAdViewedEvent(_ searchResultAdInfo: BraveAds.SearchResultAdInfo) {
-      rewards.ads.triggerSearchResultAdEvent(
-        searchResultAdInfo,
-        eventType: .viewed,
-        completion: { _ in })
+  func isSearchResultAdClickedURL(_ url: URL) -> Bool {
+    return getPlacementID(url) != nil
+  }
+
+  func triggerSearchResultAdViewedEvent(
+        placementId: String,
+        searchResultAd: BraveAds.SearchResultAdInfo) {
+    searchResultAds[placementId] = searchResultAd
+
+    guard let searchResultAd = searchResultAds[placementId] else {
+      return
+    }
+
+    rewards.ads.triggerSearchResultAdEvent(
+      searchResultAd,
+      eventType: .viewed,
+      completion: { _ in })
+  }
+
+  func maybeTriggerSearchResultAdClickedEvent(_ url: URL) {
+    guard let placementId = getPlacementID(url) else {
+      return
+    }
+
+    guard let searchResultAd = searchResultAds[placementId] else {
+      return
+    }
+
+    rewards.ads.triggerSearchResultAdEvent(
+      searchResultAd,
+      eventType: .clicked,
+      completion: { _ in })
+  }
+
+  private func getPlacementID(_ url: URL) -> String? {
+    if !BraveSearchManager.isValidURL(url) ||
+       url.path != searchResultAdClickedUrlPath {
+      return nil
+    }
+    guard let queryItems = URLComponents(url: url, resolvingAgainstBaseURL: false)?.queryItems else {
+      return nil
+    }
+    return queryItems.first(where: { $0.name == placementId })?.value
   }
 }

ios/brave-ios/Sources/Brave/Frontend/UserContent/UserScripts/Scripts_Dynamic/ScriptHandlers/Paged/BraveSearchResultAdScriptHandler.swift

@@ -3,9 +3,10 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-import WebKit
 import BraveCore
+import BraveShared
 import os.log
+import WebKit
 
 class BraveSearchResultAdScriptHandler: TabContentScript {
   private struct SearchResultAdResponse: Decodable {
@@ -29,16 +30,14 @@ class BraveSearchResultAdScriptHandler: TabContentScript {
 
   fileprivate weak var tab: Tab?
 
-  private static let secondsInDay = 24 * 60 * 60
-
   init(tab: Tab) {
     self.tab = tab
   }
 
   static let scriptName = "BraveSearchResultAdScript"
   static let scriptId = UUID().uuidString
   static let messageHandlerName = "\(scriptName)_\(messageUUID)"
-  static let scriptSandbox: WKContentWorld = .page
+  static let scriptSandbox: WKContentWorld = .defaultClient
   static let userScript: WKUserScript? = {
     guard var script = loadUserScript(named: scriptName) else {
       return nil
@@ -74,8 +73,8 @@ class BraveSearchResultAdScriptHandler: TabContentScript {
           let messageData = try? JSONSerialization.data(withJSONObject: message.body, options: []),
           let searchResultAds = try? JSONDecoder().decode(SearchResultAdResponse.self, from: messageData)
     else {
-        Logger.module.error("Failed to parse search result ads response")
-        return
+      Logger.module.error("Failed to parse search result ads response")
+      return
     }
 
     processSearchResultAds(searchResultAds, braveSearchResultAdManager: braveSearchResultAdManager)
@@ -95,11 +94,11 @@ class BraveSearchResultAdScriptHandler: TabContentScript {
       var conversion: BraveAds.ConversionInfo?
       if let conversionUrlPatternValue = ad.conversionUrlPatternValue,
          let conversionObservationWindowValue = ad.conversionObservationWindowValue {
-         let timeInterval = TimeInterval(conversionObservationWindowValue * BraveSearchResultAdScriptHandler.secondsInDay)
+         let timeInterval = TimeInterval(conversionObservationWindowValue) * 1.days
         conversion = .init(
-            urlPattern: conversionUrlPatternValue,
-            verifiableAdvertiserPublicKeyBase64: ad.conversionAdvertiserPublicKeyValue,
-            observationWindow: Date(timeIntervalSince1970: timeInterval)
+          urlPattern: conversionUrlPatternValue,
+          verifiableAdvertiserPublicKeyBase64: ad.conversionAdvertiserPublicKeyValue,
+          observationWindow: Date(timeIntervalSince1970: timeInterval)
         )
       }
 
@@ -117,7 +116,8 @@ class BraveSearchResultAdScriptHandler: TabContentScript {
         conversion: conversion
       )
 
-      braveSearchResultAdManager.triggerSearchResultAdViewedEvent(searchResultAd)
+      braveSearchResultAdManager.triggerSearchResultAdViewedEvent(
+        placementId: ad.placementId, searchResultAd:searchResultAd)
     }
   }
 }

ios/brave-ios/Sources/Brave/Frontend/UserContent/UserScripts/Scripts_Dynamic/Scripts/DomainSpecific/Paged/BraveSearchResultAdScript.js

@@ -1,7 +1,7 @@
-// Copyright 2024 The Brave Authors. All rights reserved.
+// Copyright (c) 2024 The Brave Authors. All rights reserved.
 // This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+// License, v. 2.0. If a copy of the MPL was not distributed with this file,
+// You can obtain one at https://mozilla.org/MPL/2.0/.
 
 'use strict';
 
@@ -14,8 +14,10 @@ window.__firefox__.includeOnce('BraveSearchResultAdScript', function($) {
   });
 
   let getJsonLdCreatives = () => {
-    const scripts = document.querySelectorAll('script[type="application/ld+json"]');
-    const jsonLdList = Array.from(scripts).map(script => JSON.parse(script.textContent));
+    const scripts =
+      document.querySelectorAll('script[type="application/ld+json"]');
+    const jsonLdList =
+      Array.from(scripts).map(script => JSON.parse(script.textContent));
 
     if (!jsonLdList) {
       return [];
@@ -32,8 +34,10 @@ window.__firefox__.includeOnce('BraveSearchResultAdScript', function($) {
       'data-description': 'description',
       'data-rewards-value': 'rewardsValue',
       'data-conversion-url-pattern-value': 'conversionUrlPatternValue',
-      'data-conversion-advertiser-public-key-value': 'conversionAdvertiserPublicKeyValue',
-      'data-conversion-observation-window-value': 'conversionObservationWindowValue'
+      'data-conversion-advertiser-public-key-value':
+        'conversionAdvertiserPublicKeyValue',
+      'data-conversion-observation-window-value':
+        'conversionObservationWindowValue'
     };
 
     let jsonLdCreatives = [];

ios/browser/api/ads/brave_ads.h

@@ -60,7 +60,7 @@ OBJC_EXPORT
 /// disabled.
 + (BOOL)shouldAlwaysRunService;
 
-/// Returns |true| if search result ads are supported.
+/// Returns `true` if search result ads are supported.
 + (BOOL)shouldSupportSearchResultAds;
 
 /// Whether or not Brave Ads is enabled and the user should receive
@@ -122,8 +122,7 @@ OBJC_EXPORT
                                 (BraveAdsPromotedContentAdEventType)eventType
                            completion:(void (^)(BOOL success))completion;
 
-- (void)triggerSearchResultAdEvent:
-            (BraveAdsSearchResultAdInfo*)searchResultAdInfo
+- (void)triggerSearchResultAdEvent:(BraveAdsSearchResultAdInfo*)searchResultAd
                          eventType:(BraveAdsSearchResultAdEventType)eventType
                         completion:(void (^)(BOOL success))completion;
 

ios/browser/api/ads/brave_ads.mm

@@ -1733,16 +1733,15 @@ - (void)triggerPromotedContentAdEvent:(NSString*)placementId
       }));
 }
 
-- (void)triggerSearchResultAdEvent:
-            (BraveAdsSearchResultAdInfo*)searchResultAdInfo
+- (void)triggerSearchResultAdEvent:(BraveAdsSearchResultAdInfo*)searchResultAd
                          eventType:(BraveAdsSearchResultAdEventType)eventType
                         completion:(void (^)(BOOL success))completion {
-  if (![self isServiceRunning] || !searchResultAdInfo) {
+  if (![self isServiceRunning] || !searchResultAd) {
     return;
   }
 
   ads->TriggerSearchResultAdEvent(
-      searchResultAdInfo.cppObjPtr,
+      searchResultAd.cppObjPtr,
       static_cast<brave_ads::mojom::SearchResultAdEventType>(eventType),
       base::BindOnce(^(const bool success) {
         completion(success);