feat: add marketing consent support to sdk and prefab

CodeSchwert · CodeSchwert · commit 5ff736986281 · 2025-08-12T14:51:49.000+12:00
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/Helpers/WindowsDeepLink.cs b/src/Packages/Passport/Runtime/Scripts/Private/Helpers/WindowsDeepLink.cs
@@ -259,7 +259,6 @@ private static void RegisterProtocol(string protocolName)
 
             // Set command to launch the script with the URI parameter
             var scriptLocation = GetGameExecutablePath(".cmd");
-            //string command = $"cmd.exe /c \"\"{scriptLocation}\" \"%1\"\"";
             string command = $"\"{scriptLocation}\" \"%1\"";
             uint commandSize = (uint)((command.Length + 1) * 2);
             
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/Model/DirectLoginMethod.cs b/src/Packages/Passport/Runtime/Scripts/Private/Model/DirectLoginMethod.cs
@@ -8,6 +8,7 @@ namespace Immutable.Passport.Model
     [Serializable]
     public enum DirectLoginMethod
     {
+        None,
         Email,
         Google,
         Apple,
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/Model/DirectLoginOptions.cs b/src/Packages/Passport/Runtime/Scripts/Private/Model/DirectLoginOptions.cs
@@ -19,24 +19,32 @@ public class DirectLoginOptions
         /// </summary>
         public string email;
 
+        /// <summary>
+        /// Marketing consent status (optional).
+        /// </summary>
+        public MarketingConsentStatus? marketingConsentStatus;
+
         /// <summary>
         /// Default constructor.
         /// </summary>
         public DirectLoginOptions()
         {
             directLoginMethod = DirectLoginMethod.Email;
             email = null;
+            marketingConsentStatus = null;
         }
 
         /// <summary>
         /// Constructor with method and email.
         /// </summary>
         /// <param name="loginMethod">The direct login method</param>
         /// <param name="emailAddress">The email address (optional)</param>
-        public DirectLoginOptions(DirectLoginMethod loginMethod, string emailAddress = null)
+        /// <param name="marketingConsentStatus">The marketing consent status (optional)</param>
+        public DirectLoginOptions(DirectLoginMethod loginMethod, string emailAddress = null, MarketingConsentStatus? marketingConsentStatus = null)
         {
             directLoginMethod = loginMethod;
             email = emailAddress;
+            this.marketingConsentStatus = marketingConsentStatus;
         }
 
         /// <summary>
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/Model/MarketingConsentStatus.cs b/src/Packages/Passport/Runtime/Scripts/Private/Model/MarketingConsentStatus.cs
@@ -0,0 +1,35 @@
+using System;
+
+namespace Immutable.Passport.Model
+{
+    /// <summary>
+    /// Enum representing marketing consent status.
+    /// </summary>
+    [Serializable]
+    public enum MarketingConsentStatus
+    {
+        OptedIn,
+        Unsubscribed
+    }
+
+    /// <summary>
+    /// Extension methods for MarketingConsentStatus enum.
+    /// </summary>
+    public static class MarketingConsentStatusExtensions
+    {
+        /// <summary>
+        /// Converts the enum value to the string format expected by the game bridge.
+        /// </summary>
+        /// <param name="status">The marketing consent status</param>
+        /// <returns>The corresponding string value</returns>
+        public static string ToApiString(this MarketingConsentStatus status)
+        {
+            return status switch
+            {
+                MarketingConsentStatus.OptedIn => "opted_in",
+                MarketingConsentStatus.Unsubscribed => "unsubscribed",
+                _ => throw new ArgumentOutOfRangeException(nameof(status), status, "Unknown MarketingConsentStatus value")
+            };
+        }
+    }
+}
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/Model/MarketingConsentStatus.cs.meta b/src/Packages/Passport/Runtime/Scripts/Private/Model/MarketingConsentStatus.cs.meta
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/PassportImpl.cs b/src/Packages/Passport/Runtime/Scripts/Private/PassportImpl.cs
@@ -287,11 +287,22 @@ private async UniTask LaunchAuthUrl()
                         requestJson += $",\"email\":\"{_directLoginOptions.email}\"";
                     }
 
+                    if (_directLoginOptions.marketingConsentStatus != null)
+                    {
+                        var consentValue = _directLoginOptions.marketingConsentStatus.Value.ToApiString();
+                        requestJson += $",\"marketingConsentStatus\":\"{consentValue}\"";
+                    }
+
                     requestJson += "}";
                 }
+                else
+                {
+                    PassportLogger.Debug($"{TAG} No direct login options provided (standard auth flow)");
+                }
 
                 requestJson += "}";
-
+                
+                PassportLogger.Debug($"{TAG} Sending auth URL request: {requestJson}");
                 var callResponse = await _communicationsManager.Call(PassportFunction.GET_PKCE_AUTH_URL, requestJson);
                 var response = callResponse.OptDeserializeObject<StringResponse>();
 
