REST Resource: customBiddingAlgorithms

منبع: CustomBidding Algorithm

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

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

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
فیلدها
name

string

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

customBiddingAlgorithmId

string ( int64 format)

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

displayName

string

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

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

entityStatus

enum ( EntityStatus )

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

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

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum ( CustomBiddingAlgorithmType )

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

sharedAdvertiserIds[]

string ( int64 format)

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

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

modelDetails[]

object ( CustomBiddingModelDetails )

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

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

owner میدان اتحادیه موجودیت DV360 را که مالک الگوریتم مناقصه سفارشی است، شناسایی می کند. این می تواند یک شریک یا یک تبلیغ کننده باشد. owner تنها می تواند یکی از موارد زیر باشد:
partnerId

string ( int64 format)

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

advertiserId

string ( int64 format)

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

Custom BiddingAlgorithmType

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

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED نوع الگوریتم در این نسخه مشخص نشده یا ناشناخته است.
SCRIPT_BASED الگوریتم تولید شده از طریق فایل‌های اسکریپت پیشنهادی سفارشی بارگذاری شده توسط مشتری.
ADS_DATA_HUB_BASED الگوریتم ایجاد شده از طریق محصول Ads Data Hub.
GOAL_BUILDER_BASED الگوریتم ایجاد شده از طریق سازنده هدف در رابط کاربری DV3.
RULE_BASED

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

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

CustomBiddingModelDetails

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

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

string ( int64 format)

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

readinessState

enum ( ReadinessState )

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

suspensionState

enum ( SuspensionState )

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

وضعیت آمادگی

حالت های احتمالی آمادگی مدل

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

حالت تعلیق

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

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

روش ها

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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