REST Resource: projects.locations.dataStores.controls

资源：Control

定义在提供服务期间采用的条件行为。必须附加到 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

必需。直观易懂的名称。界面视图中使用的标识符。

必须是 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)

定义了过滤类型的控件，目前不受 Recommendation 支持
redirectAction

object (RedirectAction)

定义重定向类型的控制变量。
synonymsAction

object (SynonymsAction)

将一组字词视为彼此的同义词。
promoteAction

object (PromoteAction)

根据预定义的触发查询来推广特定链接。

方法

create

 创建控制变量。

delete

 删除控制变量。

get

 获取控件。

list

 按父级 DataStore 列出所有控制变量。

patch

 更新控制变量。