راهنمای پیاده‌سازی API Cross Web and App

Attribution Reporting API انتساب بین برنامه‌ها و وب را برای منابع و راه‌اندازهایی که در یک دستگاه رخ می‌دهند فعال می‌کند. مرورگرهایی مانند Chrome می‌توانند به جای مدیریت آن ثبت‌ها در مرورگر، هم منبع و هم ثبت‌ها را به API گزارش Attribution برای Android واگذار کنند. این به Android اجازه می‌دهد منابع و محرک‌ها را در هر دو سایت و برنامه‌ها مطابقت دهد.

این راهنما به شما یاد می‌دهد که چگونه می‌توانید برنامه‌های متقابل و اسناد وب را تنظیم کنید.

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

منابع و راه‌اندازها را با سیستم‌عامل Android ثبت کنید

انتساب بین برنامه و وب تنها در صورتی در دسترس خواهد بود که API گزارش اسناد در مرورگر و سیستم عامل Android در یک دستگاه فعال باشد. در دسترس بودن Android Attribution Reporting API از طریق سرصفحه Attribution-Reporting-Support ارسال می شود. این هدر سیستم عامل، وب یا هر دو را برمی‌گرداند، بسته به آنچه در آن دستگاه موجود است. اگر هر دو در دسترس باشند، فناوری های تبلیغاتی این انتخاب را خواهند داشت که منابع وب و محرک های وب را با مرورگر یا سیستم عامل ثبت کنند.

فناوری تبلیغات باید تصمیم بگیرد که آیا منبع وب یا راه‌انداز وب را با مرورگر یا سیستم عامل ثبت کند.

• برای کمپین‌های فقط وب، فن‌آوران تبلیغات همچنان می‌توانند هم منابع و هم محرک‌ها را با API گزارش Attribution Chrome ثبت کنند یا هر دو را به سیستم عامل واگذار کنند. برای کمپین‌های فقط وب که منبع یا راه‌انداز ممکن است در WebView اتفاق بیفتد، متخصصان تبلیغات باید هم منبع و هم ثبت‌های راه‌انداز را به سیستم عامل واگذار کنند. برای اطلاعات بیشتر به بخش WebViews مراجعه کنید.
• فن‌آوران تبلیغات باید از ثبت منابع و راه‌اندازها با APIهای Chrome و Android به‌طور همزمان خودداری کنند تا از ایجاد گزارش‌های اسناد تکراری جلوگیری کنند.
• انتساب به طور جداگانه برای مرورگرها و سیستم عامل انجام می شود. اگر منبعی با مرورگر ثبت شده باشد اما ماشه در سیستم عامل ثبت شده باشد، نمی توان آن دو را مطابقت داد و برعکس.
• برای منابعی که ممکن است به یک برنامه یا یک راه‌انداز وب منجر شوند، به فناوری تبلیغات بسیار توصیه می‌شود که منبع وب را واگذار کند و ثبت‌ها را به API گزارش Attribution Android ارائه دهد.
• برای محرک‌هایی که ممکن است توسط منابع مبتنی بر برنامه هدایت شده باشند، فناوری تبلیغات می‌تواند ثبت‌نام راه‌انداز وب را به API گزارش Attribution Android واگذار کند.
• برای کمپین‌هایی که هم منبع و هم راه‌انداز در یک برنامه اتفاق می‌افتند، هر دو باید با API گزارش انتساب سیستم عامل ثبت شوند.

منبع برنامه و راه‌انداز وب را ثبت کنید

برای برخی از کمپین‌ها، منبع ممکن است در یک برنامه رخ دهد در حالی که راه‌انداز در یک وب‌سایت در مرورگر تلفن همراه در همان دستگاه رخ می‌دهد.

مثال

