Skip to content
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

Support for setting customer_event_alias for BranchEvent #244

Closed
jf-branch opened this issue Sep 27, 2023 · 7 comments
Closed

Support for setting customer_event_alias for BranchEvent #244

jf-branch opened this issue Sep 27, 2023 · 7 comments
Labels
enhancement New feature or request

Comments

@jf-branch
Copy link

Feature Request
The Branch v2 Events API and the native iOS SDKs support associating an event alias property to standard and custom events, but this does not seem exposed through the Flutter Event interface.

iOS declaration of BranchEvent.alias: https://github.com/BranchMetrics/ios-branch-deep-linking-attribution/blob/master/BranchSDK/BranchEvent.h#L78

Android declartion of BranchEvent.setCustomerEventAlias : https://github.com/BranchMetrics/android-branch-deep-linking-attribution/blob/master/Branch-SDK/src/main/java/io/branch/referral/util/BranchEvent.java#L71

Could we please request to support exposing setting of this parameter through flutter_event.dart's BranchEvent: https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/lib/src/objects/branch_event.dart#L49

Thank you!
Best,
Justin

@jf-branch jf-branch added the bug Something isn't working label Sep 27, 2023
@jf-branch jf-branch changed the title Support for setting customer_event_alias on Events Support for setting customer_event_alias for BranchEvent Sep 27, 2023
@RodrigoSMarques
Copy link
Owner

Hi @jf-branch

I will analyze the code to understand how it works. Is there any documentation in the SDK guides that explains how this method works?

@RodrigoSMarques
Copy link
Owner

@jf-branch

you can analyze this issue here: #168

@jf-branch
Copy link
Author

@RodrigoSMarques not specifically for customer_event_alias, but the business value is as a subtype or a subname to better distinguish standard or larger events. But this API reference may help: https://help.branch.io/developers-hub/reference/events-api

I.e I have a Subscription event, top level its SUBSCRIPTION, but if i wanted to distinguish what type of SUBSCRIPTION i can do so through customer_event_alias:
i.e:
Event Name: SUBSCRIPTION:
customer_event_alias options:

  • one_month
  • three_months
  • twelve_months

etc, and then there are some mapping configurations we have when exporting data in which they can use the alias as a filtering field.

but the API excepts it for v2/events at the top level for the key 'customer_event_alias', this is what the native SDKs send it as, when set as a property of BranchEvent

and i will address: #168

@RodrigoSMarques RodrigoSMarques added enhancement New feature or request and removed bug Something isn't working labels Oct 2, 2023
@jf-branch
Copy link
Author

Hey @RodrigoSMarques, will this enhancement go out in 7.0.0?

@RodrigoSMarques
Copy link
Owner

Hi @jf-branch
The enhancement will be released in 6.9.0, tonight or tomorrow morning.
Development is complete and testing on iOS, Android and Web.

It will then be replicated in 7.0.0 which I will keep in beta for some time.

@jf-branch
Copy link
Author

Amazing! Great work. Thank you so much!

RodrigoSMarques added a commit that referenced this issue Oct 6, 2023
## 6.9.0
### Enhancement
* Issue #244 - Support for setting customer_event_alias for BranchEvent
@RodrigoSMarques
Copy link
Owner

@jf-branch
Versions 6.9.0 and 7.0.0-beta.2 released

RodrigoSMarques added a commit that referenced this issue Oct 11, 2023
## 7.0.0-beta.3
⚠️ This is a major release which contains breaking API changes.
### BREAKING CHANGE
-
* Minimum required Dart SDK version to 2.18 (Flutter 3.3.0)
* Xcode 15 is the min version
* iOS 12 is the min version

#### SDK Initialization Required
* Use `FlutterBranchSdk.init()` method to initialize the SDK.

Initialization must be called from `main` or at any time (for example after getting consent for GPDR).

```dart
  await FlutterBranchSdk.init(
      useTestKey: false, enableLogging: false, disableTracking: false);
```

Check additional instructions in the README

#### Deprecated / Removed
-
* `FlutterBranchSdk.initSession()`. Use `FlutterBranchSdk.listSession()`.
* Removed `setIOSSKAdNetworkMaxTime` method
* Removed Facebook App Install Ads on iOS

### Features
-
* Issue #244 - Support for setting customer_event_alias for BranchEvent
* Updated compile & target SDK to Android API 33.
* Updated example app Android compileSdkVersion to 33.

### Native SDK Updates
-
* Updated included iOS SDK to 3.0.0 - [iOS Version History](https://github.com/BranchMetrics/ios-branch-deep-linking-attribution/releases)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants