تنظیم پارامترهای callback Session

پارامترهای Session به صورت محلی ذخیره شده و با هر Session و هر رویدادی که Adtrace SDK ثبت می‌کند ارسال می‌شوند. آن‌ها مقادیر global سطح SDK هستند، نه مرتبط با یک ADTEvent واحد.

وقتی یک پارامتر Session اضافه می‌کنید، SDK آن را ذخیره می‌کند تا نیازی نباشد در هر Session یا فراخوانی trackEvent دوباره تنظیمش کنید.

کلیدهای تکراری

افزودن کلید پارامتر Session یکسان دو بار هیچ تأثیری ندارد. مقدار اول نگه داشته می‌شود.

می‌توانید متدهای پارامتر Session را قبل از [Adtrace appDidLaunch:] / Adtrace.appDidLaunch(...) فراخوانی کنید تا در Session install شامل شوند. اگر به یک مقدار برای install نیاز دارید اما تنها بعد از راه‌اندازی می‌توانید آن را بخوانید، از تأخیر شروع SDK استفاده کنید تا اولین Session را کمی به تأخیر بیندازید در حالی که پارامترها را ضمیمه می‌کنید.

	پارامترهای callback Session	پارامترهای callback رویداد
API	[Adtrace addSessionCallbackParameter:value:]	[event addCallbackParameter:value:]
محدوده	هر Session و رویداد	یک رویداد
زمان تنظیم	هر زمان (از جمله قبل از init SDK)	قبل از trackEvent
تعارض کلید	پارامتر رویداد برنده می‌شود	بر Session اولویت دارد

اگر یک URL callback در پنل ادتریس ثبت کرده‌اید، پارامترهای callback Session به آن URL در هر Session و رویداد، همراه با پارامترهای callback سطح رویداد ضمیمه می‌شوند.

Session در مقابل callback های SDK

این صفحه درباره پارامترهای URL callback (داده key-value ارسال شده با Session ها و رویدادها) است. برای callback های delegate Success callbacks / Failure callbacks هنگامی که SDK بسته‌ها ارسال می‌کند، به ارسال اطلاعات callback مراجعه کنید.

پارامترهای callback Session

interface با پارامترهای callback رویداد مطابقت دارد، اما آن را روی Adtrace به جای ADTEvent فراخوانی می‌کنید.

پارامترهای callback Session با پارامترهای callback که به یک رویداد اضافه می‌کنید ادغام می‌شوند. پارامترهای callback رویداد اولویت دارند: اگر همان کلید هم روی Session و هم روی رویداد وجود داشته باشد، مقدار رویداد ارسال می‌شود.

افزودن پارامترهای callback Session

Method signature

+ (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

پارامتر	نوع	توضیح
key	NSString	نام پارامتر callback.
value	NSString	مقدار پارامتر callback. همچنین می‌توانید از placeholder هایی مانند {idfa} استفاده کنید.

متد را یک بار به ازای هر جفت key-value فراخوانی کنید. می‌توانید با فراخوانی چندباره آن پارامترهای متعدد اضافه کنید.

مثال

Objective-C

[Adtrace addSessionCallbackParameter:@"foo" value:@"bar"];

Swift

Adtrace.addSessionCallbackParameter("foo", value: "bar")

WebView

Adtrace.addSessionCallbackParameter('foo', 'bar');

حذف پارامترهای callback Session

Method signature

+ (void)removeSessionCallbackParameter:(nonnull NSString *)key;

پارامتر	نوع	توضیح
key	NSString	کلید پارامتر callback Session برای حذف.

مثال

Objective-C

[Adtrace removeSessionCallbackParameter:@"foo"];

Swift

Adtrace.removeSessionCallbackParameter("foo")

WebView

Adtrace.removeSessionCallbackParameter('foo');

Reset پارامترهای callback Session

Method signature

+ (void)resetSessionCallbackParameters;

تمام کلیدها و مقادیر پارامتر callback Session را حذف می‌کند.

مثال

Objective-C

[Adtrace resetSessionCallbackParameters];

Swift

Adtrace.resetSessionCallbackParameters()

WebView

Adtrace.resetSessionCallbackParameters();

پارامترهای partner Session

پارامترهای partner Session مانند پارامترهای partner رویداد کار می‌کنند، اما برای هر Session و رویداد اعمال می‌شوند.

ادتریس آن‌ها را به network partner هایی که در پنل راه‌اندازی کرده‌اید ارسال می‌کند. پارامترهای partner Session با پارامترهای partner رویداد ادغام می‌شوند. پارامترهای partner رویداد اولویت دارند وقتی همان کلید در هر دو وجود داشته باشد.

افزودن پارامترهای partner Session

Method signature

+ (void)addSessionPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

پارامتر	نوع	توضیح
key	NSString	نام پارامتر partner.
value	NSString	مقدار پارامتر partner.

مثال

Objective-C

[Adtrace addSessionPartnerParameter:@"foo" value:@"bar"];

Swift

Adtrace.addSessionPartnerParameter("foo", value: "bar")

WebView

Adtrace.addSessionPartnerParameter('foo', 'bar');

حذف پارامترهای partner Session

Method signature

+ (void)removeSessionPartnerParameter:(nonnull NSString *)key;

پارامتر	نوع	توضیح
key	NSString	کلید پارامتر partner Session برای حذف.

مثال

Objective-C

[Adtrace removeSessionPartnerParameter:@"foo"];

Swift

Adtrace.removeSessionPartnerParameter("foo")

WebView

Adtrace.removeSessionPartnerParameter('foo');

Reset پارامترهای partner Session

Method signature

+ (void)resetSessionPartnerParameters;

تمام کلیدها و مقادیر پارامتر partner Session را حذف می‌کند.

مثال

Objective-C

[Adtrace resetSessionPartnerParameters];

Swift

Adtrace.resetSessionPartnerParameters()

WebView

Adtrace.resetSessionPartnerParameters();

ارسال پارامترهای Session در install

addSessionCallbackParameter (و پارامترهای partner در صورت نیاز) را قبل از appDidLaunch فراخوانی کنید وقتی مقدار باید در Session install موجود باشد:

Objective-C

AppDelegate.m

[Adtrace addSessionCallbackParameter:@"user_segment" value:@"premium"];

NSString *appToken = @"{YourAppToken}";
NSString *environment = ADTEnvironmentSandbox;
ADTConfig *adtraceConfig = [ADTConfig configWithAppToken:appToken
                                             environment:environment];
[Adtrace appDidLaunch:adtraceConfig];

Swift

AppDelegate.swift

Adtrace.addSessionCallbackParameter("user_segment", value: "premium")

let appToken = "{YourAppToken}"
let environment = ADTEnvironmentSandbox
let adtraceConfig = ADTConfig(appToken: appToken, environment: environment)
Adtrace.appDidLaunch(adtraceConfig)

اگر مقدار در راه‌اندازی آماده نیست، از تأخیر شروع SDK روی ADTConfig استفاده کنید به جای مقداردهی اولیه فوری. بعد از پایان تأخیر (یا وقتی sendFirstPackages را فراخوانی کنید)، پارامترهای Session که اضافه کرده‌اید در Session install تأخیری و رویدادها شامل می‌شوند.

مرتبط

• ارسال اطلاعات callback
• ردیابی رویدادها
• تأخیر شروع SDK
• پیکربندی
• iOS SDK README (session parameters)