diff --git a/src/Packages/Passport/Runtime/Scripts/Public/PassportManager.cs b/src/Packages/Passport/Runtime/Scripts/Public/PassportManager.cs
@@ -32,6 +32,7 @@ public class PassportManager : MonoBehaviour
         [SerializeField] private bool autoInitialize = true;
         [SerializeField] private bool autoLogin = false;
         [SerializeField] private DirectLoginMethod directLoginMethod = DirectLoginMethod.None;
+        [SerializeField] private MarketingConsentStatus defaultMarketingConsent = MarketingConsentStatus.Unsubscribed;
         [SerializeField] private LogLevel logLevel = LogLevel.Info;
         [SerializeField] private bool redactTokensInLogs = true;
         
@@ -206,19 +207,19 @@ public async void Login()
         }
         
         /// <summary>
-        /// Login with a specific direct login method
+        /// Login with custom direct login options
         /// </summary>
-        /// <param name="loginMethod">The login method to use (Google, Apple, Facebook, or None for default)</param>
-        public async void Login(DirectLoginMethod loginMethod)
+        /// <param name="directLoginOptions">Custom direct login options including method, email, and marketing consent</param>
+        public async void Login(DirectLoginOptions directLoginOptions)
         {
-            await LoginAsync(loginMethod);
+            await LoginAsync(directLoginOptions: directLoginOptions);
         }
         
         /// <summary>
         /// Internal async login method
         /// </summary>