کاربر در حال خواندن مقالات در برنامه خبری مورد علاقه خود است. آنها آگهی پروازهای ارزان پاریس را می بینند و با هیجان برای رزرو کلیک می کنند. فناوری تبلیغاتی که تبلیغ را در برنامه اخبار ارائه می‌کند، منبع کلیک را با API گزارش اسناد Android ثبت می‌کند. کاربر به صفحه وب تبلیغ‌کننده در کروم هدایت می‌شود، جایی که می‌تواند تبدیل کند. فناوری تبلیغات در سایت آگهی‌دهنده بررسی می‌کند که آیا API سطح سیستم‌عامل موجود است یا خیر، و در دسترس است. فناوری تبلیغات با دستور Chrome برای واگذاری ثبت به سیستم عامل به جای ثبت مستقیم آن با API گزارش Attribution Chrome، محرک تبدیل را ثبت می کند. سپس API Attribution Reporting سطح سیستم عامل می‌تواند منبع برنامه و راه‌انداز وب را مطابقت دهد و گزارش‌های مربوطه را ارسال کند.

جریان اسناد برنامه به وب

ثبت منبع برنامه:

1. SDK فناوری تبلیغات در برنامه اندروید روزانه اخبار کلیک را با استفاده از registerSource() ثبت می‌کند.

2. Attribution Reporting API در Android درخواستی را به URL سرور فناوری تبلیغات ارائه شده به registerSource() ارسال می کند.

3. سرور فناوری تبلیغات با عنوان Attribution-Reporting-Register-Source برای تکمیل ثبت منبع پاسخ می دهد.

ثبت تریگر وب:

1. فناوری تبلیغات یک راه‌انداز را ثبت می‌کند و در دسترس بودن سیستم عامل را در Attribution Reporting API بررسی می‌کند

2. وب ARA اطلاعاتی در مورد اینکه کدام پلتفرم پشتیبانی می شود را برمی گرداند

3. هدر OS-Trigger به وب ARA API می گوید که تابع registerWebTrigger() OS ARA API را فراخوانی کند.

4. فراخوانی registerWebTrigger() در زیر سرپوش انجام می شود و توسعه دهنده نیازی به فراخوانی registerWebTrigger() مستقیماً با سیستم عامل ندارد.

5. OS ARA کنترل می شود و درخواستی را به URL سرور فناوری تبلیغات ارائه شده توسط سرصفحه Attribution-Reporting-Register-OS-Trigger ارسال می کند.

6. فناوری تبلیغات ثبت ماشه را با API سیستم عامل تکمیل می کند

7. OS ARA انتساب را بر اساس همان منطق اعمال شده به app<>App انتساب انجام می دهد و همان گزارش ها را ارسال می کند.

گردش کار

مراحل زیر شامل جزئیات بیشتر در مورد نحوه تکمیل کار است:

