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

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

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

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

ReadinessState

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

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

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

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

שיטות

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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