Set up global callback and partner parameters

The Adjust Android Extension for Adobe Experience SDK enables you to send additional information to Adjust to forward to your callback URL and network partners. Global parameters are string key-value pairs that you can use to communicate more information about a device or user.

Global callback parameters

If you register a callback URL in the Adjust dashboard, Adjust sends a GET request to your callback URL when the SDK sends session data. To append parameters to this callback request, set the global parameters in your code.

Reference

The Adjust class methods manage the global callback parameters. You can add and remove individual parameters, or reset all parameters at once.

Add a global callback parameter

To add a global callback parameter, call the addGlobalCallbackParameter method with the following arguments:

key: NSString

The parameter key.

value: NSString

The parameter value.

You can add multiple parameters by calling the addGlobalCallbackParameter method multiple times.

1
Adjust.addGlobalCallbackParameter("value", forKey: "key")
2
Adjust.addGlobalCallbackParameter("855", forKey: "user_id")

1
[Adjust addGlobalCallbackParameter:@"value" forKey:@"key"];
2
[Adjust addGlobalCallbackParameter:@"855" forKey:@"user_id"];

Remove a global callback parameter

To remove a global callback parameter, call the removeGlobalCallbackParameter method with the following argument:

key: NSString

The key of the parameter you want to remove.

1
Adjust.removeGlobalCallbackParameter(forkey: "key")

1
[Adjust removeGlobalCallbackParameterForKey:@"key"];

Remove all global callback parameters

To remove all global callback parameters at once, call the removeGlobalCallbackParameters method.

This method removes all active global callback parameters, meaning you won't receive any parameters in callbacks from Adjust.

1
Adjust.removeGlobalCallbackParameters()

1
[Adjust removeGlobalCallbackParameters];

Global partner parameters

You can send extra information to your network partners by adding partner parameters. Sharing additional parameters with your external partners enables more granular analysis and facilitates retargeting.

When the Adjust iOS Extension for Adobe Experience SDK sends session data, Adjust's servers forward any global partner parameters to any partners you've configured.

Read choose data sharing options to learn how to configure what data you share with external partners.

Reference

The Adjust class methods manage the global partner parameters. You can add and remove individual parameters, or reset all parameters at once.

Add a global partner parameter

To add a global partner parameter, call the Adjust.addGlobalPartnerParameter method with the following arguments:

key: NSString

The parameter key.

value: NSString

The parameter value.

You can add multiple parameters by calling the Adjust.addGlobalPartnerParameter method multiple times.

1
Adjust.addGlobalPartnerParameter("value", forKey: "key")
2
Adjust.addGlobalPartnerParameter("855", forKey: "user_id")

1
[Adjust addGlobalPartnerParameter:@"value" forKey:@"key"];
2
[Adjust addGlobalPartnerParameter:@"855" forKey:@"user_id"];

Remove a global partner parameter

To remove a global partner parameter, call the Adjust.removeGlobalPartnerParameter method with the following argument:

key: NSString

The key of the parameter you want to remove.

1
Adjust.removeGlobalPartnerParameter(forkey: "key")

1
[Adjust removeGlobalPartnerParameterForKey:@"key"];

Remove all global partner parameters

To remove all global partner parameters at once, call the Adjust.removeGlobalPartnerParameters method.

This method removes all active global partner parameters, meaning no parameters will be sent to network partners.

1
Adjust.removeGlobalPartnerParameters()

1
[Adjust removeGlobalPartnerParameters];

Tutorial: Add global parameters

You can change your global callback and partner parameters at any time by calling the methods described on this page. If you followed the integration guide, your View Controller should look something like this:

1
import AEPCore
2
import AdjustAdobeExtension
3

4
class ViewController: UIViewController {
5

6
   override func viewDidLoad() {
7
      super.viewDidLoad()
8
   }
9
}

1
#import "ViewController.h"
2
@import AEPCore;
3
#import <AdjustAdobeExtension/AdjustAdobeExtension.h>
4

5
@implementation ViewController
6

7
- (void)viewDidLoad {
8
   [super viewDidLoad];
9
}
10

11
@end

Add some global parameters and global partner parameters to send them to Adjust with each session.

1
import AEPCore
2
import AdjustAdobeExtension
3

4
class ViewController: UIViewController {
5

6
   override func viewDidLoad() {
7
      super.viewDidLoad()
8

9
      Adjust.addGlobalCallbackParameter("value", forKey: "key")
10
      Adjust.addGlobalCallbackParameter("855", forKey: "user_id")
11

12
      Adjust.addGlobalPartnerParameter("value", forKey: "key")
13
      Adjust.addGlobalPartnerParameter("855", forKey: "user_id")
14
   }
15
}

1
#import "ViewController.h"
2
@import AEPCore;
3
#import <AdjustAdobeExtension/AdjustAdobeExtension.h>
4

5
@implementation ViewController
6

7
- (void)viewDidLoad {
8
   [super viewDidLoad];
9

10
   [Adjust addGlobalCallbackParameter:@"value" forKey:@"key"];
11
   [Adjust addGlobalCallbackParameter:@"855" forKey:@"user_id"];
12

13
   [Adjust addGlobalPartnerParameter:@"value" forKey:@"key"];
14
   [Adjust addGlobalPartnerParameter:@"855" forKey:@"user_id"];
15
}
16

17
@end