پروتکل‌ها و داده‌های مرجع

فایل‌هایی را که از «پروتکل RTB» پشتیبانی می‌کنند مشاهده یا بارگیری کنید.

Protos

فایل شرح نسخه Last Updated
cookie-bulk-upload.proto از این پیام برای بارگذاری انبوه داده‌های هدف‌یابی کاربر استفاده کنید. v.25 ‫۲۷ مارس ۲۰۲۴
openrtb.proto Google از پروتکل OpenRTB بااستفاده از کدبندی JSON یا Protobuf پشتیبانی می‌کند. اگر از OpenRTB/Protobuf استفاده می‌کنید، این proto لازم است. همچنین شامل مستندات فیلدهای پشتیبانی‌شده و نگاشت آن‌ها به پروتکل بومی Google است. ‫۲.۶ ‫۱۵ اکتبر ۲۰۲۶
openrtb-adx.proto پروتکل OpenRTB در Google شامل برخی افزونه‌ها است که در یک proto جداگانه ارائه شده است. v.210 ‫۴ اوت ۲۰۲۶
publisher-settings.proto مجموعه‌ای از تنظیمات ناشر مختص شبکه پیشنهاددهنده هم‌زمان. v.14 ‫۵ فوریه ۲۰۲۴

نسخه بتای عمومی Protos

فایل شرح نسخه Last Updated
openrtb-adx.proto پروتکل OpenRTB در Google شامل برخی افزونه‌ها است که در یک proto جداگانه ارائه شده است. v.220 ‫۱۶ سپتامبر ۲۰۲۶

داده مرجع

واژه‌نامه‌ها (برای بارگیری فایل txt .کلیک کنید)

دسته‌های محصول آگهی در فیلد excluded_product_category از BidRequest استفاده می‌شود. این فیلد دسته‌های محصولات و خدماتی را که ناشر اجازه نمی‌دهد شرح می‌دهد، برای مثال، اگر ناشر نخواهد آگهی‌های مربوط به بانکداری آنلاین را میزبانی کند.
دسته‌های محدودشده آگهی در فیلد allowed_restricted_category از BidRequest و فیلد restricted_category از BidResponse استفاده شده است. فیلد allowed_restricted_category دسته‌هایی را توصیف می‌کند که معمولاً محدودشده هستند، اما ناشر صریحاً آن‌ها را مجاز اعلام کرده است، برای مثال، آگهی‌های حاوی محتوای مرتبط با الکل.
دسته‌های حساس آگهی در فیلد excluded_sensitive_category از BidRequest و فیلد category از BidResponse استفاده شده است. فیلد excluded_sensitive_category دسته‌های حساس را که ناشر اجازه نمی‌دهد شرح می‌دهد، برای مثال، اگر ناشر نمی‌خواهد میزبان آگهی‌های مرتبط با سیاست باشد.
تبلیغ‌کنندگان Used in the advertiser_id field of SnippetStatusItem. این فیلد آگهی‌دهنده‌ای را مشخص می‌کند که طرح آگهی مرتبط با گزیده نشان می‌دهد. این فهرست نشان‌دهنده تبلیغ‌کنندگان در سراسر صرافی است و نشان‌دهنده تبلیغ‌کنندگانی نیست که توسط یک خریدار نمایندگی می‌شوند.
نمانام‌ها فهرست نمانام‌ها، استفاده‌شده در Client Access API.
مشخصه‌های طرح‌آگهی قابل‌اعلام خریدار برای فیلد attribute در BidResponse استفاده می‌شود. این فیلد مشخصه‌های قابل‌اعلام خریدار را در طرح‌آگهی‌ها شرح می‌دهد که نباید در excluded_attribute در BidRequest نشان داده شود.
برچسب‌های محتوا در فیلد detected_content_labels BidRequest استفاده می‌شود.
کدهای وضعیت تطبیق‌دهنده کوکی در فیلد cookieMatcherStatusRate گزارش‌های عملکرد «پروتکل مناقصه هم‌زمان» استفاده می‌شود. کدهای دردسترس در راهنمای تطبیق کوکی شرح داده شده‌اند.
کدهای وضعیت طرح آگهی

استفاده‌شده در

