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 ובגודל של עד 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)

אופציונלי. לא ניתן לשינוי. מציין את השותף החיצוני לאופטימיזציה שמנהל את האלגוריתם הזה.
מזהה את הישות ב-DV360 שבבעלותה האלגוריתם של הבידינג בהתאמה אישית. הגורם יכול להיות שותף או מפרסם. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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 ספק שירות צד שלישי למדידת תשומת לב, ששותפים או מפרסמים ב-DV360 יכולים לעבוד איתו.

Methods

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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