调用CreateRule创建规则_智能推荐 AIRec(AIRec)-阿里云帮助中心

创建推荐策略运营规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/openapi/instances/{instanceId}/rules

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	airec-cn-****

请求的 body：

参数	类型	是否必需	描述
type	String	是	规则类型 SelectionRule：选品规则 OperationRule：运营规则 TopRule：置顶规则 FixedPositionRule：定坑规则
ruleMeta	Map	是	规则的具体信息
└sceneId	String	是	场景 ID 如要修改全局运营规则，填 global
selectionParams	List	是	选品规则参数
└selectType	Enum	是	QUERY_ITEM_TYPE：物品类型 QUERY_CATEGORY：物品类目 QUERY_PUB_TIME ：发布时间 QUERY_CHANNEL：渠道
└selectionOperation	Enum	是	OPERATOR_HIGHER：大于等于 OPERATOR_LOWER：小于等于 _QUERY_VALUE_IN：包括_
└selectValue	String	是	具体选择的选品规则（Json 格式传递）
operationParams
└modifyOperationType	List	是	["DIVERSIFY","EXPOSURE"] 添加需要修改的 key
└instanceDiversifyEnable	boolean	是	是否使用实例级别的多样性规则
└instanceMixEnable	boolean		是否使用实例级别的混排规则
└operationType	Enum	是	MIX 排序 DIVERSIFY：多样性 EXPOSURE：曝光（只有全局规则支持曝光类型）
└settings	MixSetting	是
└name	String	是	混排类型
└value	int	是	混排类型所占百分比
└diversifyType	Enum	是	TYPE_SHOP：店铺打散 TYPE_AUTHOR ：作者打散 TYPE_CATEGORY：类目打散 TYPE_ITEM_TYPE：物品类型打散
└categoryIndex	int	是	层级，没有填 0
└window	int	是	窗口
└status	boolean	是	打散是否开启，true：开启，false：关闭
└instanceExposureEnable	boolean	是	是否使用实例级别的曝光配置，默认 true
└exposureSettings	List	是	曝光配置列表
└durationSeconds	Long	是	曝光时间（秒级时间戳）
└exposureType	String	是	曝光类型： TYPE_EXPOSE：曝光 TYPE_CLICK：点击 TYPE_LOOP：循环
└status	boolean	是	曝光是否开启，true：开启，false：关闭
└scenarioBased	boolean	是	是否基于场景，true：是，false：否，基于实例
└mtOrderSettings	MtOrderSetting	是	相关度规则配置列表
└index	int	是	该值为标识顺序以及符号，例如：a=b=c：111，a=b>c：112，a>b>c：123
└value	String	是	相关度规则，TITLE，TAG，CHANNEL，AUTHOR
└settings	NewItemSetting	是	新品定义规则配置
└selectType	String	是	QUERY_PUB_TIME，固定字符串
└selectionOperation	String	是	OPERATOR_LOWER，固定字符串
└selectValue	int	是	新品定义的时间，秒级别时间戳
└settings	SimilaritySetting		标题相似度规则
└windowSize	int		重复个数，标题相似度这个规则不需要修改
└repeatLimit	int		时间窗口，标题相似度这个规则不需要修改
└type	String		title，固定字符串
└status	boolean		标题相似度规则是否开启，true：是，false：否
topParams	List	是	置顶规则物品列表
└itemId	String	是	物品 ID
└itemType	String	是	物品类型
└title	String	是	标题
└categoryPath	String	是	类目
└channel	String	是	渠道（内容/新闻）
└author	String	是	作者（内容/新闻）
└brandId	String	是	品牌（电商）
└shopId	String	是	店铺（电商）
fixedPositionParams	List	是	定坑规则列表
└positions	List	是	位置列表，格式为[坑位 ID1,坑位 ID2]
└selectType	String	是	选品类型，固定值为 QUERY_ITEM_ID_AND_TYPE
└selectionOperation	String	是	选品规则，固定值为 QUERY_VALUE_IN
└selectValue	String	是	选品物品，格式为 1:item;2:item

返回参数

名称	类型	描述	示例值
	object	返回结果详情。
result	object	返回结果详情。
ruleId	string	规则 ID。	98493A14-D619-4E88-9F8D-108939817F9F
gmtModified	string	最后修改时间。	2020-04-27T06:38:28.000Z
status	string	规则状态： DRAFT：草稿状态 EFFECTIVE：生效状态 PUBLISHING：发布中状态 INEFFECTIVE：已失效状态 FAILED：未生效状态	EFFECTIVE
gmtCreate	string	创建时间。	2020-04-27T06:38:28.000Z
code	string	错误码。	InternalServerError
requestId	string	请求 ID。	8F81A922-6C81-46D6-B78C-CC35E16B1691
message	string	错误详情。	An internal server error occurred

示例

正常返回示例

JSON格式

{
  "result": {
    "ruleId": "98493A14-D619-4E88-9F8D-108939817F9F",
    "gmtModified": "2020-04-27T06:38:28.000Z",
    "status": "EFFECTIVE",
    "gmtCreate": "2020-04-27T06:38:28.000Z"
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史