دریافت اطلاعات Attribution

وقتی کاربری با یک لینک tracker ادتریس یا deep link تعامل می‌کند، اطلاعات attribution آن‌ها ممکن است به‌روز شود. جزئیات attribution توسط کلاس ADTAttribution نمایش داده می‌شود.

از این راهنما برای موارد زیر استفاده کنید:

1. خواندن attribution جاری با [Adtrace attribution] / Adtrace.attribution().
2. اجرای کد هنگام تغییر attribution با adtraceAttributionChanged: روی AdtraceDelegate.

property های ADTAttribution

کلاس ADTAttribution وضعیت جاری attribution را برای دستگاه نگه می‌دارد. هر مقداری که برای کاربر تنظیم نشده باشد به عنوان nil برگردانده می‌شود.

Property	نوع	توضیح
trackerToken	NSString	توکن tracker که دستگاه در حال حاضر به آن attributed است.
trackerName	NSString	نام tracker که دستگاه در حال حاضر به آن attributed است.
network	NSString	شبکه‌ای که دستگاه در حال حاضر به آن attributed است.
campaign	NSString	کمپینی که دستگاه در حال حاضر به آن attributed است.
adgroup	NSString	ad group ای که دستگاه در حال حاضر به آن attributed است.
creative	NSString	creative ای که دستگاه در حال حاضر به آن attributed است.
clickLabel	NSString	click label که روی install tag شده.
adid	NSString	شناسه یکتای دستگاه ادتریس.
costType	NSString	مدل قیمت‌گذاری کمپین (برای مثال cpi). نیاز به cost data در attribution دارد.
costAmount	NSNumber	هزینه install. نیاز به cost data در attribution دارد.
costCurrency	NSString	کد ارز ISO 4217 برای هزینه. نیاز به cost data در attribution دارد.

نکته

فیلدهای هزینه فقط زمانی در دسترس هستند که آن‌ها را با setNeedsCost: روی ADTConfig قبل از appDidLaunch فعال کرده باشید. اگر هزینه فعال نشده یا بخشی از attribution نباشد، این فیلدها nil هستند. در SDK نسخه v2.0.5+ موجود است.

دریافت اطلاعات attribution جاری

هر زمان که نیاز داشتید به attribution جاری کاربر دسترسی پیدا کنید با فراخوانی attribution روی Adtrace.

Method signature

+ (nullable ADTAttribution *)attribution;

وقتی کاربر اپ شما را نصب می‌کند، ادتریس install را به یک کمپین نسبت می‌دهد. attribution را فراخوانی کنید تا attribution جاری را به عنوان یک شیء ADTAttribution بخوانید.

مهم

Attribution جاری فقط بعد از اینکه ادتریس install اپ را ردیابی کرد و callback attribution حداقل یک بار trigger شد در دسترس است. قبل از مقداردهی اولیه SDK و اجرای آن callback نمی‌توانید به attribution دسترسی پیدا کنید.

مثال

Objective-C

ADTAttribution *attribution = [Adtrace attribution];
NSLog(@"Tracker token: %@", attribution.trackerToken);

Swift

let attribution = Adtrace.attribution()
print("Tracker token: \(attribution?.trackerToken ?? "")")

Javascript

let attribution = Adtrace.getAttribution();
console.log('Tracker token = ' + attribution.trackerToken);

سپس فیلدها را از شیء برگشتی بخوانید (برای مثال attribution.trackerToken، attribution.campaign).

callback attribution همچنین هر بار که attribution تغییر می‌کند trigger می‌شود، از جمله بعد از deep link های re-engagement.

اجرای تابع هنگام تغییر attribution

مانند فراخوانی attribution در صورت تقاضا، SDK می‌تواند هر بار که اطلاعات attribution تغییر می‌کند به شما اطلاع دهد. یک AdtraceDelegate روی instance ADTConfig خود قبل از appDidLaunch ثبت کنید.

Attribution می‌تواند از منابع مختلف بیاید، بنابراین این اطلاعات در زمان init به صورت synchronous در دسترس نیست. متد delegate بعد از اینکه SDK داده‌های attribution به‌روز را دریافت کرد اجرا می‌شود.

متد delegate

- (void)adtraceAttributionChanged:(nullable ADTAttribution *)attribution;

پارامتر	نوع	توضیح
attribution	ADTAttribution	داده‌های attribution جاری بعد از یک تغییر.

مهم

setDelegate: را روی ADTConfig قبل از مقداردهی اولیه SDK با appDidLaunch فراخوانی کنید. برای راه‌اندازی کامل delegate به ارسال اطلاعات callback مراجعه کنید.

مثال

Objective-C

AppDelegate.m

[adtraceConfig setDelegate:self];

- (void)adtraceAttributionChanged:(ADTAttribution *)attribution {
    NSLog(@"Tracker token: %@", attribution.trackerToken);
    NSLog(@"Campaign: %@", attribution.campaign);
}

Swift

AppDelegate.swift

adtraceConfig?.delegate = self

func adtraceAttributionChanged(_ attribution: ADTAttribution?) {
    print("Tracker token: \(attribution?.trackerToken ?? "")")
    print("Campaign: \(attribution?.campaign ?? "")")
}

Javascript

adtraceConfig.setAttributionCallback(function(attribution) {
    console.log('Tracker token = ' + attribution.trackerToken);
    console.log('Campaign = ' + attribution.campaign);
});

برای نحوه ایجاد instance ADTConfig، به پیکربندی مراجعه کنید.

مرتبط

• فعال‌سازی cost data در attribution
• ارسال اطلاعات callback
• Deep linking
• پیکربندی
• iOS SDK README (user attribution)