این راهنما یک نمای کلی و دستورالعمل‌های راه‌اندازی را برای گزارش‌های اسناد در سطح رویداد و خلاصه با استفاده از Attribution Reporting API ارائه می‌کند.
برای شروع، یاد خواهید گرفت که:
بین انواع گزارش API Attribution Reporting تفاوت قائل شوید
مراحل اجرای API و تولید گزارش را کامل کنید
اطلاعات مرجع و عیب یابی را بیابید
نوع گزارش را انتخاب کنید
برای اندازه‌گیری مؤثر عملکرد کمپین تبلیغاتی با سطوح مختلف جزئیات و حریم خصوصی، API گزارش Attribution دو نوع گزارش مجزا ارائه می‌کند:
گزارش‌های سطح رویداد: داده‌های ریز ارائه می‌کند که یک کلیک یا مشاهده آگهی خاص ( منبع ) را با داده‌های تبدیل مربوطه ( محرک ) پیوند می‌دهد. گزارش‌های سطح رویداد، مقدار داده‌های تبدیل را محدود می‌کنند و به گزارش‌ها نویز اضافه می‌کنند. آنها برای موارد استفاده که در آن اسناد رویداد فردی کلیدی است، مانند اندازه گیری میزان دسترسی کمپین، ایده آل هستند.
گزارش‌های خلاصه: داده‌های کاربر جمع‌آوری شده را ارائه می‌دهد و می‌تواند شامل اطلاعات تبدیل دقیق‌تر با نویز اضافه شود. با استفاده از API گزارش اسناد و API جمع‌آوری خصوصی، آنها از گزارش‌های انبوه ساخته شده‌اند و مدل داده‌ای غنی‌تر از گزارش‌های سطح رویداد ارائه می‌دهند. گزارش‌های خلاصه مخصوصاً برای سناریوهایی که نیاز به بینش انبوه دارند، مانند محاسبه مقادیر تبدیل یا تجزیه و تحلیل عملکرد کمپین در بخش‌های کاربر، مفید هستند.
مروری بر پیاده سازی
بخش های زیر مراحل سطح بالا برای تولید هر نوع گزارش را تشریح می کند. همچنین می‌توانید نسخه ی نمایشی API Reporting Attribution را برای بررسی گام به گام کل فرآیند دنبال کنید.
پیش نیاز: قبل از اینکه بتوانید منابع، راه‌اندازها و دریافت گزارش‌ها را ثبت کنید، سایت‌های شما باید گواهی‌های SSL/TLS (HTTPS) داشته باشند.
تولید گزارش در سطح رویداد
مراحل زیر نحوه تولید گزارش‌های سطح رویداد را شرح می‌دهد:
ثبت منبع: کلیک یا مشاهده آگهی را با اطلاعات انتساب مرتبط می کند. برای دستورالعمل های دقیق ، به ثبت منابع انتساب و ثبت منبع منبع مراجعه کنید. توجه داشته باشید که روند ثبت نام برای کلیک ها و بازدیدها کمی متفاوت است.
ثبت یک ماشه: یک رویداد تبدیل را ثبت می کند و آن را به منبعی که قبلا ثبت شده پیوند می دهد. برای دستورالعمل ها به ثبت محرک های انتساب مراجعه کنید.
تنظیم یک نقطه پایانی گزارش: یک نقطه پایانی در سرور خود ایجاد کنید تا گزارش‌های سطح رویداد را دریافت کنید. URL نقطه پایانی باید از این قالب پیروی کند:
{REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-event-attribution. برای نمونه ای از متدPOST، کد مثال را درadtech.jsببینید. برای اطلاعات بیشتر در مورد.well-knownبه ویکی پدیا مراجعه کنید.
برای بررسی عمیق‌تر گزارش‌های سطح رویداد، به توضیح گزارش در سطح رویداد مراجعه کنید.
تولید گزارش خلاصه
ثبت منبع: مانند گزارش‌های سطح رویداد. برای جزئیات بیشتر به ثبت منابع ارجاع و ثبت منبع منبع مراجعه کنید.
ثبت یک ماشه: مانند گزارش‌های سطح رویداد. رجوع کنید به ثبت محرک های انتساب .
تنظیم یک نقطه پایانی گزارش: یک نقطه پایانی برای دریافت گزارش های انبوه ایجاد کنید. URL باید این باشد:
{REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-aggregate-attribution. برای مثال روشPOSTبهadtech.jsو برای اطلاعات.well-knownویکی‌پدیا مراجعه کنید.گزارش‌های دسته‌ای و ارسال: گزارش‌های انبوه را دسته‌بندی کرده و برای پردازش به سرویس تجمیع ارسال کنید. سپس سرویس تجمیع گزارش‌های خلاصه تولید می‌کند. برای اطلاعات بیشتر به استراتژی های دسته بندی مراجعه کنید.
برای بررسی عمیق‌تر گزارش‌های خلاصه، به توضیح گزارش جمع‌آوری مراجعه کنید.
علاوه بر مراحل پیاده سازی، موضوعات زیر به شما در برنامه ریزی استراتژی گزارش خلاصه کمک می کند:
تنظیم فیلترها (اختیاری)
برای به دست آوردن کنترل دقیق‌تر بر داده‌های انتساب دریافتی، می‌توانید فیلترها را تنظیم کنید.
فیلتر کردن تجزیه و تحلیل داده های تصفیه شده را ارائه می دهد که زیر مجموعه های خاصی از داده ها را برای تجزیه و تحلیل شما جدا می کند و نویز را کاهش می دهد. همچنین به ردیابی عملکرد کمپین های تبلیغاتی خاص و رویدادهای تبدیل برای اندازه گیری دقیق تر کمک می کند.
برای راه‌اندازی فیلتر کردن، به تعریف قوانین سفارشی با استفاده از فیلترها و بخش محرک‌های ثبت نام آغازگر Attribution مراجعه کنید تا جزئیات مربوط به گزارش‌های انباشته‌سازی شوند.
تأیید کنید که API فعال است
قبل از استفاده از API، با استفاده از کد زیر بررسی کنید که آیا فعال است یا خیر:
if (document.featurePolicy.allowsFeature('attribution-reporting')) {
// the Attribution Reporting API is enabled
}
این بررسی نشان می دهد که آیا API در شرایط فعلی مجاز است یا خیر. با این حال، تنظیمات مرورگر کاربر یا سایر عوامل ممکن است همچنان از استفاده از API جلوگیری کند. با توجه به ملاحظات حفظ حریم خصوصی، هیچ روش برنامه‌ای برای تأیید قطعی قابلیت استفاده API وجود ندارد.
مراحل بعدی
بخش‌های زیر اطلاعات بیشتری درباره شروع گزارش‌دهی اسناد ارائه می‌دهند.