1. فناوری تبلیغات از برنامه، منبعی را با API گزارش Attribution Android با تنظیمات زیر ثبت می‌کند:

   • برای ثبت منبع برنامه‌ای که انتظار می‌رود در یک وب‌سایت تبدیل شود، سرصفحه پاسخ Attribution-Reporting-Register-Source باید یک مقصد وب (eTLD+1) به جای مقصد برنامه داشته باشد.

   Attribution-Reporting-Register-Source: {
       "web_destination": "https://advertiser.example",
       ...
   }
   

   توجه: برای کمپین هایی که ممکن است در یک مقصد وب یا یک برنامه تبدیل شوند، به بخش مقصدهای دوگانه مراجعه کنید
   • برخی از تبلیغ‌کنندگان ممکن است از چندین ارائه‌دهنده اندازه‌گیری (به عنوان مثال، یک ابزار اندازه‌گیری شخص ثالث یا یک ابزار تحلیلی) با استفاده از زنجیره تغییر مسیر 302 استفاده کنند. در برخی موارد، Attribution Reporting API مسیر تغییر مسیر مشخص شده در هدر Attribution-Reporting-Redirect را در پس‌زمینه دنبال می‌کند و در همان زمان مسیر تغییر مسیر 302 در پیش‌زمینه برای درخواست‌های ناوبری موجود اجرا می‌شود. این درخواست‌ها به همان URL می‌روند و می‌توانند منجر به ثبت‌های شمارش مضاعف توسط ارائه‌دهنده اندازه‌گیری شخص ثالث شوند. برای جلوگیری از ثبت‌های مضاعف شمارش، متخصصان تبلیغات می‌توانند رفتار تغییر مسیر را تغییر دهند تا ثبت API گزارش Attribution را به یک URL جایگزین و در عین حال قطعی ارسال کنند.

   • برای فعال کردن این رفتار، فن‌آوران تبلیغات باید هنگام پاسخ به درخواست ثبت، سربرگ HTTP جدیدی اضافه کنند:

     • سرصفحه Attribution-Reporting-Redirect-Config است
     • مقدار هدر باید redirect-302-to-well-known باشد

     Attribution-Reporting-Redirect-Config: redirect-302-to-well-known
     

     توجه: همه تغییر مسیرهای بعدی که این سربرگ را دنبال می کنند دارای .well-known به ابتدای مسیر URI تغییر مسیر خواهند بود.

   • بقیه مراحل ثبت منبع مانند ثبت استاندارد منبع برنامه به برنامه است.

   توجه: اگر شما یا برنامه انتشاراتی از webview برای نمایش یک آگهی بومی در یک برنامه Android استفاده می‌کنید، به بخش مشاهده وب مراجعه کنید.

2. فناوری تبلیغات در وب‌سایت تبلیغ‌کننده با درخواست از Chrome برای واگذاری ثبت‌نام به Android Attribution Reporting API، محرک را ثبت می‌کند:

   • هنگامی که کاربر یک تبدیل را در یک وب‌سایت تکمیل کرد، فناوری تبلیغات درخواستی برای ثبت راه‌انداز در Chrome ارائه می‌کند.

     1. یک درخواست پیکسل یا fetch() می تواند برای درخواست ثبت یک تریگر استفاده شود

     2. هدر درخواست Attribution-Reporting-Support توسط Chrome به فناوری تبلیغات بازگردانده می‌شود. اگر API هم در مرورگر کروم و هم در دستگاه Android فعال باشد، هدر سیستم عامل os, web برمی‌گرداند

     Attribution-Reporting-Support: os, web
     

   • سپس، فناوری تبلیغات باید به Chrome بگوید که با استفاده از سرصفحه Attribution-Reporting-Register-OS-Trigger به سیستم عامل واگذار کند که:

     1. به Chrome می‌گوید ثبت‌نام را به سیستم عامل محول کند

     2. کروم با فراخوانی تابع OS API registerWebTrigger() ثبت نام را به سیستم عامل واگذار می کند.

        • فراخوانی برای registerWebTrigger() در زیر سرپوش انجام می شود، فناوری تبلیغات نیازی به فراخوانی مستقیم registerWebTrigger() ندارد.

     3. OS API یک فراخوانی API ثانویه را با URI فناوری تبلیغاتی که از مرورگر ارسال می‌شود، آغاز می‌کند

     Attribution-Reporting-Register-OS-Trigger: "https://adtech.example/register-trigger",
     "https://other-adtech.example/register-trigger"
     

   • در برخی موارد سرصفحه Attribution-Reporting-Support در دسترس نیست و قابل ارسال نیست. وقتی این اتفاق می‌افتد، فناوری تبلیغات همچنان می‌تواند یک پلتفرم ترجیحی برای مدیریت ثبت راه‌انداز با گنجاندن سرصفحه Attribution-Reporting-Info تنظیم کند. کلید ترجیحی-پلتفرم است و مقادیر مجاز os و web هستند. مرورگر در صورت در دسترس بودن از پلتفرم ترجیحی استفاده می کند و زمانی که سیستم عامل در دسترس نباشد به پلتفرم وب برمی گردد.

   توجه: هم هدر Attribution-Reporting-Register-Trigger حاوی اطلاعات ثبت وب و هم هدر Attribution-Reporting-Register-OS-Trigger حاوی اطلاعات ثبت سیستم عامل باید هنگام تعیین پلت فرم ترجیحی بازگردانده شوند تا اطمینان حاصل شود که ثبت پلت فرم صحیح می تواند انجام شود. محل هر دو سیستم عامل و ثبت نام وب باید ارائه شوند تا در صورت در دسترس نبودن پلتفرم ترجیحی، اطلاعات مورد نیاز برای روش بازگشتی وجود داشته باشد.

   Attribution-Reporting-Info: preferred-platform=os
   

   • برای تکمیل ثبت راه‌انداز، نقطه پایانی فناوری تبلیغات باید با استفاده از سرصفحه پاسخ، به درخواست API گزارش اسناد Android پاسخ دهد.

   Attribution-Reporting-Register-Trigger: {
       "event_trigger_data": [{"trigger_data":"1"}],
       "aggregatable_trigger_data": [
           {"key_piece":"0x400","source_keys":["campaignCounts"]},
           {"key_piece":"0xA80","source_keys":["geoValue"]}
       ],
       ...
   }
   

   • باقیمانده ثبت ماشه ثابت می ماند.

