文档

SearchPublicMediaInfo - 搜索公共版权媒资

更新时间:

根据用户所给参数,搜索符合条件的媒资。

调试

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

调试

授权信息

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

请求参数

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

IMS媒资ID。

  • 多个用英文逗号分隔。
****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****
DynamicMetaDataMatchFieldsstring

动态元数据搜索匹配条件

"ApprovalStatus='Available'&MaterialBags='boutiquemusic'&Mood='Nervous'"
Favoriteboolean

用户是否收藏了该媒资。

true
Authorizedboolean

用户是否已购买了包含此媒资的资源包。

true
SortBystring

结果排序方式 :。取值范围:

field:

  • "UsageCount" 使用量
  • "UnitPrice" 单价

order:

  • "Desc" 倒序
  • "Asc" 正序
UsageCount:Desc,UnitPrice:Asc
PageNointeger

页号

1
PageSizeinteger

每页行数大小。

10
EntityIdstring

实体ID,用来标识不同种类的公共版权媒资。取值:

  • Copyright_Music: 公共版权音乐
Copyright_Music

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID

****3CFB-2767-54FD-B311-BD15A4C1****
TotalCountlong

本次请求条件下的数据总量。

100
PublicMediaInfosobject []

公共版权媒资信息

Authorizedboolean

是否已购买包含该媒资的资源包。

true
Favoriteboolean

是否收藏了该媒资。

true
RemainingAuthTimestring

资源包剩余有效时间(天)

100
MediaInfoobject

媒资信息

MediaIdstring

媒资ID

icepublic-****87b921bb4a55908a72a0537e****
MediaBasicInfoobject

BasicInfo

MediaIdstring

MediaId

icepublic-****87b921bb4a55908a72a0537e****
MediaTypestring

媒资媒体类型

audio
BusinessTypestring

媒资业务类型

general
Sourcestring

来源

oss
Titlestring

标题

title
Descriptionstring

内容描述

description
Categorystring

分类

category
MediaTagsstring

标签

标签,tag1
CoverURLstring

封面地址

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>
UserDatastring

用户数据

userDataTest
Statusstring

资源状态

Normal
CreateTimestring

媒资创建时间

2020-12-26T06:04:49Z
ModifiedTimestring

媒资修改时间

2020-12-26T06:04:50Z
DeletedTimestring

媒资删除时间

2020-12-29T06:04:49Z
SpriteImagesstring

雪碧图

[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]
DynamicMetaDataobject

动态元数据

Datastring

元数据json string

"{\"AuditionUrl\": \"http://xxx\", \"AuditionCount\": 3...}"
Typestring

类型。取值范围:

  • "ai": AI原始结果统一化处理后的AI数据
  • "user-defined": 用户自定义元数据
  • "system": 系统自带
system

示例

正常返回示例

JSON格式

{
  "RequestId": "****3CFB-2767-54FD-B311-BD15A4C1****",
  "TotalCount": 100,
  "PublicMediaInfos": [
    {
      "Authorized": true,
      "Favorite": true,
      "RemainingAuthTime": "100",
      "MediaInfo": {
        "MediaId": "icepublic-****87b921bb4a55908a72a0537e****",
        "MediaBasicInfo": {
          "MediaId": "icepublic-****87b921bb4a55908a72a0537e****",
          "MediaType": "audio",
          "BusinessType": "general",
          "Source": "oss",
          "Title": "title",
          "Description": "description",
          "Category": "category",
          "MediaTags": "标签,tag1",
          "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
          "UserData": "userDataTest",
          "Status": "Normal",
          "CreateTime": "2020-12-26T06:04:49Z",
          "ModifiedTime": "2020-12-26T06:04:50Z",
          "DeletedTime": "2020-12-29T06:04:49Z",
          "SpriteImages": "[{\"bucket\":\"example-bucket\",\"count\":\"32\",\"iceJobId\":\"******83ec44d58b2069def2e******\",\"location\":\"oss-cn-shanghai\",\"snapshotRegular\":\"example/example-{Count}.jpg\",\"spriteRegular\":\"example/example-{TileCount}.jpg\",\"templateId\":\"******e438b14ff39293eaec25******\",\"tileCount\":\"1\"}]"
        },
        "DynamicMetaData": {
          "Data": "\"{\\\"AuditionUrl\\\": \\\"http://xxx\\\", \\\"AuditionCount\\\": 3...}\"",
          "Type": "system"
        }
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-25新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