接口文档SDK业务专题开发者工具

获取图片信息
全部接口
V1.1
loading

所属权限 Ads Management,Account Management
请求地址 images/get
请求方法 get

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 4
field*
string 过滤字段
可选值:{ image_signature, image_id, image_width, image_height, created_time, last_modified_time, source_type, product_catalog_id, product_outer_id, owner_account_id, status, image_description, sample_aspect_ratio }
operator*
enum 操作符
当 field 取值 product_catalog_id 时,枚举列表:{ EQUALS }
当 field 取值 product_outer_id 时,枚举列表:{ EQUALS }
当 field 取值 image_signature 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 image_id 时,枚举列表:{ EQUALS, CONTAINS, IN }
当 field 取值 image_width 时,枚举列表:{ EQUALS }
当 field 取值 image_height 时,枚举列表:{ EQUALS }
当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 last_modified_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 source_type 时,枚举列表:{ EQUALS }
当 field 取值 owner_account_id 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 status 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 image_description 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 sample_aspect_ratio 时,枚举列表:{ EQUALS, CONTAINS }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]
当 field 取值 image_signature 时,
字段长度最小 1 字节,长度最大 32 字节

当 field 取值 image_id 且 operator 取值 IN 时,
字段长度最小 1 字节,长度最大 48 字节

当 field 取值 image_id 时,
字段长度最小 1 字节,长度最大 48 字节

当 field 取值 image_width 时,
最小值 0,最大值 2000

当 field 取值 image_height 时,
最小值 0,最大值 2000

当 field 取值 created_time 时,
字段长度为 10 字节

当 field 取值 last_modified_time 时,
字段长度为 10 字节

当 field 取值 source_type 时,
枚举列表:{ SOURCE_TYPE_LOCAL, SOURCE_TYPE_MUSE, SOURCE_TYPE_API, SOURCE_TYPE_QUICK_DRAW, SOURCE_TYPE_VIDEO_SNAPSHOTS, SOURCE_TYPE_TCC, SOURCE_TYPE_AIGC }

当 field 取值 owner_account_id 时,
字段长度为 10 字节

当 field 取值 sample_aspect_ratio 时,
字段长度为 10 字节

当 field 取值 status 时,
枚举列表:{ ADSTATUS_NORMAL, ADSTATUS_DELETED }

当 field 取值 image_description 时,
字段长度最小 1 字节,长度最大 256 字节
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10。最小值 1,最大值 100

请求示例


curl -G 'https://api.e.qq.com/v1.1/images/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"image_width","operator":"EQUALS","values":[160]}]' \
-d 'page=1' \
-d 'page_size=10' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
image_id
int64 图片 id
width
integer 图片宽度,单位 px
height
integer 图片高度,单位 px
file_size
integer 图片大小 单位 B(byte)
type
enum 图片类型,[枚举详情]
signature
string 图片文件签名,使用图片文件的 md5 值,用于检查上传图片文件的完整性
description
string 图片文件描述,不支持@等特殊符号
source_signature
string 图片源文件签名,为图片经过裁剪前源文件的 md5 值,若该文件没有经过裁剪,source_signature 为空
preview_url
string 预览地址
source_type
enum 图片来源,[枚举详情]
image_usage
enum 图片用途,[枚举详情]
created_time
integer 创建时间(时间戳)
last_modified_time
integer 最后修改时间(时间戳)
product_catalog_id
integer 商品库 id
product_outer_id
string 商品 id
source_reference_id
string 素材来源关联 id,和素材来源相关
owner_account_id
string 素材拥有者 id
status
enum 图片状态,[枚举详情]
sample_aspect_ratio
string 图片宽高比
默认值:宽高比
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "image_id": "<IMAGE_ID>",
                "width": 160,
                "height": 210,
                "file_size": 10280,
                "type": "TYPE_JPG",
                "signature": "f4c8a3bc4deb305fb74cb08ed395b98c",
                "source_signature": "83a447d55c02dd4efe8776e369915eb7",
                "preview_url": "https://example.com/example.jpg",
                "created_time": 1491019858,
                "last_modified_time": 1491098468
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具