Merge pull request #412 from BranchMetrics/add-campaign

Add campaign to link properties

Author: ahmednawar

Branch-SDK/Branch-SDK/BNCLinkData.h

@@ -23,6 +23,7 @@ typedef NS_ENUM(NSUInteger, BranchLinkType) {
 - (void)setupChannel:(NSString *)channel;
 - (void)setupFeature:(NSString *)feature;
 - (void)setupStage:(NSString *)stage;
+- (void)setupCampaign:(NSString *)campaign;
 - (void)setupParams:(NSDictionary *)params;
 - (void)setupMatchDuration:(NSUInteger)duration;
 - (void)setupIgnoreUAString:(NSString *)ignoreUAString;

Branch-SDK/Branch-SDK/BNCLinkData.m

@@ -17,6 +17,7 @@ @interface BNCLinkData ()
 @property (strong, nonatomic) NSString *channel;
 @property (strong, nonatomic) NSString *feature;
 @property (strong, nonatomic) NSString *stage;
+@property (strong, nonatomic) NSString *campaign;
 @property (strong, nonatomic) NSDictionary *params;
 @property (strong, nonatomic) NSString *ignoreUAString;
 @property (assign, nonatomic) BranchLinkType type;
@@ -90,6 +91,14 @@ - (void)setupStage:(NSString *)stage {
     }
 }
 
