REST Resource: customBiddingAlgorithms

منبع: CustomBiddingAlgorithm

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

نمایش 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)

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

CustomBiddingAlgorithmType

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

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

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

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

CustomBiddingModelDetails

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

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

string (int64 format)

شناسه یکتای تبلیغ‌کننده مربوطه.
readinessState

enum (ReadinessState)

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

enum (SuspensionState)

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

ReadinessState

وضعیت‌های ممکن آمادگی مدل.

شمارشی‌ها
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 دستورگان معتبری ارائه شد اما ارزیابی نشد. این مورد برای دستورگان‌هایی که در زمان اختصاص‌داده‌شده ارزیابی نشده‌اند قابل‌اجرا است.

SuspensionState

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

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

ThirdPartyOptimizationPartnerType

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

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

روش‌ها

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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