یک منبع وب و یک راه‌انداز برنامه ثبت کنید

برای برخی از کمپین‌ها، ممکن است منبعی در یک سایت در مرورگر تلفن همراه رخ دهد در حالی که راه‌اندازی در برنامه‌ای در همان دستگاه رخ می‌دهد.

مثال

کاربر در حال مرور سایتی در مرورگر کروم خود در تلفن اندرویدی خود است. آنها تبلیغ یک ژاکت را از یکی از فروشگاه های مورد علاقه خود می بینند. آنها روی تبلیغ کلیک می کنند و به برنامه ای که قبلاً دانلود کرده اند منتقل می شوند. فناوری تبلیغات در وب‌سایتی که تبلیغ در آن ارائه شده است، منبع کلیک را با دستور به Chrome برای واگذاری ثبت به Android Attribution Reporting API به جای استفاده از Attribution Reporting API در Chrome، ثبت می‌کند. کاربر ژاکت را در اپلیکیشن خرید خریداری می کند. سپس فناوری تبلیغات در برنامه تبلیغ‌کننده، محرک تبدیل را با API گزارش Attribution Android ثبت می‌کند. API گزارش Attribution در سطح سیستم عامل می‌تواند با منبع وب و راه‌انداز برنامه مطابقت داشته باشد و گزارش‌های مربوطه را ارسال کند.

جریان اسناد وب به برنامه

ثبت منبع وب:

1. فناوری تبلیغات یک منبع را ثبت می کند و در دسترس بودن سیستم عامل را در API گزارش Attribution بررسی می کند

2. وب ARA اطلاعاتی در مورد اینکه کدام پلتفرم پشتیبانی می شود را برمی گرداند

3. هدر OS-Source به وب ARA API می گوید که تابع OS ARA registerWebSource() را فراخوانی کند.

4. فراخوانی برای registerWebSource() در زیر سرپوش انجام می شود و توسعه دهنده نیازی به فراخوانی registerWebSource() مستقیماً با سیستم عامل ندارد.

5. OS ARA کنترل می‌شود و درخواستی را به URL سرور فناوری تبلیغات ارائه شده توسط سرصفحه Attribution-Reporting-Register-OS-Source ارسال می‌کند.

6. فناوری تبلیغات ثبت منبع را با API سیستم عامل تکمیل می کند

ثبت تریگر برنامه:

1. SDK فناوری تبلیغات در برنامه Android Store Clothing، ماشه را با OS ARA ثبت می‌کند

2. Attribution Reporting API در Android درخواستی را به URL سرور فناوری تبلیغات ارائه شده برای registerTrigger() ارسال می کند.

