Set session callback parameters
Session parameters are saved locally and sent with every session and every event the Adtrace SDK records. They are global SDK-level values, not tied to a single ADTEvent.
When you add a session parameter, the SDK stores it so you do not need to set it again on each session or trackEvent call.
Adding the same session parameter key twice has no effect. The first value is kept.
You can call session parameter methods before [Adtrace appDidLaunch:] / Adtrace.appDidLaunch(...) so they are included on the install session. If you need a value for install but can only read it after launch, use Delay SDK start to defer the first session briefly while you attach parameters.
| Session callback parameters | Event callback parameters | |
|---|---|---|
| API | [Adtrace addSessionCallbackParameter:value:] | [event addCallbackParameter:value:] |
| Scope | Every session and event | One event |
| When to set | Any time (including before SDK init) | Before trackEvent |
| Key conflict | Event parameter wins | Takes precedence over session |
If you register a callback URL in the Adtrace panel, session callback parameters are appended to that URL on each session and event, together with any event-level callback parameters.
This page is about callback URL parameters (key-value data sent with sessions and events). For success/failure delegate callbacks when the SDK sends packages, see Send callback information.
Session callback parameters
The interface matches event callback parameters, but you call it on Adtrace instead of on an ADTEvent.
Session callback parameters merge with callback parameters you add to an event. Event callback parameters take precedence: if the same key exists on the session and on an event, the event value is sent.
Add session callback parameters
Method signature
+ (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;
| Parameter | Type | Description |
|---|---|---|
key | NSString | The callback parameter name. |
value | NSString | The callback parameter value. You can also use placeholders such as {idfa}. |
Call the method once per key-value pair. You can add multiple parameters by calling it multiple times.
Example
- Objective-C
- Swift
- WebView
[Adtrace addSessionCallbackParameter:@"foo" value:@"bar"];
Adtrace.addSessionCallbackParameter("foo", value: "bar")
Adtrace.addSessionCallbackParameter('foo', 'bar');
Remove session callback parameters
Method signature
+ (void)removeSessionCallbackParameter:(nonnull NSString *)key;
| Parameter | Type | Description |
|---|---|---|
key | NSString | The session callback parameter key to remove. |
Example
- Objective-C
- Swift
- WebView
[Adtrace removeSessionCallbackParameter:@"foo"];
Adtrace.removeSessionCallbackParameter("foo")
Adtrace.removeSessionCallbackParameter('foo');
Reset session callback parameters
Method signature
+ (void)resetSessionCallbackParameters;
Removes all session callback parameter keys and values.
Example
- Objective-C
- Swift
- WebView
[Adtrace resetSessionCallbackParameters];
Adtrace.resetSessionCallbackParameters()
Adtrace.resetSessionCallbackParameters();
Session partner parameters
Session partner parameters work like event partner parameters, but they apply to every session and event.
Adtrace forwards them to network partners you have set up in the panel. Session partner parameters merge with event partner parameters. Event partner parameters take precedence when the same key exists on both.
Add session partner parameters
Method signature
+ (void)addSessionPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;
| Parameter | Type | Description |
|---|---|---|
key | NSString | The partner parameter name. |
value | NSString | The partner parameter value. |
Example
- Objective-C
- Swift
- WebView
[Adtrace addSessionPartnerParameter:@"foo" value:@"bar"];
Adtrace.addSessionPartnerParameter("foo", value: "bar")
Adtrace.addSessionPartnerParameter('foo', 'bar');
Remove session partner parameters
Method signature
+ (void)removeSessionPartnerParameter:(nonnull NSString *)key;
| Parameter | Type | Description |
|---|---|---|
key | NSString | The session partner parameter key to remove. |
Example
- Objective-C
- Swift
- WebView
[Adtrace removeSessionPartnerParameter:@"foo"];
Adtrace.removeSessionPartnerParameter("foo")
Adtrace.removeSessionPartnerParameter('foo');
Reset session partner parameters
Method signature
+ (void)resetSessionPartnerParameters;
Removes all session partner parameter keys and values.
Example
- Objective-C
- Swift
- WebView
[Adtrace resetSessionPartnerParameters];
Adtrace.resetSessionPartnerParameters()
Adtrace.resetSessionPartnerParameters();
Send session parameters on install
Call addSessionCallbackParameter (and partner parameters if needed) before appDidLaunch when the value must be present on the install session:
- Objective-C
- Swift
[Adtrace addSessionCallbackParameter:@"user_segment" value:@"premium"];
NSString *appToken = @"{YourAppToken}";
NSString *environment = ADTEnvironmentSandbox;
ADTConfig *adtraceConfig = [ADTConfig configWithAppToken:appToken
environment:environment];
[Adtrace appDidLaunch:adtraceConfig];
Adtrace.addSessionCallbackParameter("user_segment", value: "premium")
let appToken = "{YourAppToken}"
let environment = ADTEnvironmentSandbox
let adtraceConfig = ADTConfig(appToken: appToken, environment: environment)
Adtrace.appDidLaunch(adtraceConfig)
If the value is not ready at launch, use Delay SDK start on ADTConfig instead of initializing immediately. After the delay ends (or when you call sendFirstPackages), session parameters you added are included on the delayed install session and events.