الزامات راهاندازی یکپارچگی
برای پیوستن به شبکه شرکای یکپارچه ما و استفاده از راهاندازی یکپارچگی پویا، لطفاً الزامات زیر را تکمیل کنید. پس از تکمیل، تیم یکپارچگی ما نسبت به راهاندازی شما در داشبورد متریکس اقدام خواهند کرد.
اطلاعات مورد نیاز
-
توضیح شرکت: توضیح مختصری درباره شرکت و خدمات ارائهشده خود بنویسید (حداقل 3-4 کلمه). این اطلاعات در صفحه فهرست شرکای ما در وبسایت و داشبورد نمایش داده خواهند شد.
-
شناسههای دستگاه: شناسه تبلیغاتی گوگل یا شناسه اندروید را به متریکس در قالب ماکروهای زیر ارسال کنید:
android_id => {android_id}gps_adid => {gps_adid}
-
پارامترهای سفارشی: اگر در حال حاضر شناسه کلیک را به متریکس ارسال میکنید و پارامترهای سفارشی دارید که هنگام ارسال کلیکها پر میکنید، و نیاز دارید که این پارامترها در کالبک نصب برگردانده شوند، ماکروهای پارامترهای پویای خود را به ما اطلاع دهید (مثلاً
{click_id}).
پارامترهای رویداد و ریجکت
- برای postback رویدادها، پارامتر عملیات را میتوان با
{actionName}تعریف کرد. - برای نصبهای ریجکت شده، پارامتر
{rejection_reason}را میتوان به سرور خود ارسال کرد.
URLهای کالبک پویا
متریکس همچنین امکان الحاق پویا URLهای کالبک را مستقیماً به URLهای ترکر با استفاده از پارامتر install_callback فراهم میکند. این بدان معناست که کالبک مستقیماً به URL ترکر الحاق میشود و پس از تبدیل، به طور خودکار کالبک را به نقطه پایانی شما ارسال میکند.
چه پارامترهایی را میتوانم به تعریف URL کالبک اضافه کنم؟
این پارامترها در جدول زیر قابل مشاهده هستند. هر کدام از این پارامترها را میتوانید به دلخواه خودتان انتخاب کنید و آنها را به صورت ماکرو، در url خود اضافه کنید تا متریکس بتواند در کالبک، آنها را به سرور شما ارسال کند:
| پارامتر | نوع پارامتر | توضیح پارامتر | مثال | نصب | نصب مجدد | حذف | تقلب | رخداد | کلیک |
|---|---|---|---|---|---|---|---|---|---|
| tracker_code | String | شناسه ترکر | bdjulq | ✔ | ✔ | ✔ | ✔ | ✖ | ✔ |
| network_name | String | نام شبکه تبلیغاتی | AdNetwork1 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| campaign_name | String | نام کمپین | Black Friday | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| adgroup_name | String | نام گروه تبلیغاتی | Video Banner | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| creative_name | String | نام خلاقه | Product Features | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| sub_id | String | ساب آیدی | 83407c9a-392d-4f6b-b689-eadfe557ff18, abcdefg | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| action_name | String | نوع نصب یا ایونت یا کلیک | fraud | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| reinstalled | Boolean | آیا نصب مجدد است؟ | true, false | ✔ | ✔ | ✖ | ✖ | ✖ | ✖ |
| rejection_reason | String | علت تقلب | anonymousIP, tooManyEngagements, clickInjection, sdkSpoofing, distributionOutlier | ✖ | ✖ | ✖ | ✔ | ✖ | ✖ |
| event_slug | String | شناسه ایونت | uimgx | ✖ | ✖ | ✖ | ✖ | ✔ | ✖ |
| app_name | String | نام packagename پیاده سازی کننده sdk | com.example.test | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| app_version | String | ورژن اپلیکیشن | 1.1.2.Beta | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| device_name | String | مدل دستگاه | sm-a505f | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| device_brand | String | برند دستگاه | xiaomi | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| device_manufacturer | String | سازنده دستگاه | xiaomi | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| android_id | String | شناسه دستگاه اندروید | b9da30111528c740 | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| gps_adid | String | شناسه تبلیغاتی گوگل پلی سرویس | 38400000-8cf0-11bd-b23e-10b96e40000d | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| ip_address | String | آیپی کاربر | 91.251.150.188 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| user_agent | String | یوزر ایجنت | Dalvik/2.1.0 (Linux; U; Android 10; JSN-L22 Build/HONORJSN-L22) | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| metrix_user_id | String | شناسه کاربر در متریکس | c0bcf71e-a027-4cfa-974a-e90e040e5c3a | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| created_at | Timestamp | زمان ایجاد با دقت میلی ثانیه | 1403674212 | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| clicked_at | Timestamp | زمان کلیک با دقت میلی ثانیه | 1403568849 | ✔ | ✔ | ✔ | ✔ | ✖ | ✔ |
| installed_at | Timestamp | زمان نصب با دقت میلی ثانیه | 1404214634 | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
| city | String | شهر کاربر | Tehran | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| country | String | کشور کاربر | IRN | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
توجه: متریکس پارامترها را هم به صورت camelCase و هم به صورت snake_case پشتیبانی می کند.
همچنین اگر پارامتر دلخواهی دارید که هنگام کلیک توسط شما پر میشود و نیاز دارید تا زمان نصب یا کلیک به شما برگردد، میتوانید آن را به صورت placeholder در لینک کالبک خود وارد کنید.
یک نمونه از کالبک نصب میتواند به صورت زیر باشد:
http://callbacks.myserver.com/path?clicked_at={clicked_at}&tracker_code={tracker_code}&ip_address={ip_address}همچنین پارامترهای ست شده توسط شما درون sdk، قابلیت ارسال به سرور شما را خواهند داشت.
ارسال ایونت و اتریبیوتهای آن از طریق کالبک
امکان ارسال اطلاعات ایونت و اتریبیوتهای مربوط به آن از طریق کالبک وجود دارد. برای دریافت مقدار هر اتریبیوت، کافی است Key مربوط به آن اتریبیوت را بهعنوان Placeholder در انتهای لینک کالبک (URL Callback) قرار دهید.
برای مثال، اگر در اتریبیوتهای ایونت یک Key با نام product_id تعریف شده باشد، میتوانید مقدار آن را در لینک کالبک با استفاده از Placeholder مربوط به همان Key دریافت کنید.
در این حالت، مقدار product_id هنگام ارسال کالبک جایگزین Placeholder شده و به URL ارسال میشود.
نکته: نام Placeholder باید دقیقاً مطابق با Key تعریفشده برای اتریبیوت باشد.
دریافت ایونت درآمدی و مبلغ درآمد
برای دریافت اطلاعات مربوط به ایونت درآمدی و مبلغ آن، از Placeholder زیر استفاده کنید:
{_revenue}در این حالت، مقدار درآمد ثبتشده برای ایونت در پارامتر revenue قرار میگیرد و همراه کالبک ارسال میشود.
نمونه کالبک
میتوانید چند اتریبیوت را بهصورت همزمان در کالبک دریافت کنید. برای مثال:
http://callbacks.myserver.com/path?product_id={product_id}&user_type={user_type}&revenue={_revenue}در این مثال، مقدار product_id، مقدار user_type و مبلغ ایونت درآمدی در زمان ارسال کالبک به مقادیر واقعی خود تبدیل شده و به سرور شما ارسال میشوند.