REST Resource: projects.locations.collections.engines.controls

משאב: בקרה

הגדרת התנהגות מותנית שתופעל במהלך הצגת המודעה. כדי שההגדרה תישקל בזמן הצגת המודעה, היא צריכה להיות מצורפת לServingConfig. הפעולות המותרות תלויות בSolutionType.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

אי אפשר לשנות. שם ייחודי מלא projects/*/locations/global/dataStore/*/controls/*
displayName

string

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

מחרוזת מקודדת ב-UTF-8. הגבלת האורך היא 128 תווים. אחרת, מוצגת שגיאה מסוג INVALID ARGUMENT.
associatedServingConfigIds[]

string

פלט בלבד. רשימה של כל המזהים של ServingConfig שהבקרה הזו מצורפת אליהם. יכולות לעבור עד 10 דקות מרגע שהשינויים יתבצעו ועד שהם יתעדכנו.
solutionType

enum (SolutionType)

חובה. אי אפשר לשנות. הפתרון שאליו שייך אמצעי הבקרה.

הערך צריך להיות תואם לקטגוריית הישויות (vertical) של המשאב. אחרת, מוצגת שגיאה מסוג INVALID ARGUMENT.
useCases[]

enum (SearchUseCase)

מציינת את תרחיש השימוש של אמצעי הבקרה. משפיע על שדות התנאים שאפשר להגדיר. ההגדרה חלה רק על SOLUTION_TYPE_SEARCH. בשלב הזה, אפשר להגדיר רק תרחיש שימוש אחד לכל אמצעי בקרה. חובה להגדיר את הערך הזה כש-solutionType הוא SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

ההגדרה הזו קובעת מתי הפעולה המשויכת תופעל.

אם לא מציינים כלום, הפעולה תמיד תתבצע. נכון לעכשיו, אפשר לציין רק תנאי אחד. אחרת, מוצגת שגיאה מסוג INVALID ARGUMENT.
בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
boostAction

object (BoostAction)

הגדרה של אמצעי בקרה מסוג הגברה
filterAction

object (FilterAction)

הגדרה של אמצעי בקרה מסוג מסנן. לא אפשרי כרגע על ידי Recommendation
redirectAction

object (RedirectAction)

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

object (SynonymsAction)

התייחסות לקבוצת מונחים כמילים נרדפות.
promoteAction

object (PromoteAction)

קידום קישורים מסוימים על סמך שאילתות מוגדרות מראש להפעלת הקידום.
סוף השדות הבלעדיים.

Methods

create

 יצירת אמצעי בקרה.

delete

 מחיקת אמצעי בקרה.

get

 מקבלים אמצעי בקרה.

list

 מפרט את כל אמצעי הבקרה לפי ההורה שלהם DataStore.

patch

 עדכון של אמצעי בקרה.