REST Resource: customBiddingAlgorithms

משאב: CustomBiddingAlgorithm

אלגוריתם יחיד של בידינג בהתאמה אישית.

ייצוג 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)

בלתי ניתן לשינוי. המזהה הייחודי של המפרסם שבבעלותו האלגוריתם של בידינג בהתאמה אישית.

CustomBiddingAlgorithmType

סוגים אפשריים של אלגוריתמים של בידינג בהתאמה אישית.

טיפוסים בני מנייה (enum)
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)

פלט בלבד. מצב ההשעיה של מודל הבידינג בהתאמה אישית.

ReadinessState

מצבים אפשריים של מוכנות המודל.

טיפוסים בני מנייה (enum)
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

מצבי השעיה אפשריים של מודלים של בידינג בהתאמה אישית.

טיפוסים בני מנייה (enum)
SUSPENSION_STATE_UNSPECIFIED המצב לא צוין או שאינו ידוע בגרסה הזו.
SUSPENSION_STATE_ENABLED המודל מופעל, שהוא היה בשימוש לאחרונה, נמצא כרגע בשימוש או מתוזמן לשימוש. האלגוריתם צובר חשיפות באופן פעיל עבור המפרסם הזה.
SUSPENSION_STATE_DORMANT המודל לא היה בשימוש לאחרונה. המודל עדיין יפעל כ-ENABLED, אבל בסופו של דבר הוא יושעה אם לא ייעשה בו שימוש.
SUSPENSION_STATE_SUSPENDED המודל מושעה ולא ניתן להציג אותו. אם האלגוריתם מוקצה לפריט שנמצא מתחת למפרסם הזה או עודכן באופן אחר, הוא יחזור למצב ENABLED ויידרש זמן הכנה מחדש של מודל הצגת המודעות.

שיטות

create

 יצירת אלגוריתם חדש של בידינג בהתאמה אישית.

get

 הפונקציה מקבלת אלגוריתם של בידינג בהתאמה אישית.

list

 בתיבת הדו שיח הזו מפורטים אלגוריתמים של בידינג בהתאמה אישית שיש להם גישה למשתמש הנוכחי ושאפשר להשתמש בהם באסטרטגיות בידינג.

patch

 עדכון אלגוריתם קיים של בידינג בהתאמה אישית.

uploadRules

 יצירת אובייקט הפניה לכללים עבור קובץ AlgorithmRules.

uploadScript

 יצירת אובייקט עזר של סקריפט בידינג בהתאמה אישית עבור קובץ סקריפט.