3. سرور فناوری تبلیغات با سرصفحه Attribution-Reporting-Register-Trigger پاسخ می دهد تا ثبت ماشه را تکمیل کند.

4. OS ARA انتساب را بر اساس همان منطق اعمال شده به app<>App انتساب انجام می دهد و همان گزارش ها را ارسال می کند.

گردش کار

مراحل زیر شامل جزئیات بیشتر در مورد نحوه تکمیل کار است:

1. فناوری تبلیغات در وب‌سایت ناشر، منبع را با دستور دادن به Chrome برای واگذاری ثبت به Android Attribution Reporting API ثبت می‌کند:

   • برای استفاده از وب به برنامه، هنگام ثبت منبع، پارامتر منبع انتساب باید مستقیماً با استفاده از تگ attributionsrc یا با استفاده از ثبت جاوا اسکریپت مشخص شود.
   • مثال زیر از تگ attributionsrc برای تعیین پارامتر منبع استفاده می کند:

   <img src="https://adtech.example/conversionpixel"
   attributionsrc="https://adtech.example/register-source?purchase=12">
   

2. هدر درخواست Attribution-Reporting-Support توسط Chrome به فناوری تبلیغات بازگردانده می‌شود. اگر API هم در مرورگر Chrome و هم در دستگاه Android فعال باشد، هدر سیستم عامل os, web برمی‌گرداند.

   Attribution-Reporting-Support: os, web
   

   توجه: API Reporting Attribution باید در سیستم عامل Android فعال باشد تا با موفقیت در برنامه و وب اندازه‌گیری شود.

3. فناوری تبلیغات باید به Chrome بگوید که با استفاده از سرصفحه Attribution-Reporting-Register-OS-Source به API سطح سیستم عامل واگذار کند که:

   1. به Chrome می‌گوید ثبت‌نام را به سیستم عامل محول کند
   2. کروم با فراخوانی تابع OS API registerWebSource() ثبت نام را به سیستم عامل واگذار می کند.
   3. فراخوانی برای registerWebSource() در زیر سرپوش انجام می شود، فناوری تبلیغات نیازی به فراخوانی مستقیم registerWebSource() ندارد.
   4. OS API یک فراخوانی API ثانویه را با URI فناوری تبلیغاتی که از مرورگر ارسال می‌شود، آغاز می‌کند

   Attribution-Reporting-Register-OS-Source: "https://adtech.example/register-source"
   

   • در برخی موارد سرصفحه Attribution-Reporting-Support در دسترس نیست. وقتی این اتفاق می‌افتد، فناوری تبلیغات همچنان می‌تواند یک پلتفرم ترجیحی برای مدیریت ثبت منبع با گنجاندن سرصفحه Attribution-Reporting-Info تنظیم کند. کلید ترجیحی-پلتفرم است و مقادیر مجاز os و web هستند. مرورگر در صورت موجود بودن از پلتفرم ترجیحی استفاده می کند و زمانی که سیستم عامل در دسترس نباشد به پلتفرم وب باز می گردد.
   توجه: هم سرصفحه Attribution-Reporting-Register-Source حاوی اطلاعات ثبت وب و هم سرصفحه Attribution-Reporting-Register-OS-Source حاوی اطلاعات ثبت سیستم عامل باید هنگام تعیین پلت فرم ترجیحی بازگردانده شوند تا اطمینان حاصل شود که ثبت پلت فرم صحیح می تواند انجام شود. محل هر دو سیستم عامل و ثبت نام وب باید ارائه شوند تا در صورت در دسترس نبودن پلتفرم ترجیحی، اطلاعات مورد نیاز برای روش بازگشتی وجود داشته باشد.

   Attribution-Reporting-Info: preferred-platform=os
   

   • برای تکمیل ثبت منبع، نقطه پایانی فناوری تبلیغات باید با سرصفحه پاسخ Attribution-Reporting-Register-Source به درخواست Android Attribution Reporting API پاسخ دهد. پاسخ همچنین باید مقصد برنامه را در قسمت مقصد مشخص کند.

   Attribution-Reporting-Register-Source: {
       "source_event_id":"123001",
       "destination":"android-app://com.example.advertiser",
       ...
   }
   

   • برای پشتیبانی از تغییرمسیر برای ثبت منبع، Chrome از تغییرمسیرها پیروی می کند و برای هر پرش تغییر مسیر ، APIهای زمینه وب را فراخوانی می کند.
   • باقی مانده ثبت منبع ثابت باقی می ماند.