+- (void)setupCampaign:(NSString *)campaign {
+    if (campaign) {
+        _campaign = campaign;
+        
+        self.data[BRANCH_REQUEST_KEY_URL_CAMPAIGN] = campaign;
+    }
+}
+
 - (void)setupIgnoreUAString:(NSString *)ignoreUAString {
     if (ignoreUAString) {
         _ignoreUAString = ignoreUAString;
@@ -116,6 +125,7 @@ - (NSUInteger)hash {
     result = prime * result + [[BNCEncodingUtils md5Encode:self.channel] hash];
     result = prime * result + [[BNCEncodingUtils md5Encode:self.feature] hash];
     result = prime * result + [[BNCEncodingUtils md5Encode:self.stage] hash];
+    result = prime * result + [[BNCEncodingUtils md5Encode:self.campaign] hash];
     result = prime * result + [[BNCEncodingUtils md5Encode:encodedParams] hash];
     result = prime * result + self.duration;
 
@@ -145,6 +155,9 @@ - (void)encodeWithCoder:(NSCoder *)coder {
     if (self.stage) {
         [coder encodeObject:self.stage forKey:BRANCH_REQUEST_KEY_URL_STAGE];
     }
+    if (self.campaign) {
+        [coder encodeObject:self.campaign forKey:BRANCH_REQUEST_KEY_URL_CAMPAIGN];
+    }
     if (self.params) {
         NSString *encodedParams = [BNCEncodingUtils encodeDictionaryToJsonString:self.params];
         [coder encodeObject:encodedParams forKey:BRANCH_REQUEST_KEY_URL_DATA];
@@ -162,6 +175,7 @@ - (id)initWithCoder:(NSCoder *)coder {
         self.channel = [coder decodeObjectForKey:BRANCH_REQUEST_KEY_URL_CHANNEL];
         self.feature = [coder decodeObjectForKey:BRANCH_REQUEST_KEY_URL_FEATURE];
         self.stage = [coder decodeObjectForKey:BRANCH_REQUEST_KEY_URL_STAGE];
+        self.campaign = [coder decodeObjectForKey:BRANCH_REQUEST_KEY_URL_CAMPAIGN];
         self.duration = [[coder decodeObjectForKey:BRANCH_REQUEST_KEY_URL_DURATION] integerValue];
 
         NSString *encodedParams = [coder decodeObjectForKey:BRANCH_REQUEST_KEY_URL_DATA];

Branch-SDK/Branch-SDK/Branch.h

@@ -199,6 +199,20 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 + (BranchActivityItemProvider *)getBranchActivityItemWithParams:(NSDictionary *)params feature:(NSString *)feature stage:(NSString *)stage tags:(NSArray *)tags alias:(NSString *)alias;
 
+/**
+ Create a BranchActivityItemProvider which subclasses the `UIActivityItemProvider` This can be used for simple sharing via a `UIActivityViewController`.
+ 
+ Internally, this will create a short Branch Url that will be attached to the shared content.
+ 
+ @param params A dictionary to use while building up the Branch link.
+ @param feature The feature the generated link will be associated with.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param campaign Use this field to organize the links by actual marketing campaign.
+ @param alias The alias for a link.
+ @warning This can fail if the alias is already taken.
+ */
++ (BranchActivityItemProvider *)getBranchActivityItemWithParams:(NSDictionary *)params feature:(NSString *)feature stage:(NSString *)stage campaign:(NSString *)campmaign tags:(NSArray *)tags alias:(NSString *)alias;
+
 /**
  Create a BranchActivityItemProvider which subclasses the `UIActivityItemProvider` This can be used for simple sharing via a `UIActivityViewController`.
  
@@ -759,21 +773,22 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 - (NSString *)getShortURLWithParams:(NSDictionary *)params andTags:(NSArray *)tags andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alias ignoreUAString:(NSString *)ignoreUAString;
 
 /**
- Get a short url with specified tags, params, channel, feature, and stage. The usage type will default to unlimited.
+ Get a short url with specified tags, params, channel, feature, stage and campaign. The usage type will default to unlimited.
  
  @param params Dictionary of parameters to include in the link.
  @param tags An array of tags to associate with this link, useful for tracking.
  @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
  @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
  @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param campaign Use this field to organize the links by actual marketing campaign.
  @param alias The alias for a link.
  @param ignoreUAString The User Agent string to tell the server to ignore the next request from, to prevent it from treating a preview scrape as a link click.
  @param forceLinkCreation Whether we should create a link from the Branch Key even if initSession failed. Defaults to NO.
  @warning This method makes a synchronous url request.
  @warning This method is primarily intended to be an internal Branch method, used to work around a bug with SLComposeViewController
  @warning This can fail if the alias is already taken.
  */
-- (NSString *)getShortURLWithParams:(NSDictionary *)params andTags:(NSArray *)tags andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alias ignoreUAString:(NSString *)ignoreUAString forceLinkCreation:(BOOL)forceLinkCreation;
+- (NSString *)getShortURLWithParams:(NSDictionary *)params andTags:(NSArray *)tags andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCampaign:(NSString *)campaign andAlias:(NSString *)alias ignoreUAString:(NSString *)ignoreUAString forceLinkCreation:(BOOL)forceLinkCreation;
 
 /**
  Get a short url with specified tags, params, channel, feature, stage, and type.
@@ -816,6 +831,22 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (NSString *)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andMatchDuration:(NSUInteger)duration;
 
+
+/**
+ Get a short url with specified params, channel, feature, stage, campaign and match duration. The usage type will default to unlimited.
+ 
+ @param params Dictionary of parameters to include in the link.
+ @param tags An array of tags to associate with this link, useful for tracking.
+ @param alias The alias for a link.
+ @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
+ @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param campaign Use this field to organize the links by actual marketing campaign.
+ @param matchDuration How long to keep an unmatched link click in the Branch backend server's queue before discarding.
+ @warning This method makes a synchronous url request.
+ */
+- (NSString *)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCampaign:campaign andMatchDuration:(NSUInteger)duration;
+
 #pragma mark - Long Url generation
 
 ///--------------------------
@@ -1026,6 +1057,22 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andMatchDuration:(NSUInteger)duration andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCallback:(callbackWithUrl)callback;
 
+/**
+ Get a short url with the specified params, tags, channel, feature, stage, campaign and match duration. The usage type will default to unlimited.
+ 
+ @param params Dictionary of parameters to include in the link.
+ @param channel The channel for the link. Examples could be Facebook, Twitter, SMS, etc, depending on where it will be shared.
+ @param tags An array of tags to associate with this link, useful for tracking.
+ @param feature The feature this is utilizing. Examples could be Sharing, Referring, Inviting, etc.
+ @param stage The stage used for the generated link, indicating what part of a funnel the user is in.
+ @param matchDuration How long to keep an unmatched link click in the Branch backend server's queue before discarding.
+ @param campaign Use this field to organize the links by actual marketing campaign.
+ @param callback Callback called with the url.
+ @param alias The alias for a link.
+ @warning This can fail if the alias is already taken.
+ */
+- (void)getShortUrlWithParams:(NSDictionary *)params andTags:(NSArray *)tags andAlias:(NSString *)alias andMatchDuration:(NSUInteger)duration andChannel:(NSString *)channel andFeature:(NSString *)feature andStage:(NSString *)stage andCampaign:(NSString *)campaign andCallback:(callbackWithUrl)callback;
+
 - (void)getSpotlightUrlWithParams:(NSDictionary *)params callback:(callbackWithParams)callback;
 
 #pragma mark - Content Discovery methods