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

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