4. فناوری تبلیغات در برنامه تبلیغ‌کننده، راه‌اندازی را با API گزارش Attribution Android ثبت می‌کند:

   • برای محرک‌هایی که در برنامه‌ها اتفاق می‌افتند، برنامه‌ها به‌طور معمول محرک‌ها را با Android Attribution Reporting API ثبت می‌کنند .

کمپین هایی که هم مقصد برنامه و هم وب دارند

1. مقصدهای دوگانه را تنظیم کنید

   • برخی از کمپین‌ها ممکن است برای تبدیل در برنامه تبلیغ‌کننده یا در صفحه وب آگهی‌دهنده، بسته به عوامل مختلفی از قبیل نصب برنامه توسط کاربر تنظیم شوند.
   • در این موارد، توصیه می‌شود که ثبت منبع را در صورت وجود به سیستم عامل واگذار کنید تا منبع را بتوان به درستی بدون توجه به محل وقوع ماشه نسبت داد. هنگام ثبت منبع در سیستم عامل، هم یک برنامه و هم مقصد وب را می توان در پارامترهای مربوطه مشخص کرد.
   • مقصد برنامه باید در قسمت destination باشد
   • مقصد وب باید در قسمت web_destination باشد
   • توسعه دهندگان Chrome باید توجه داشته باشند که فیلد destination برای API گزارش Attribution OS باید یک بسته برنامه باشد و نه یک URL.

   Attribution-Reporting-Register-Source: {
       "source_event_id":"123001",
       "destination":"android-app://com.example.advertiser",
       "web_destination": "https://example.advertiser"
       ...
   }
   

   • بخش بعدی در مورد گزارش‌دهی درشت توضیح می‌دهد که چگونه استفاده از مقصدهای دوگانه ممکن است بر نویز گزارش‌های شما تأثیر بگذارد.

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

   • اگر هر دو سیستم عامل (برنامه) و مقصد وب در ثبت منبع مشخص شده باشند، گزارش‌های سطح رویداد مشخص می‌کنند که آیا راه‌اندازی به طور پیش‌فرض در یک مقصد وب یا مقصد برنامه اتفاق افتاده است. با این حال، برای حفظ محدودیت های حریم خصوصی، نویز اضافی به این گزارش ها اضافه می شود.
   • فن‌آوران تبلیغات می‌توانند از قسمت coarse_event_report_destinations در زیر عنوان Attribution-Reporting-Register-Source برای روشن کردن گزارش‌های درشت و کاهش نویز استفاده کنند. اگر منبعی با فیلد coarse_event_report_destinations مشخص شده، انتساب را به دست آورد، گزارش حاصل، هم مقصد برنامه و هم وب را بدون تمایز در مورد محل وقوع واقعی، اما با نویز کمتری نسبت به گزارش‌هایی که برنامه یا مقصد وب مشخص شده است، شامل می‌شود.
   • گزارش های انبوه بدون تغییر باقی می مانند.

برای برنامه‌هایی که از برگه‌های سفارشی Chrome استفاده می‌کنند

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

1. یک منبع برنامه و راه‌انداز برگه سفارشی را ثبت کنید:
   • برای ثبت منبع برنامه و راه‌انداز وب، دستورالعمل‌ها را دنبال کنید.
2. ثبت منبع برگه سفارشی و راه‌انداز برنامه:
   • دستورالعمل‌ها را برای ثبت منبع وب و راه‌انداز برنامه دنبال کنید.
