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

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
欄位
name

string

不可變動。完整名稱 projects/*/locations/global/dataStore/*/controls/*
displayName

string

這是必要旗標，使用者可判讀的名稱。使用者介面檢視區塊中使用的 ID。

必須是 UTF-8 編碼的字串。長度上限為 128 個字元。否則會擲回 INVALID ARGUMENT 錯誤。
associatedServingConfigIds[]

string

僅供輸出。這個控制項所連結的所有 ServingConfig ID 清單。變更後最多可能需要 10 分鐘才會更新。
solutionType

enum (SolutionType)

這是必要旗標，不可變動。控制項所屬的解決方案。

必須與資源的類別相容。否則會擲回 INVALID ARGUMENT 錯誤。
useCases[]

enum (SearchUseCase)

指定控制項的用途。影響可設定的條件欄位。僅適用於 SOLUTION_TYPE_SEARCH。目前每個控制項僅允許一個用途。如果 solutionType 為 SolutionType.SOLUTION_TYPE_SEARCH，則必須設定此欄位。
conditions[]

object (Condition)

決定何時觸發相關聯的動作。

如要一律套用動作，請省略這項屬性。目前只能指定單一條件。否則會擲回 INVALID ARGUMENT 錯誤。

聯集欄位 action。動作受垂直產業和解決方案限制

這是必要旗標，action 只能是下列其中一項：
boostAction

object (BoostAction)

定義增幅類型控制項
filterAction

object (FilterAction)

定義篩選器類型控制項，目前建議功能不支援
redirectAction

object (RedirectAction)

定義重新導向類型的控制項。
synonymsAction

object (SynonymsAction)

將一組字詞視為彼此的同義字。
promoteAction

object (PromoteAction)

根據預先定義的觸發查詢，宣傳特定連結。

方法

create

 建立 Control。

delete

 刪除控制項。

get

 取得 Control。

list

 依上層 DataStore 列出所有控制項。

patch

 更新控制項。