-        /// <param name="loginMethod">Optional login method override. If not provided, uses the configured directLoginMethod</param>
-        private async UniTask LoginAsync(DirectLoginMethod? loginMethod = null)
+        /// <param name="directLoginOptions">Optional direct login options. If null, uses the configured directLoginMethod</param>
+        private async UniTask LoginAsync(DirectLoginOptions directLoginOptions = null)
         {
             if (!IsInitialized || PassportInstance == null)
             {
@@ -228,13 +229,44 @@ private async UniTask LoginAsync(DirectLoginMethod? loginMethod = null)
             
             try
             {
-                DirectLoginMethod methodToUse = loginMethod ?? directLoginMethod;
-                string loginMethodText = methodToUse == DirectLoginMethod.None 
-                    ? "default method" 
-                    : methodToUse.ToString();
+                // Determine final DirectLoginOptions to use
+                DirectLoginOptions finalDirectLoginOptions;
+                string loginMethodText;
+                
+                if (directLoginOptions != null)
+                {
+                    // Use provided DirectLoginOptions (marketing consent already set by developer)
+                    finalDirectLoginOptions = directLoginOptions;
+                    loginMethodText = directLoginOptions.directLoginMethod.ToString();
+                }
+                else
+                {
+                    // Use configured directLoginMethod from Inspector
+                    loginMethodText = directLoginMethod == DirectLoginMethod.None 
+                        ? "default method" 
+                        : directLoginMethod.ToString();
+                    
+                    if (directLoginMethod == DirectLoginMethod.None)
+                    {
+                        // Standard auth flow
+                        finalDirectLoginOptions = null;
+                    }
+                    else
+                    {
+                        // Direct login with configured default marketing consent
+                        finalDirectLoginOptions = new DirectLoginOptions(directLoginMethod, marketingConsentStatus: defaultMarketingConsent);
+                    }
+                }
+                
                 Debug.Log($"[PassportManager] Attempting login with {loginMethodText}...");
                 
-                bool loginSuccess = await PassportInstance.Login(useCachedSession: false, directLoginMethod: methodToUse);
+                // Debug log marketing consent if present
+                if (finalDirectLoginOptions?.marketingConsentStatus != null)
+                {
+                    Debug.Log($"[PassportManager] Marketing consent: {finalDirectLoginOptions.marketingConsentStatus}");
+                }
+                
+                bool loginSuccess = await PassportInstance.Login(useCachedSession: false, directLoginOptions: finalDirectLoginOptions);
                 if (loginSuccess)
                 {
                     IsLoggedIn = true;
@@ -324,23 +356,23 @@ private void ConfigureUIElements()
             if (googleLoginButton != null)
             {
                 googleLoginButton.onClick.RemoveAllListeners();
-                googleLoginButton.onClick.AddListener(() => Login(DirectLoginMethod.Google));
+                googleLoginButton.onClick.AddListener(() => Login(new DirectLoginOptions(DirectLoginMethod.Google, marketingConsentStatus: defaultMarketingConsent)));
                 googleLoginButton.interactable = IsInitialized && !IsLoggedIn;
-                Debug.Log("[PassportManager] Configured Google login button");
+                Debug.Log($"[PassportManager] Configured Google login button with defaultMarketingConsent: {defaultMarketingConsent}");
             }
             
             if (appleLoginButton != null)
             {
                 appleLoginButton.onClick.RemoveAllListeners();
-                appleLoginButton.onClick.AddListener(() => Login(DirectLoginMethod.Apple));
+                appleLoginButton.onClick.AddListener(() => Login(new DirectLoginOptions(DirectLoginMethod.Apple, marketingConsentStatus: defaultMarketingConsent)));
                 appleLoginButton.interactable = IsInitialized && !IsLoggedIn;
                 Debug.Log("[PassportManager] Configured Apple login button");
             }
             
             if (facebookLoginButton != null)
             {
                 facebookLoginButton.onClick.RemoveAllListeners();
-                facebookLoginButton.onClick.AddListener(() => Login(DirectLoginMethod.Facebook));
+                facebookLoginButton.onClick.AddListener(() => Login(new DirectLoginOptions(DirectLoginMethod.Facebook, marketingConsentStatus: defaultMarketingConsent)));
                 facebookLoginButton.interactable = IsInitialized && !IsLoggedIn;
                 Debug.Log("[PassportManager] Configured Facebook login button");
             }
diff --git a/src/Packages/Passport/Samples~/PassportManagerPrefab/README.md b/src/Packages/Passport/Samples~/PassportManagerPrefab/README.md
@@ -57,6 +57,7 @@ The **PassportManager** provides multiple drag-and-drop prefabs for easy Immutab
 - **Auto Initialize**: Automatically initialize on Start (default: true)
 - **Auto Login**: Automatically attempt login after initialization (default: false)
 - **Direct Login Method**: Pre-select login method (None, Google, Apple, Facebook)
+- **Default Marketing Consent**: Default consent status for marketing communications (Unsubscribed, OptedIn)
 - **Log Level**: Control debug output verbosity
 
 ### UI Customization (PassportManagerComplete)
@@ -149,13 +150,57 @@ if (manager.IsInitialized && manager.IsLoggedIn)
     // var address = await manager.PassportInstance.GetAddress();
 }
 
-// Manual login with specific method
-manager.Login(DirectLoginMethod.Google);
+// Manual login with specific method and marketing consent
+var loginOptions = new DirectLoginOptions(DirectLoginMethod.Google, marketingConsentStatus: MarketingConsentStatus.Unsubscribed);
+manager.Login(loginOptions);
+
+// Or use the simpler method (uses default marketing consent from Inspector)
+manager.Login(); // Uses configured directLoginMethod
 
 // Manual logout
 manager.Logout();
 ```
 
+## 📧 Marketing Consent
+
+The PassportManager supports marketing consent for compliance with privacy regulations (GDPR, etc.):
+
+### Default Marketing Consent
+
+Configure the default marketing consent status in the Inspector:
+
+- **Unsubscribed** (default): Users are not subscribed to marketing communications by default
+- **OptedIn**: Users are opted into marketing communications by default
+
+This setting is used when:
+
+- Users authenticate via direct login methods (Google, Apple, Facebook)
+- No explicit marketing consent is provided in code
+
+### Advanced Marketing Consent
+
+For programmatic control over marketing consent:
+
+```csharp
+// Create login options with specific marketing consent
+var loginOptions = new DirectLoginOptions(
+    DirectLoginMethod.Google,
+    marketingConsentStatus: MarketingConsentStatus.Unsubscribed
+);
+
+// Login with explicit marketing consent
+await PassportManager.Instance.LoginAsync(loginOptions);
+```
+
+### Marketing Consent Flow
+
+1. **Unity Game**: Sets marketing consent via `DirectLoginOptions` or uses default from Inspector
+2. **Authentication Server**: Receives and processes the marketing consent preference
+3. **User Profile**: Marketing consent status is stored and applied to user's profile
+4. **Compliance**: Ensures proper consent handling for marketing communications
+
+**Note**: Marketing consent is automatically handled during the authentication flow and integrated with Immutable's user profile system.
+
 ## 📁 Sample Scripts
 
 Check out the included example script:
@@ -182,14 +227,6 @@ The `PassportUIController` uses **aggressive cursor management** designed for de
    }
    ```
 
-## 🔗 Deep Linking Setup
-
-For native platforms (Windows/Mac), you'll need to register your custom URL scheme:
-
-### Windows
-
-The SDK automatically handles Windows deep linking registration.
-
 ## 🆘 Troubleshooting
 
 ### "Can't drag UI elements to Inspector fields"

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ namespace Immutable.Passport.Model`
`8`	`8`	`[Serializable]`
`9`	`9`	`public enum DirectLoginMethod`
`10`	`10`	`{`
	`11`	`+ None,`
`11`	`12`	`Email,`
`12`	`13`	`Google,`
`13`	`14`	`Apple,`