3. منبع CCT و ماشه CCT را ثبت کنید
   • این مورد مانند هر منبع وب سایت به سایت در Chrome رفتار می شود.

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

برخی از برنامه ها ممکن است از WebView برای نمایش محتوا استفاده کنند. موارد استفاده مختلفی برای WebView وجود دارد، مانند رندر تبلیغات، میزبانی محتوای وب یا ویژگی های برنامه سفارشی که برای قالب وب مناسب تر است.

1. فقط اسناد سطح سیستم عامل در WebView موجود است. سرصفحه Attribution-Reporting-Support فقط سیستم عامل را برمی‌گرداند و تنها در صورتی که API گزارش انتساب Android در دسترس باشد.

   توجه: برای انجام انتساب در Chrome و WebView، ثبت منبع و راه‌انداز در Chrome باید به سیستم عامل محول شود زیرا فقط انتساب مبتنی بر سیستم عامل برای WebView پشتیبانی می‌شود.

2. هنگام تفویض اختیار به سیستم عامل، WebView ممکن است از registerSource یا registerWebSource و registerTrigger یا registerWebTrigger استفاده کند. اینکه کدام روش‌ها توسط WebView استفاده می‌شوند توسط برنامه ارائه‌دهنده WebView تنظیم می‌شود و بر اساس هر WebView تعیین می‌شود.

   • تفاوت بین registerSource و registerWebSource در این است که کدام منبع به عنوان ناشر ثبت می شود. با registerSource ، برنامه به عنوان ناشر ثبت می شود. نمونه ای از زمان استفاده از registerSource یک برنامه ناشر است که تبلیغی را نشان می دهد که با استفاده از WebView ارائه شده است. با registerWebSource ، وب سایت میزبانی شده در WebView به عنوان ناشر ثبت می شود. یک مثال از زمان استفاده از registerWebSource برنامه‌ای است که میزبان یک WebView است و وب‌سایتی که توسط WebView ارائه می‌شود، تبلیغات را نشان می‌دهد. registerTrigger و registerWebTrigger رفتار مشابهی دارند. نمودار در مورد شماره 3 سناریوهای مختلفی را برای زمانی که یک برنامه‌نویس یا توسعه‌دهنده SDK می‌خواهد API را برای استفاده از registerSource یا registerWebSource ، و registerTrigger یا registerWebTrigger پیکربندی کند، توضیح می‌دهد.

3. به‌طور پیش‌فرض، WebView از registerSource و registerWebTrigger هنگام فراخوانی Android Attribution Reporting API استفاده می‌کند. این منابع را با برنامه مرتبط می‌کند و هنگامی که راه‌انداز رخ می‌دهد، با مبدا سطح بالای URL در WebView فعال می‌شود.

   • اگر یک برنامه به رفتار متفاوتی نیاز دارد، باید از روش جدیدی setAttributionRegistrationBehavior در کلاس androidx.webkit.WebViewSettingsCompat استفاده کند. این متد مشخص می کند که آیا WebView باید registerWebSource() یا registerWebTrigger() را به جای registerSource() یا registerTrigger() فراخوانی کند.
     • این رفتار باید برای هر WebView که شروع می شود تنظیم شود.
     • اگر SDK فناوری تبلیغات، WebView را راه‌اندازی می‌کند، SDK باید این رفتار پیش‌فرض را تنظیم کند.
     • برای برنامه‌هایی که می‌خواهند registerWebSource() برای مرتبط کردن ثبت‌های منبع با وب‌سایت در WebView به جای برنامه استفاده کنند، باید به لیست مجاز WebApp بپیوندند. برای پیوستن به لیست مجاز ، این فرم را تکمیل کنید . هدف از لیست مجاز کاهش ملاحظات حفظ حریم خصوصی در مورد ایجاد اعتماد برای زمینه وب است.
   • گزینه هایی برای setAttributionRegistrationBehavior

   ارزش	توضیحات	مثال استفاده
   APP_SOURCE_AND_WEB_TRIGGER (پیش‌فرض)	به برنامه‌ها اجازه می‌دهد منابع برنامه (منابع مرتبط با نام بسته برنامه) و راه‌اندازهای وب (محرک‌های مرتبط با eTLD+1) را از WebView ثبت کنند.	برنامه هایی که از WebView برای ارائه تبلیغات به جای فعال کردن مرور وب استفاده می کنند
   WEB_SOURCE_AND_WEB_TRIGGER	به برنامه‌ها اجازه می‌دهد منابع وب و محرک‌های وب را از WebView ثبت کنند.	برنامه‌های مرورگر مبتنی بر WebView، جایی که نمایش‌ها و تبدیل‌های تبلیغاتی هر دو می‌توانند در وب‌سایت‌های WebView اتفاق بیفتند.
   APP_SOURCE_AND_APP_TRIGGER	به برنامه‌ها اجازه می‌دهد منابع برنامه و محرک‌های برنامه را از WebView ثبت کنند.	برنامه‌های مبتنی بر WebView که در آن‌ها نمایش‌ها و تبدیل‌های تبلیغاتی باید همیشه به‌جای eTLD+1 WebView با برنامه مرتبط باشد.
   از کار افتاده	ثبت منبع و راه‌اندازی را از WebView غیرفعال می‌کند.

