با استفاده از API مباحث، محیط خود را برای استفاده، آزمایش و توسعه برنامههای وب آماده کنید.
ساخت و آزمایش به صورت محلی
این بخش نحوه تنظیم محیط محلی شما را برای آزمایش API تاپیکها به عنوان یک توسعهدهنده شخصی شرح میدهد. توصیه میکنیم قبل از شروع پیادهسازی، نسخههای نمایشی را بررسی کنید تا با نحوه کار تاپیکها آشنا شوید.
فعال کردن موضوعات در مرورگر شما
برای فعال کردن API موضوعات در نمونه Chrome خود برای آزمایش محلی، دو گزینه دارید:
- تمام APIهای حریم خصوصی تبلیغات را در
chrome://settings/adPrivacyفعال کنید. - (توصیه میشود) کروم را از خط فرمان با پرچمهای کرومیوم و با استفاده از پارامترهای خاص API تاپیکها اجرا کنید تا در صورت نیاز پیکربندی شوند. با اجرای کروم از خط فرمان، کنترل دقیقتری بر ویژگیهای تاپیکها خواهید داشت. به عنوان مثال، میتوانید دورههای تاپیکها (بازه زمانی مورد استفاده توسط API برای محاسبه علایق کاربر) را تنظیم کرده و رفتار API را مطابق با نیازهای خود پیکربندی کنید.
توصیههای کلیدی
- قبل از شروع فرآیند جدید با استفاده از پرچمها، مطمئن شوید که تمام فرآیندهای کروم را بسته و متوقف کردهاید.
- مطمئن شوید که تمام APIهای حریم خصوصی تبلیغات در
chrome://settings/adPrivacyفعال شدهاند. - اگر API مطابق انتظار کار نکرد، نکات عیبیابی ما را امتحان کنید.
- اگر سوالی دارید، برای توضیحات بیشتر، بخش مشکلات گیتهاب را بررسی کنید.
کنترل API موضوعات با پرچمهای کروم
پرچمهای کروم میتوانند رفتار API موضوعات را تغییر دهند. کروم را از خط فرمان با پارامترهای مشخص شده برای تسهیل آزمایش اجرا کنید. به عنوان مثال، نسخه آزمایشی هدرها استفاده از پرچمهای زیر را توصیه میکند:
--enable-features=BrowsingTopics,BrowsingTopicsParameters:time_period_per_epoch/15s/max_epoch_introduction_delay/3s,PrivacySandboxAdsAPIsOverride,PrivacySandboxSettings3,OverridePrivacySandboxSettingsLocalTesting
جدول زیر هر پارامتر، مقدار پیشفرض آن و هدف آن را توضیح میدهد.
| نام پرچم | مقدار پیشفرض | توضیحات |
|---|---|---|
BrowsingTopics | فعال شده | آیا API موضوعات فعال است یا خیر. |
PrivacySandboxAdsAPIsOverride | فعال شده | APIهای تبلیغات را فعال میکند: گزارشدهی انتساب، مخاطب محافظتشده، موضوعات، قابهای محصور. |
PrivacySandboxSettings4 | معلول | چهارمین نسخه از تنظیمات رابط کاربری Privacy Sandbox را فعال میکند. |
OverridePrivacySandboxSettingsLocalTesting | فعال شده | در صورت فعال بودن، مرورگر دیگر نیازی به فعال کردن تنظیمات اساسی برای فعال کردن ویژگیهای Privacy Sandbox ندارد. |
BrowsingTopicsBypassIPIsPubliclyRoutableCheck | معلول | در صورت فعال بودن، بررسی اینکه آیا آدرس IP به صورت عمومی قابل مسیریابی است یا خیر، هنگام تعیین واجد شرایط بودن یک صفحه برای قرار گرفتن در محاسبه موضوعات، نادیده گرفته میشود. |
BrowsingTopics:number_of_epochs_to_expose | ۳ | تعداد دورهها (epochs) که از آنجا موضوعات محاسبه میشوند تا به یک زمینه درخواستکننده داده شوند. مرورگر به صورت داخلی تا N+1 دوره را نگه میدارد. |
BrowsingTopics:time_period_per_epoch | ۷ روز-۰ ساعت-۰ دقیقه-۰ ثانیه | مدت زمان هر دوره. برای اشکالزدایی، تنظیم این مدت زمان روی (مثلاً) ۱۵ ثانیه، به جای هفت روز پیشفرض، میتواند مفید باشد. |
BrowsingTopics:number_of_top_topics_per_epoch | ۵ | تعداد موضوعات محاسبه شده در هر دوره. |
BrowsingTopics:use_random_topic_probability_percent | ۵ | احتمال اینکه یک موضوع خاص در یک دوره، موضوعی باشد که به صورت تصادفی از کل طبقهبندی موضوعات برگردانده شده است. این تصادفی بودن به یک دوره و مکان وابسته است. |
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering | ۳ | چند دوره از دادههای استفاده از API (یعنی مشاهدات موضوعات) برای فیلتر کردن موضوعات برای یک زمینه فراخوانی استفاده خواهد شد. |
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic | ۱۰۰۰ | حداکثر تعداد دامنههای زمینهای مشاهدهشده برای هر موضوع برتر. هدف، محدود کردن حافظه در حال استفاده است. |
BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch | ۱۰۰۰۰۰ | حداکثر تعداد ورودیهای مجاز برای بازیابی از پایگاه داده برای هر پرسوجو برای زمینههای استفاده از API. پرسوجو یک بار در هر دوره در زمان محاسبه موضوعات رخ میدهد. هدف، محدود کردن حداکثر استفاده از حافظه است. |
BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load | ۳۰ | حداکثر تعداد دامنههای زمینه استفاده از API که مجاز به ذخیره در هر بار بارگذاری صفحه هستند. |
BrowsingTopics:config_version | ۱ | پارامترهای پیکربندی API موضوعات را رمزگذاری میکند. هر شماره نسخه فقط باید به یک مجموعه پیکربندی نگاشت شود. بهروزرسانی پارامترهای پیکربندی بدون بهروزرسانی config_version معمولاً برای آزمایش محلی خوب است، اما در برخی شرایط میتواند مرورگر را در حالت ناپایدار قرار دهد و منجر به خرابی مرورگر شود، برای مثال بهروزرسانی number_of_top_topics_per_epoch . |
BrowsingTopics:taxonomy_version | ۱ | نسخه طبقهبندی مورد استفاده توسط API. |
قبل از شروع پیادهسازی
قبل از شروع پیادهسازی، توصیه میکنیم این منابع را مرور کنید تا با API موضوعات آشنا شوید.
- بررسی اسناد توسعهدهنده:
- هدف API موضوعات و نقش آن در تبلیغات مبتنی بر علاقه را درک کنید
- درک کنید که موضوعات چگونه در وب کار میکنند .
- دموها را امتحان کنید و ویدیوی راهنمای دموها، همکاری و ابزارهای تاپیکز را تماشا کنید.
- نسخههای نمایشی را از سایت خودتان اجرا کنید.
- برای درک بیشتر جزئیات ، توضیح API را مطالعه کنید.
- نقش API را در پشتیبانی از مرتبط بودن تبلیغات در آینده، زمانی که کوکیهای شخص ثالث برای بخش فزایندهای از کاربران در دسترس نباشند، درک کنید.
- برای اطلاع از تغییرات وضعیت در API، به لیست پستی توسعهدهندگان بپیوندید و برای آخرین بهروزرسانیهای موضوعات با ما همراه باشید.
- در گفتگوهای مربوط به مسائل گیتهاب یا فراخوانهای W3C مشارکت کنید.
- اگر با اصطلاحات ناآشنایی مواجه شدید، واژهنامه Privacy Sandbox را مرور کنید.
- برای اطلاعات بیشتر در مورد مفاهیم کروم، مانند پرچمهای کروم، ویدیوهای کوتاه و مقالات موجود در goo.gle/cc را مرور کنید.
مراحل بعدی
موضوعات را پیاده سازی کنید
جزئیات پیاده سازی و نمونه کد را برای تماس گیرندگان برای مشاهده و دسترسی به موضوعات بررسی کنید.
تست و پخش زنده
نحوه استقرار، آزمایش و مقیاسبندی راهحلهای مبتنی بر موضوعات را بیاموزید.