REST Resource: projects.locations.dataStores.controls

リソース: Control
- JSON 表現
メソッド

リソース: Control

サービング中に使用する条件付き動作を定義します。サービング時に考慮されるには、ServingConfig に関連付けられている必要があります。許可されるアクションは SolutionType によって異なります。

JSON 表現

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,
  "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` 必須。人が読める形式の名前。UI ビューで使用される識別子。 UTF-8 でエンコードされた文字列である必要があります。長さの上限は 128 文字です。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
`associatedServingConfigIds[]`	`string` 出力専用。このコントロールが関連付けられているすべての `ServingConfig` ID のリスト。変更後、更新されるまでに 10 分ほどかかることがあります。
`solutionType`	`enum (SolutionType)` 必須。変更不可。コントロールが属するソリューション。リソースのカテゴリと互換性がある必要があります。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
`useCases[]`	`enum (SearchUseCase)` コントロールのユースケースを指定します。設定できる条件フィールドに影響します。`SOLUTION_TYPE_SEARCH` にのみ適用します。現時点では、コントロールごとに 1 つのユースケースのみが許可されています。solutionType が `SolutionType.SOLUTION_TYPE_SEARCH` の場合は設定する必要があります。
`conditions[]`	`object (Condition)` 関連付けられたアクションがトリガーされるタイミングを決定します。省略すると、アクションが常に適用されます。現時点では、指定できる条件は 1 つのみです。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
共用体フィールド `action`。アクションはカテゴリとソリューションによって制限されます必須。`action` は次のいずれかになります。
`boostAction`	`object (BoostAction)` ブーストタイプのコントロールを定義する
`filterAction`	`object (FilterAction)` フィルタタイプのコントロールを定義します。現在、推奨事項ではサポートされていません
`redirectAction`	`object (RedirectAction)` リダイレクトタイプのコントロールを定義します。
`synonymsAction`	`object (SynonymsAction)` 一連のキーワードを互いに同義語として扱います。
`promoteAction`	`object (PromoteAction)` 事前定義されたトリガークエリに基づいて特定のリンクをプロモートします。

メソッド
`create`	Control を作成します。
`delete`	Control を削除します。
`get`	Control を取得します。
`list`	すべての Control を親 `DataStore` ごとに一覧表示します。
`patch`	Control を更新します。

REST Resource: projects.locations.dataStores.controls

リソース: Control

メソッド

`create`

`delete`

`get`

`list`

`patch`