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),

  // 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 של מפרסם.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

אופציונלי. אי אפשר לשנות אותו. מציין את שותף האופטימיזציה מצד שלישי שמנהל את האלגוריתם הזה.
שדה איחוד owner. מזהה את הישות ב-DV360 שבבעלותה אלגוריתם הבידינג בהתאמה אישית. הגורם הזה יכול להיות שותף או מפרסם. הערך owner יכול להיות רק אחד מהבאים:
partnerId

string (int64 format)

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

string (int64 format)

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

CustomBiddingAlgorithmType

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

טיפוסים בני מנייה (enum)
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED סוג האלגוריתם לא צוין או לא ידוע בגרסה הזו.
SCRIPT_BASED אלגוריתם שנוצר באמצעות קובצי סקריפטים של בידינג בהתאמה אישית שהלקוח העלה.
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 ויידרש זמן כדי להכין מחדש את מודל הצגת המודעות.

ThirdPartyOptimizationPartnerType

סוגים אפשריים של שותפי צד שלישי לאופטימיזציה.

טיפוסים בני מנייה (enum)
UNKNOWN ערך הסוג לא צוין או שהוא לא ידוע בגרסה הזו.
SCIBIDS ספק שירותי מדעי הנתונים של צד שלישי שאיתו שותפים או מפרסמים ב-DV3 יכולים לשתף פעולה.
ADELAIDE ספק שירותי מדידת תשומת לב מצד שלישי שאיתו שותפים או מפרסמים ב-DV3 יכולים לשתף פעולה.

Methods

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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