ListAdInsertions - 获取广告插入配置列表

更新时间:
复制 MD 格式

获取广告插入配置列表。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListAdInsertions

list

*全部资源

*

无 无

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Keyword

string

否

按广告配置名称查询,支持模糊匹配

ad

PageNo

integer

否

分页参数,页码,默认为 1

1

PageSize

integer

否

分页参数,页宽,默认为 10

10

SortBy

string

否

分页参数,排序方式,asc:按创建时间升序,desc:按创建时间降序

枚举值:

  • asc :

    按创建时间升序

  • desc :

    按创建时间降序

asc

NextToken

string

否

数据抓取参数,获取后续数据的 token,使用此方式获取数据时分页参数将无效

******8EqYpQbZ6Eh7+Zz8DxVYoQ*****

MaxResults

integer

否

数据抓取参数,获取后续数据的最大记录数,使用此方式获取数据时分页参数将无效,默认为 10

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

Configs

array<object>

数组

array<object>

AdInsertionConifgItemType

CreateTime

string

创建时间

2024-06-13T08:26:09Z

LastModified

string

修改时间

2024-06-13T08:26:09Z

Name

string

广告插入配置名称

my_ad

ContentUrlPrefix

string

内容 URL 前缀

https://source.com/

AdsUrl

string

广告策略服务器 URL

http://ads.com/ad1?param1=[palyer_params.p1]

ConfigAliases

string

动态配置别名

{ "player_params.p1": { "1": "abc" } }

PersonalizationThreshold

integer

个性化配置阈值

5

SlateAdUrl

string

slate 广告 URL

http://storage.com/slate1.mp4

CdnConfig

object

CDN 配置

ContentSegmentUrlPrefix

string

视频内容分片的 CDN 前缀

http://cdn.com/

AdSegmentUrlPrefix

string

广告分片的 CDN 前缀

http://cdn.com/

AdMarkerPassthrough

string

广告标记透传

ON

ManifestEndpointConfig

object

清单播放端点配置

HlsPrefix

string

HLS 清单播放端点前缀

https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/

DashPrefix

string

DASH 清单播放端点前缀

https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/

PageNo

integer

分页参数,页码

1

PageSize

integer

分页参数,页宽

10

RequestId

string

Id of the request

******11-DB8D-4A9A-875B-275798******

SortBy

string

分页参数,排序方式,asc:按创建时间升序,desc:按创建时间降序

asc

TotalCount

integer

总记录数

10

NextToken

string

数据抓取参数,获取后续数据的 token,使用此方式获取数据时分页参数将无效

******8EqYpQbZ6Eh7+Zz8DxVYoQ*****

MaxResults

integer

数据抓取参数,获取后续数据的最大记录数,使用此方式获取数据时分页参数将无效

10

示例

正常返回示例

JSON格式

{
  "Configs": [
    {
      "CreateTime": "2024-06-13T08:26:09Z",
      "LastModified": "2024-06-13T08:26:09Z\n",
      "Name": "my_ad",
      "ContentUrlPrefix": "https://source.com/",
      "AdsUrl": "http://ads.com/ad1?param1=[palyer_params.p1]",
      "ConfigAliases": "{\n      \"player_params.p1\": {\n            \"1\": \"abc\"\n      }\n}",
      "PersonalizationThreshold": 5,
      "SlateAdUrl": "http://storage.com/slate1.mp4",
      "CdnConfig": {
        "ContentSegmentUrlPrefix": "http://cdn.com/",
        "AdSegmentUrlPrefix": "http://cdn.com/"
      },
      "AdMarkerPassthrough": "ON",
      "ManifestEndpointConfig": {
        "HlsPrefix": "https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/",
        "DashPrefix": "https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/"
      }
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SortBy": "asc",
  "TotalCount": 10,
  "NextToken": "******8EqYpQbZ6Eh7+Zz8DxVYoQ*****",
  "MaxResults": 10
}

错误码

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

变更历史

更多信息,参考变更详情。