友米聚合 - 开放API
  1. Ad
友米聚合 - 开放API
  • 应用场景
    • 自有订单系统 嵌入 企客聊侧边栏
  • v1
    • 文档
      • 介绍
        • 开发文档阅读说明
        • 错误码返回说明
      • 入门说明
        • 生成signature
        • 获取TOKEN方法
        • 请求Headers说明
      • 接口详情
        • 基础数据类接口
        • 数据读取类接口
        • 行为操作类接口
        • 回调数据
  • v2
    • 事件发布格式说明
    • ChatMess
      • 发送消息
      • 申请接管
      • 终止接管
      • 激活会话
      • 发送通知
      • 读取聊天记录
    • Report
      • 获取员工客服统计
      • 获取员工激活客户数统计
    • System
      • 获取部门列表
      • 根据部门获得组
      • 根据组获得员工
      • 获得员工列表
    • Friend
      • 读取粉丝列表
      • 读取粉丝总数
    • Todo
      • 新增待办记录
      • 新增待办记录(返回编号)
      • 获取待办列表
      • 获取待办列表总数
    • Ad
      • 读取广告列表
        POST
      • 读取广告条数
        POST
    • BulkSend
      • 保存RPA群发
      • 删除RPA群发
    • 注册回调地址
      POST
    • 订阅事件
      POST
    • 获取商户TOKEN
      POST
  1. Ad

读取广告列表

POST
/v2/AdManage/GetAdList

请求参数

Header 参数
Authorization
可选
授权TOKEN,Bearer
TenantId
可选
租户ID,仅限代理商使用
Body 参数application/json
object  | null 
可选
code
string 
广告编号
可选
广告编号
name
string 
广告名称
必需
广告名称
minCosts
number 
最小投入费用
可选
大于该费用
maxCosts
integer 
最大投入费用
可选
小于该费用
startTime
string 
广告开始时间
可选
广告开始时间 yyyy-MM-dd HH:mm:ss
endTime
string 
广告结束时间
可选
广告结束时间 yyyy-MM-dd HH:mm:ss
state
integer 
广告状态
可选
默认-1;0=下线、1=上线
buildType
integer 
创建来源
可选
默认-1;0=自建、1=企客宝
pageIndex
integer 
页码
必需
1
pageSize
integer 
单页条数
必需
10
示例
{
  "code": "string",
  "name": "string",
  "minCosts": 0,
  "maxCosts": 0,
  "startTime": "string",
  "endTime": "string",
  "state": 0,
  "buildType": 0,
  "pageIndex": 0,
  "pageSize": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/AdManage/GetAdList' \
--header 'Authorization;' \
--header 'TenantId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "string",
    "name": "string",
    "minCosts": 0,
    "maxCosts": 0,
    "startTime": "string",
    "endTime": "string",
    "state": 0,
    "buildType": 0,
    "pageIndex": 0,
    "pageSize": 0
}'

返回响应

🟢200Success
application/json
Body
requestId
string 
必需
errmsg
integer 
必需
succeed
boolean 
必需
msgTime
string 
必需
errdesc
null 
必需
values
array [object {21}] 
必需
ad_manage_name
string 
广告名称
必需
ad_manage_url
null 
广告URL
必需
ad_brand_id
integer 
品牌ID
必需
ad_ditch_id
integer 
媒体ID
必需
ad_manage_bintime
string 
推广开始时间
必需
ad_manage_endtime
string 
推广结束时间
必需
ad_manage_myen
integer 
推广费用
必需
ad_manage_unit_price
integer 
推广单价
必需
ad_manage_sate
integer 
广告状态
必需
ad_manage_city
null 
可显示城市
必需
ad_manage_time
string 
添加时间
必需
merchantid
null 
所属商家
必需
ad_manage_type
integer 
广告类型
必需
ad_manage_language
null 
活码链接引导语
必需
ad_manage_voice
null 
活码链接语音链接
必需
qv_config_id
null 
二维码id
必需
qv_qr_code
string  | null 
企微二维码
必需
ad_build_type
integer 
创建类型
必需
ad_report_key
null 
上报KEY
必需
ad_report_moment
integer 
上报时机
必需
ad_manage_code
string 
广告编号
必需
示例
{
  "requestId": "string",
  "errmsg": 0,
  "succeed": true,
  "msgTime": "string",
  "errdesc": null,
  "values": [
    {
      "ad_manage_name": "string",
      "ad_manage_url": null,
      "ad_brand_id": 0,
      "ad_ditch_id": 0,
      "ad_manage_bintime": "string",
      "ad_manage_endtime": "string",
      "ad_manage_myen": 0,
      "ad_manage_unit_price": 0,
      "ad_manage_sate": 0,
      "ad_manage_city": null,
      "ad_manage_time": "string",
      "merchantid": null,
      "ad_manage_type": 0,
      "ad_manage_language": null,
      "ad_manage_voice": null,
      "qv_config_id": null,
      "qv_qr_code": "string",
      "ad_build_type": 0,
      "ad_report_key": null,
      "ad_report_moment": 0,
      "ad_manage_code": "string"
    }
  ]
}
上一页
获取待办列表总数
下一页
读取广告条数
Built with