文档

ModifyFlowControlTask - 修改流量控制任务,目前只支持草稿态和发布失败状态的任务修改配置信息

流调任务修改接口。

调试

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

授权信息

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

请求语法

PUT /v2/openapi/instances/{instanceId}/flowControlTasks/{taskId}

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID。

airec-cn-****
taskIdstring

流量调控任务 ID。

1667297014460
bodyobject

请求 Body 参数。

TaskNamestring

流量调控任务名称。

testname
descriptionstring

流量调控描述信息。

描述
endTimelong

结束时间秒级时间戳。

1639519200
metaTypestring

流量调控 Meta 类型,固定值 FlowControlTask。

FlowControlTask
sceneIdsstring

场景 ID,支持多个,英文,分割即可。

all,sy101
selectionParamsobject []

选品规则参数列表。

selectTypestring

选品规则过滤条件类型。

invalidItem
selectValuestring

选品规则过滤条件具体数值。

20
selectionOperationstring

选品规则过滤条件操作。

OPERATOR_HIGHER
startTimelong

开始时间(秒级时间戳)。

1638460800
targetobject

物品曝光配置。

typestring

曝光类型。

取值:

  • EXPOSE_PERCENT:每日曝光百分比。

  • EXPOSE_COUNT:曝光总量。

EXPOSE_PERCENT
valuelong

曝光值。

50

返回参数

名称类型描述示例值
object

返回参数。

requestIdstring

请求 ID。

8F81A922-6C81-46D6-B78C-CC35E16B1691
resultobject

返回参数。

gmtCreatestring

创建时间的 UTC 时间。

2018-12-07T02:24:26.000Z
gmtModifiedstring

最后修改数据源的 UTC 时间。

2020-11-11T09:47:43.000Z
metaobject

流量调控 Meta。

descriptionstring

流量调控描述信息。

tst
endTimelong

结束时间秒级时间戳。

1656518399
metaTypestring

流量调控 Meta 类型,固定值 FlowControlTask。

FlowControlTask
sceneIdsstring

场景 ID,支持多个,英文,分割即可。

1,2,3
selectionParamsobject []

选品规则参数列表。

selectTypestring

选品规则过滤条件类型。

QUERY_PUB_TIME
selectValuestring

选品规则过滤条件具体数值。

10000
selectionOperationstring

选品规则过滤条件操作。

OPERATOR_HIGHER
startTimelong

开始时间(秒级时间戳)。

1640739600
targetobject

曝光配置。

typestring

曝光类型。

取值:

  • EXPOSE_PERCENT:每日曝光百分比。

  • EXPOSE_COUNT:曝光总量。

EXPOSE_PERCENT
valuelong

曝光值。

20
taskNamestring

流量调侃任务名称。

活动用户测试
statusstring

任务状态。

取值:

  • DRAFT:草稿。

  • READY:待生效。

  • RUNNING:运行中。

  • ENDED:结束。

DRAFT
TaskIdstring

流量调侃任务 ID。

1661506482

示例

正常返回示例

JSON格式

{
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "result": {
    "gmtCreate": "2018-12-07T02:24:26.000Z",
    "gmtModified": "2020-11-11T09:47:43.000Z",
    "meta": {
      "description": "tst",
      "endTime": 1656518399,
      "metaType": "FlowControlTask",
      "sceneIds": "1,2,3",
      "selectionParams": [
        {
          "selectType": "QUERY_PUB_TIME",
          "selectValue": "10000",
          "selectionOperation": "OPERATOR_HIGHER"
        }
      ],
      "startTime": 1640739600,
      "target": {
        "type": "EXPOSE_PERCENT",
        "value": 20
      },
      "taskName": "活动用户测试"
    },
    "status": "DRAFT",
    "TaskId": "1661506482"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