4. منبع و راه اندازی ثبت نام از WebView

   • فن‌آوران تبلیغات باید با استفاده از سرصفحه Attribution-Reporting-Register-OS-Source به ثبت‌های منبع پاسخ دهند. بر اساس رفتار تنظیم‌شده برای WebView، این یا registerSource() یا registerWebSource() با سیستم عامل فراخوانی می‌شود و یک تماس API ثانویه از API گزارش Attribution Android به URI فناوری تبلیغات را آغاز می‌کند.

     • برای تکمیل ثبت منبع، نقطه پایانی فناوری تبلیغات باید با سرصفحه پاسخ به درخواست Android Attribution Reporting API پاسخ دهد.

     Attribution-Reporting-Register-OS-Source: {
         "source_event_id":"123001",
         "destination":"android-app://com.example.advertiser",
         ...
     }
     

   • باقی مانده ثبت منبع ثابت باقی می ماند.

5. فن‌آوران تبلیغات باید با استفاده از سرصفحه Attribution-Reporting-Register-OS-Trigger به ثبت‌های راه‌انداز پاسخ دهند. بر اساس رفتار تنظیم شده برای WebView، این یا registerTrigger() یا registerWebTrigger() را با سیستم عامل فراخوانی می کند و یک تماس API ثانویه از Rb به URI فناوری تبلیغات را آغاز می کند.

   • برای تکمیل ثبت راه‌انداز، نقطه پایانی فناوری تبلیغات باید به درخواست API گزارش اسناد Android با سرصفحه پاسخ پاسخ دهد.

   Attribution-Reporting-Register-OS-Trigger: {
       "event_trigger_data": [{"trigger_data":"1"}],
       "aggregatable_trigger_data": [
           {"key_piece":"0x400","source_keys":["campaignCounts"]},
           {"key_piece":"0xA80","source_keys":["geoValue"]}
       ],
       ...
   }
   

   • بقیه مراحل ثبت ماشه ثابت می ماند.

اشکال زدایی

هنگام راه‌اندازی یک برنامه در پیاده‌سازی وب، توصیه می‌شود گزارش‌های اشکال‌زدایی را تنظیم کنید تا بررسی کنید که آیا منابع و راه‌اندازها به درستی ثبت شده‌اند یا خیر، و اگر ثبت نشده‌اند، برای دریافت اطلاعات درباره دلیل آن.

برای مراحل کلی اشکال‌زدایی گزارش اسناد، به کتاب آشپزی رفع اشکال مراجعه کنید.