با گزارش اسناد شروع کنید

این راهنما، مروری کلی و دستورالعمل‌های راه‌اندازی برای گزارش‌های انتساب در سطح رویداد و گزارش‌های انتساب خلاصه با استفاده از API گزارش‌دهی انتساب ارائه می‌دهد.

برای شروع، یاد خواهید گرفت که:

  • تفاوت بین انواع گزارش‌های API گزارش‌دهی انتسابی

  • مراحل پیاده‌سازی کامل API و تولید گزارش

  • اطلاعات مرجع و عیب‌یابی را پیدا کنید

نوع گزارش را انتخاب کنید

برای سنجش مؤثر عملکرد کمپین‌های تبلیغاتی با سطوح مختلف جزئیات و حریم خصوصی، API گزارش‌دهی انتساب دو نوع گزارش مجزا ارائه می‌دهد:

  • گزارش‌های سطح رویداد: داده‌های جزئی‌تری ارائه می‌دهند که یک کلیک یا مشاهده تبلیغ خاص ( منبع ) را با داده‌های تبدیل مربوطه ( ماشه ) مرتبط می‌کند. گزارش‌های سطح رویداد، میزان داده‌های تبدیل را محدود کرده و به گزارش‌ها نویز اضافه می‌کنند. آن‌ها برای مواردی که انتساب رویداد به صورت جداگانه کلیدی است، مانند اندازه‌گیری میزان دسترسی به کمپین، ایده‌آل هستند.

  • گزارش‌های خلاصه: داده‌های کاربر را به صورت تجمیع‌شده ارائه می‌دهند و می‌توانند شامل اطلاعات تبدیل دقیق‌تر با نویز اضافه باشند. با استفاده از API گزارش‌دهی نسبت‌دهی و API تجمیع خصوصی، این گزارش‌ها از گزارش‌های تجمیع‌شده ساخته می‌شوند و مدل داده غنی‌تری نسبت به گزارش‌های سطح رویداد ارائه می‌دهند. گزارش‌های خلاصه به ویژه برای سناریوهایی که نیاز به بینش‌های تجمیع‌شده دارند، مانند محاسبه مقادیر تبدیل یا تجزیه و تحلیل عملکرد کمپین در بخش‌های مختلف کاربران، مفید هستند.

مرور کلی پیاده‌سازی

بخش‌های زیر مراحل سطح بالای تولید هر نوع گزارش را شرح می‌دهند. همچنین می‌توانید برای مشاهده‌ی گام به گام کل فرآیند، نسخه آزمایشی API گزارش‌دهی نسبت‌دهی (Attribution Reporting API Demo) را دنبال کنید.

پیش‌نیاز: قبل از اینکه بتوانید منابع، تریگرها و گزارش‌ها را ثبت کنید، سایت‌های شما باید دارای گواهینامه‌های SSL/TLS (HTTPS) باشند.

تولید گزارش در سطح رویداد

مراحل زیر نحوه تولید گزارش‌های سطح رویداد را شرح می‌دهد:

  1. ثبت منبع: کلیک یا مشاهده تبلیغ را با اطلاعات انتساب مرتبط می‌کند. برای دستورالعمل‌های دقیق به ثبت منابع انتساب و ثبت منبع انتساب مراجعه کنید. توجه داشته باشید که فرآیند ثبت برای کلیک‌ها و بازدیدها کمی متفاوت است.

  2. ثبت یک محرک: یک رویداد تبدیل را ثبت می‌کند و آن را به یک منبع ثبت‌شده قبلی پیوند می‌دهد. برای دستورالعمل‌ها به ثبت محرک‌های انتساب مراجعه کنید.

  3. راه‌اندازی یک نقطه پایانی گزارش‌دهی: یک نقطه پایانی روی سرور خود ایجاد کنید تا گزارش‌های سطح رویداد را دریافت کند. آدرس اینترنتی نقطه پایانی باید از این قالب پیروی کند: {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-event-attribution . برای مثالی از روش POST ، به کد نمونه در adtech.js مراجعه کنید. برای اطلاعات بیشتر در مورد .well-known ، به ویکی‌پدیا مراجعه کنید.

برای بررسی عمیق‌تر گزارش‌های سطح رویداد، به توضیح گزارش سطح رویداد مراجعه کنید.

تولید گزارش خلاصه

  1. ثبت منبع: مشابه گزارش‌های سطح رویداد. برای جزئیات بیشتر به ثبت منابع انتساب و ثبت منبع انتساب مراجعه کنید.

  2. ثبت یک محرک: مشابه گزارش‌های سطح رویداد. به ثبت محرک‌های انتساب مراجعه کنید.

  3. تنظیم یک نقطه پایانی گزارش‌دهی: یک نقطه پایانی برای دریافت گزارش‌های کلی ایجاد کنید. آدرس اینترنتی باید به صورت زیر باشد: {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-aggregate-attribution . برای مثالی از متد POST به adtech.js و برای اطلاعات .well-known به ویکی‌پدیا مراجعه کنید.

  4. دسته بندی و ارسال گزارش‌ها: گزارش‌های تجمیعی را دسته بندی کرده و برای پردازش به سرویس تجمیع ارسال کنید. سپس سرویس تجمیع گزارش‌های خلاصه‌ای تولید می‌کند. برای اطلاعات بیشتر به «استراتژی‌های دسته بندی» مراجعه کنید.

برای بررسی عمیق‌تر گزارش‌های خلاصه، به توضیح گزارش Aggregatable مراجعه کنید.

علاوه بر مراحل پیاده‌سازی، مباحث زیر به شما در برنامه‌ریزی استراتژی گزارش خلاصه کمک خواهد کرد:

تنظیم فیلترها (اختیاری)

برای کنترل دقیق‌تر داده‌های انتسابی دریافتی، می‌توانید فیلترها را تنظیم کنید.

فیلتر کردن، تجزیه و تحلیل داده‌های اصلاح‌شده‌ای را ارائه می‌دهد که زیرمجموعه‌های خاصی از داده‌ها را برای تجزیه و تحلیل شما جدا می‌کند و نویز را کاهش می‌دهد. همچنین به ردیابی عملکرد کمپین‌های تبلیغاتی خاص و رویدادهای تبدیل برای اندازه‌گیری دقیق‌تر کمک می‌کند.

برای تنظیم فیلترینگ، به بخش تعریف قوانین سفارشی با استفاده از فیلترها و محرک‌ها در ثبت محرک Attribution مراجعه کنید تا جزئیات مربوط به گزارش‌های تجمیعی را مشاهده کنید.

تأیید کنید که API فعال شده است

قبل از استفاده از API، با استفاده از کد زیر بررسی کنید که آیا فعال است یا خیر:

if (document.featurePolicy.allowsFeature('attribution-reporting')) {
  // the Attribution Reporting API is enabled
}

این بررسی نشان می‌دهد که آیا API در شرایط فعلی مجاز است یا خیر. با این حال، تنظیمات مرورگر کاربر یا عوامل دیگر ممکن است همچنان مانع از استفاده از API شوند. به دلیل ملاحظات حریم خصوصی، هیچ روش برنامه‌نویسی برای تأیید قطعی قابلیت استفاده API وجود ندارد.

مراحل بعدی

بخش‌های بعدی اطلاعات بیشتری در مورد شروع گزارش‌دهی انتسابی ارائه می‌دهند.

پیاده‌سازی

پیشینه و مفاهیم

نسخه‌های نمایشی و ابزارها

برنامه‌ریزی