Skip to content

获取创意信息

需要携带 Token,详情看 Token

获取创意信息, 支持按条件分页查询

请求地址

https://{BASE_URL}/api/open/v3/creative-ad/list

请求方法

GET

请求示例

json
GET /api/open/v3/creative-ad/list
HTTP/1.1 Host: {BASE_URL}
Content-Type: application/json
{ "ad_ids": [2131252991, 2131252990] }

请求参数

字段类型是否必填说明默认值例子
ad_idsarray<int64>Y创意ID2131252991
demand_package_namestringN推广包名com.xxx.xx
pageintN分页, 从1开始, 默认为111
limitintN分页每页记录数,默认20,最大1002020

我们推荐您使用ad_ids而不是demand_package_name,因为使用demand_package_name时我们会返回全部的创意,而不是仅返回您收到的那部分

响应结果

字段类型说明
codeint200 表示成功,其他表示失败
messagestring成功,返回"success",失败返回相应的错误信息
datajson成功,返回素材组信息,失败返回具体的错误信息
limitint数据页记录数上限
pageint数据页
totalint总记录数
listarray<object>记录详情
ad_idint创意ID
ad_namestring创意名称
offer_idint64广告单元id
offer_uuidstring广告单元唯一名称
creative_set_idint64创意组ID
combination_methodint创意组创意组装方式, 1为程序化,2为自定义
ad_outputint[枚举值 - 创意类型类型及要求尺寸]
creativesarray<object>创意素材详情
creative_idint64素材ID
creative_namestring素材名称
creative_md5string素材md5
creative_typestring素材类型, IMAGE、VIDEO、PLAYABLE
creative_urlstring素材链接

应答示例

json
{
  "code": 200,
  "message": "success",
  "data": {
    "limit": 1,
    "page": 1,
    "total": 13,
    "list": [
      {
        "creative_set_id": 1317,
        "ad_id": 2131252991,
        "ad_name": "lixiantest_ss_custom_20240726_111_6699150e1321a_lixiantest_ss_url_20240725",
        "combination_method": 2,
        "ad_output": 212,
        "offer_id": 190511,
        "offer_uuid": "ss_uuid123",
        "creatives": [
          {
            "creative_id": 2705156619,
            "creative_name": "lixiantest_ss_url_20240725",
            "creative_md5": "9c3ee4b0b39a5ee0606aca40ad7f9262",
            "creative_type": "PLAYABLE",
            "creative_url": "https://playable.dspunion.com/playable_test/dsp_zh-cn_98_VFNZYl667_an/dsp_zh-cn_98_VFNZYl667_an.html"
          },
          {
            "creative_id": 2705156616,
            "creative_name": "6699150e1321a.mp4",
            "creative_md5": "05e23f9241f9abb0742f646f8c16da35",
            "creative_type": "VIDEO",
            "creative_url": "http://cdn-adn.rayjump.com/cdn-adn/v2/portal/24/07/19/11/20/6699db7883bd7.mp4"
          }
        ]
      }
    ]
  }
}

Algogear OpenAPI 文档