creative_status_code در بازخورد بلادرنگ برگردانده شد.
کدهای وضعیت مسابقه میزبانی‌شده در فیلد hostedMatchStatusRate گزارش‌های عملکرد پروتکل RTB استفاده می‌شود.
دلایل عدم پیشنهاد قیمت مقادیر استاندارد دلیل عدم پیشنهاد قیمت که باید در فیلد BidResponse.no_bid_reason در پروتکل پیشنهاد قیمت Authorized Buyers ارائه شود.
مشخصه‌های طرح‌آگهی قابل‌هدف‌یابی پیشاپیش در فیلد supportedCreativeAttribute در منبع PretargetingConfig که در Buyer REST API نمایش داده می‌شود استفاده می‌شود. این فیلد مشخصه‌های طرح آگهی را که انتظار می‌رود در همه طرح‌های آگهی وجود داشته باشد مطابق با یک پیکربندی پیش‌هدف‌یابی شرح می‌دهد.
مشخصه‌های طرح‌آگهی قابل‌استثنا کردن توسط ناشر در فیلد excluded_attribute از BidRequest استفاده می‌شود. این فیلد انواع طرح‌آگهی‌هایی را که ناشر اجازه استفاده از آن‌ها را نمی‌دهد شرح می‌دهد. برای مثال، ممکن است محدودیت‌هایی را درباره اینکه آیا استفاده از کوکی مجاز است یا اینکه آیا آگهی‌های رسانه‌ای و/یا نوشتاری مجاز هستند مشخص کنند.
فروشندگان در فیلد allowed_vendor_type از BidRequest استفاده می‌شود. این فیلد فهرست می‌کند که کدام فروشندگان رسانه تعاملی، مانند Campaign Monitor و VoiceFive، برای طرح آگهی ارائه‌شده مجاز هستند، همان‌طور که توسط ناشر مشخص شده است.

شامل فروشندگان از فایل واژه‌نامه gdn-vendors.txt منسوخ‌شده است.

ارائه‌دهندگان داده در فیلد SegmentData.id از BidRequest استفاده می‌شود. این فیلد حاوی اطلاعاتی درباره نهادی است که نشان‌های ناشرداده را ارائه کرده است.

جدول‌های مرجع (برای بارگیری CSVها کلیک کنید)

برنامه‌های تلفن همراه Android فهرست برنامه‌های تلفن همراه Android قابل‌هدف‌یابی با شناسه‌های برنامه، شناسه‌های دسته، و نام‌های قابل‌خواندن برای انسان.
جدول‌های جغرافیایی جدول مورداستفاده برای رمزگشایی فیلد geo_criteria_id BidRequest. برای اطلاعات بیشتر، به هدف‌یابی جغرافیایی مراجعه کنید.
ارائه‌دهندگان LGPD فهرست ارائه‌دهندگان شخصی‌سازی آگهی که مجاز به ارائه در ترافیک LGPD هستند، با شناسه، نام قابل‌خواندن برای انسان، نشانی وب حریم خصوصی، و فهرست دامنه‌هایی که می‌توانند به ارائه‌دهنده نسبت داده شوند. اجرای LGPD در درخواست پیشنهاد قیمت داده‌شده ازطریق فیلد BidRequest.adslot.regs_lgpd در پروتکل پیشنهاد قیمت «خریداران مجاز» و فیلد BidRequest.regs.ext.lgpd در پروتکل پیشنهاد قیمت OpenRTB نشان داده می‌شود.
شرکت‌های مخابراتی تلفن همراه فهرست شرکت‌های مخابراتی تلفن همراه.
دستگاه‌های همراه فهرست دستگاه‌های همراه.
سیستم‌عامل‌های تلفن همراه فهرست سیستم‌عامل‌های تلفن همراه.
ارائه‌دهندگان شناسه‌های ارائه‌دهنده شخصی‌سازی آگهی‌های Maps به نامی قابل‌خواندن برای انسان، نشانی وب خط‌مشی رازداری، و فهرستی از دامنه‌ها که می‌توانند به ارائه‌دهنده نسبت داده شوند. درحال‌حاضر، ارائه‌دهندگان در فیلد BidRequest.AdSlot.consented_providers_settings برای پروتکل AdX و BidRequest.User.UserExt.consented_providers_settings برای پروتکل OpenRTB استفاده می‌شوند. در این فیلدها، ارائه‌دهندگان فهرست‌شده موافقت کاربر را دارند، همان‌طور که ناشران برای کاربران ساکن کشورهای منطقه اقتصادی اروپا ارسال کرده‌اند.

تنظیمات ناشر

فایل publisher-settings.pb.gz را از نماینده حسابتان درخواست کنید.

موضوع‌های خط‌مشی بازبینی طرح‌آگهی

می‌توانید از موضوعات خط‌مشی در این فایل برای فیلتر کردن طرح‌آگهی‌ها درطول بازبینی در Real-time Bidding API استفاده کنید

بارگیری موضوعات خط‌مشی به‌صورت فایل CSV.

آخرین به‌روزرسانی: ۱۸ آوریل ۲۰۲۲