REST Resource: customBiddingAlgorithms

منبع: الگوریتم پیشنهاد قیمت سفارشی

یک الگوریتم مناقصه سفارشی واحد.

نمایش JSON 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],
  "thirdPartyOptimizationPartner": enum (ThirdPartyOptimizationPartnerType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
فیلدها
name

string

فقط خروجی. نام منبع الگوریتم مناقصه سفارشی.

customBiddingAlgorithmId

string ( int64 format)

فقط خروجی. شناسه منحصر به فرد الگوریتم مناقصه سفارشی. اختصاص داده شده توسط سیستم.

displayName

string

الزامی. نام نمایشی الگوریتم پیشنهاد قیمت سفارشی.

باید با کد UTF-8 و حداکثر اندازه ۲۴۰ بایت کدگذاری شود.

entityStatus

enum ( EntityStatus )

کنترل می‌کند که آیا الگوریتم پیشنهاد قیمت سفارشی می‌تواند به عنوان یک استراتژی پیشنهاد قیمت استفاده شود یا خیر.

مقادیر پذیرفته شده عبارتند از:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum ( CustomBiddingAlgorithmType )

الزامی. تغییرناپذیر. نوع الگوریتم مناقصه سفارشی.

sharedAdvertiserIds[]

string ( int64 format)

شناسه‌های تبلیغ‌کنندگانی که به این الگوریتم دسترسی دارند. اگر advertiserId تنظیم شده باشد، این فیلد فقط شامل آن مقدار خواهد بود.

اگر owner الگوریتم یک شریک باشد و با استفاده از یک accessor تبلیغ‌کننده بازیابی شود، این فیلد تنظیم نخواهد شد.

modelDetails[]

object ( CustomBiddingModelDetails )

فقط خروجی. جزئیات مدل‌های مناقصه سفارشی برای هر تبلیغ‌کننده‌ای که دسترسی دارد.

این فیلد فقط در صورتی می‌تواند شامل جزئیات تبلیغ‌کننده‌ی مورد جستجو باشد که owner الگوریتم، شریک باشد و با استفاده از یک accessor تبلیغ‌کننده بازیابی شود.

thirdPartyOptimizationPartner

enum ( ThirdPartyOptimizationPartnerType )

اختیاری. تغییرناپذیر. شریک بهینه‌سازی شخص ثالثی را که این الگوریتم را مدیریت می‌کند، مشخص می‌کند.

نهاد DV360 که مالک الگوریتم مناقصه سفارشی است را شناسایی می‌کند. این نهاد می‌تواند شریک یا تبلیغ‌کننده باشد. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم می‌شود:
partnerId

string ( int64 format)

تغییرناپذیر. شناسه منحصر به فرد شریکی که الگوریتم مناقصه سفارشی را در اختیار دارد.

advertiserId

string ( int64 format)

تغییرناپذیر. شناسه منحصر به فرد تبلیغ‌کننده‌ای که الگوریتم مناقصه سفارشی را در اختیار دارد.

پایان میدان‌های ناسازگار.

نوع الگوریتم پیشنهاد قیمت سفارشی

انواع الگوریتم‌های مناقصه سفارشی ممکن.

انوم‌ها
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED نوع الگوریتم در این نسخه مشخص نشده یا ناشناخته است.
SCRIPT_BASED الگوریتمی که از طریق فایل‌های اسکریپت مناقصه سفارشی آپلود شده توسط مشتری تولید می‌شود.
RULE_BASED

الگوریتم مبتنی بر قوانین تعریف‌شده. این قوانین با استفاده از شیء AlgorithmRules در API تعریف می‌شوند.

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

جزئیات مدل مناقصه سفارشی

جزئیات یک مدل الگوریتم مناقصه سفارشی برای یک تبلیغ‌کننده مشترک.

نمایش JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
فیلدها
advertiserId

string ( int64 format)

شناسه منحصر به فرد تبلیغ کننده مربوطه.

readinessState

enum ( ReadinessState )

وضعیت آمادگی مدل مناقصه سفارشی.

suspensionState

enum ( SuspensionState )

فقط خروجی. حالت تعلیق مدل مناقصه سفارشی.

آمادگی دولت

حالت‌های ممکن آمادگی مدل.

انوم‌ها
READINESS_STATE_UNSPECIFIED در این نسخه، وضعیت مشخص نشده یا ناشناخته است.
READINESS_STATE_ACTIVE مدل آموزش دیده و آماده سرو است.
READINESS_STATE_INSUFFICIENT_DATA داده‌های کافی برای آموزش مدل سرویس‌دهی وجود ندارد.
READINESS_STATE_TRAINING مدل در حال آموزش است و آماده خدمت نیست.
READINESS_STATE_NO_VALID_SCRIPT اسکریپت مناقصه سفارشی معتبری برای آموزش مدل ارائه نشده است. این وضعیت فقط برای الگوریتم‌هایی اعمال می‌شود که customBiddingAlgorithmType آنها SCRIPT_BASED باشد.
READINESS_STATE_EVALUATION_FAILURE یک اسکریپت معتبر ارائه شده اما ارزیابی آن ناموفق بوده است. این مورد برای اسکریپت‌هایی که در زمان تعیین‌شده قابل ارزیابی نبوده‌اند، قابل اجرا است.

حالت تعلیق

حالت‌های تعلیق احتمالی مدل‌های مناقصه سفارشی.

انوم‌ها
SUSPENSION_STATE_UNSPECIFIED در این نسخه، وضعیت مشخص نشده یا ناشناخته است.
SUSPENSION_STATE_ENABLED مدل فعال است، چه اخیراً استفاده شده باشد، چه در حال حاضر استفاده شود و چه قرار باشد استفاده شود. الگوریتم به طور فعال در حال امتیازدهی به نمایش‌ها برای این تبلیغ‌کننده است.
SUSPENSION_STATE_DORMANT مدل اخیراً مورد استفاده قرار نگرفته است. اگرچه مدل هنوز به عنوان ENABLED عمل می‌کند، اما در صورت عدم استفاده، در نهایت به حالت تعلیق در خواهد آمد.
SUSPENSION_STATE_SUSPENDED مدل از امتیازدهی به نمایش‌ها معلق شده و نمی‌تواند خدمت‌رسانی کند. اگر الگوریتم به یک آیتم خطی تحت این تبلیغ‌کننده اختصاص داده شود یا به‌روزرسانی دیگری انجام شود، به حالت ENABLED برمی‌گردد و برای آماده‌سازی مجدد مدل خدمت‌رسانی به زمان نیاز دارد.

نوع شریک بهینه‌سازی شخص ثالث

انواع شرکای بهینه‌سازی شخص ثالث احتمالی.

انوم‌ها
UNKNOWN مقدار نوع در این نسخه مشخص نشده یا ناشناخته است.
SCIBIDS ارائه دهنده خدمات علوم داده شخص ثالث که شرکا/تبلیغ‌کنندگان DV3 می‌توانند با آن همکاری کنند.
ADELAIDE ارائه دهنده خدمات سنجش توجه شخص ثالث که شرکا/تبلیغ‌کنندگان DV3 می‌توانند با آن همکاری کنند.

روش‌ها

create

 یک الگوریتم مناقصه سفارشی جدید ایجاد می‌کند.

get

 یک الگوریتم مناقصه سفارشی دریافت می‌کند.

list

 الگوریتم‌های مناقصه سفارشی را که برای کاربر فعلی قابل دسترسی هستند و می‌توانند در استراتژی‌های مناقصه استفاده شوند، فهرست می‌کند.

patch

 الگوریتم مناقصه سفارشی موجود را به‌روزرسانی می‌کند.

uploadRules

 یک شیء مرجع قوانین برای فایل AlgorithmRules ایجاد می‌کند.

uploadScript

 یک شیء مرجع اسکریپت مناقصه سفارشی برای یک فایل اسکریپت ایجاد می‌کند.