index.d.ts 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790
  1. import { PromotedObjectType } from './enum';
  2. /**==============================================================================广告=======================================================================================*/
  3. /**推广目标类型*/
  4. export interface SysPromotedObjectDTO {
  5. promotedObjectType: PromotedObjectType;
  6. }
  7. /**oCPC/oCPM 优化转化行为配置*/
  8. export interface DeepConversionBehaviorSpec {
  9. goal: string;
  10. bidAmount: number;
  11. }
  12. /**oCPC/oCPM 优化 ROI 配置*/
  13. export interface DeepConversionWorthSpec {
  14. goal: string;
  15. expectedRoi: number;
  16. }
  17. /**oCPC/oCPM 强化 ROI 配置*/
  18. export interface DeepConversionWorthAdvancedSpec {
  19. goal: string;
  20. expectedRoi: number;
  21. }
  22. /**oCPC/oCPM 深度优化内容*/
  23. export interface DeepConversionSpec {
  24. deepConversionType: string;
  25. deepConversionBehaviorSpec: DeepConversionBehaviorSpec;
  26. deepConversionWorthSpec: DeepConversionWorthSpec;
  27. deepConversionWorthAdvancedSpec: DeepConversionWorthAdvancedSpec;
  28. }
  29. /**分版位组合出价系数设置*/
  30. export interface SiteSetPackageStruct {
  31. siteSet: Array<string>;
  32. bidCoefficient: number;
  33. deepBidCoefficient: number;
  34. }
  35. /**分城市组合出价系数设置*/
  36. export interface RegionGroupPackageStruct {
  37. regionList: Array<number>;
  38. bidCoefficient: number;
  39. deepBidCoefficient: number;
  40. }
  41. /**出价系数设置内容*/
  42. export interface BidAdjustment {
  43. siteSetPackage: Array<SiteSetPackageStruct>;
  44. regionGroupPackage: Array<RegionGroupPackageStruct>;
  45. }
  46. /**年龄定向范围*/
  47. export interface AgeStruct {
  48. min: number;
  49. max: number;
  50. }
  51. /**排除已转化用户定向*/
  52. export interface ExcludedConvertedAudience {
  53. excludedDimension: string;
  54. conversionBehaviorList: Array<string>;
  55. }
  56. /**智能定向 —— 不可突破定向详细设置*/
  57. export interface UnbreakableTargetingSetting {
  58. age: Array<AgeStruct>;
  59. gender: Array<string>;
  60. geoLocation: GeoLocations;
  61. userOs: Array<string>;
  62. appInstallStatus: Array<string>;
  63. excludedConvertedAudience: ExcludedConvertedAudience;
  64. }
  65. /**智能定向功能,功能灰度开放,如需使用可联系您的运营接口同学。*/
  66. export interface SmartTargeting {
  67. smartTargetingVersion: number;
  68. smartTargetingSwitch: Boolean;
  69. startAudience: Array<number>;
  70. unbreakableTargeting: UnbreakableTargetingSetting;
  71. }
  72. /**广告参数*/
  73. export interface SysAdgroupsDTO {
  74. adgroupName: string; //广告名称
  75. promotedObjectType: string; //推广目标类型
  76. beginDate: Date; //开始投放日期
  77. firstDayBeginTime: string; //首日开始投放时间
  78. endDate: Date; //结束投放日期
  79. billingEvent: string; //计费类型
  80. bidAmount: number; //广告出价
  81. optimizationGoal: string; // 广告优化目标类型
  82. timeSeries: string; //投放时间段
  83. automaticSiteEnabled: boolean; //是否开启自动版位功能
  84. siteSet: Set<string>; //投放版位集合
  85. dailyBudget: number; //广告组日预算
  86. sysPromotedObjectId: number; //推广目标 id
  87. sysPromotedObject: SysPromotedObjectDTO; //推广目标类型
  88. appAndroidChannelPackageId: number; //安卓应用渠道包 id
  89. sysTargetingId: number; // 定向 id,仅非朋友圈广告有效
  90. sysTargeting: SysTargetingDTO; //定向详细设置,存放所有定向条件
  91. sceneSpec: SceneTargetingForWrite; //场景定向
  92. flowOptimizationEnabled: boolean; //是否使用智能场景匹配
  93. configuredStatus: string; //客户设置的状态
  94. customizedCategory: string; //自定义分类
  95. dynamicAdSpec: DynamicAdSpec; //动态商品广告属性
  96. userActionSets: Array<UserActionSetStruct>; //用户行为数据源
  97. additionalUserActionSets: Array<UserActionSetStruct>;
  98. bidStrategy: string; //出价策略
  99. coldStartAudience: Array<number>; //扩量种子人群
  100. autoAudience: boolean; //是否使用系统优选
  101. expandEnabled: boolean; //是否使用自动扩量
  102. expandTargeting: Array<string>; //扩量不可突破定向
  103. deepConversionSpec: DeepConversionSpec; //oCPC/oCPM 深度优化内容
  104. deepOptimizationActionType: string; //oCPC/oCPM 深度优化方式配置
  105. poiList: Array<string>; //门店 id 列表
  106. conversionId: number; //转化 id
  107. deepConversionBehaviorBid: number; //深度优化行为的出价
  108. deepConversionWorthRate: BigDecimal; //深度优化价值的期望 ROI
  109. deepConversionWorthAdvancedRate: BigDecimal; //强化优化价值的期望 ROI
  110. bidMode: string; //出价方式
  111. bidAdjustment: BidAdjustment; //出价系数设置内容
  112. autoAcquisitionEnabled: boolean; //是否开启一键起量
  113. autoAcquisitionBudget: number; //一键起量探索预算
  114. creativeDisplayType: string; //创意展示类型
  115. autoDerivedCreativeEnabled: boolean; //是否开启自动衍生视频创意
  116. smartBidType: string; //出价类型
  117. marketingScene: string; //营销目标
  118. customAdgroupTag: Array<string>; //广告标签
  119. smartTargeting: SmartTargeting; //智能定向功能,功能灰度开放,如需使用可联系您的运营接口同学。
  120. }
  121. /**==============================================================================创意=======================================================================================*/
  122. export interface AdcreativeCreativeElementsMp {
  123. image: string; //图片
  124. image2: string; //图片
  125. image3: string;
  126. title: string;
  127. description: string;
  128. corporate: AdcreativeCorporate;
  129. video: string;
  130. deepLinkType: string;
  131. linkNameType: LinkNameType;
  132. imageList: Array<string>;
  133. elementStory: Array<AdcreativeElementStoryArrayItem>;
  134. url: string;
  135. buttonText: string;
  136. bottomText: string;
  137. excitationText: string;
  138. countdownBegin: number;
  139. countdownExpiringTimestamp: number;
  140. countdownPrice: string;
  141. countdownTimeType: AdCreativeCountdownTimeType;
  142. label: Array<CreativeLabel>;
  143. productTags: Array<string>;
  144. logoDescription: string;
  145. logo: string;
  146. leftBottomTxt: string;
  147. animationEffect: string;
  148. phone: string;
  149. shortVideoStruct: ShortVideoStruct;
  150. longVideoStruct: numberVideoStruct;
  151. bannerContent: AdcreativeBannerContent;
  152. cardContent: AdcreativeCardContent;
  153. videoPopupButton: AdcreativeVideoPopupButton;
  154. buttonUrl: string;
  155. brand: AdCreativeBrand;
  156. caption: string;
  157. labelledImg: AdcreativeLabelledImg;
  158. fullScreenImage: string;
  159. zipUrl: string;
  160. endPage: AdCreativeEndPage; //视频结束页
  161. headLine: string;
  162. shopImageStruct: AdCreativeShopImageStruct;
  163. chosenButton: ChosenButton;
  164. livingDescStruct: AdCreativeLivingDescStruct;
  165. leftButton: string;
  166. rightButton: string;
  167. leftCanvas: string;
  168. rightCanvas: string;
  169. floatingZoneStruct: FloatingZone;
  170. canvasShareImage: string;
  171. wegameInfoSpec: WegameInfoSpec;
  172. }
  173. export interface AdcreativeElementStoryArrayItem {
  174. image: string;
  175. image2: string;
  176. description: string;
  177. url: string;
  178. title: string;
  179. }
  180. export interface CreativeLabel {
  181. content: string;
  182. type: LabelType;
  183. }
  184. export interface ShortVideoStruct {
  185. shortVideo1: number;
  186. shortVideo2: number;
  187. }
  188. export interface numberVideoStruct {
  189. longVideo1: number;
  190. longVideo2: number;
  191. }
  192. export interface AdcreativeBannerContent {
  193. image: string;
  194. title: string;
  195. url: string;
  196. }
  197. export interface AdcreativeCardContent {
  198. image: string;
  199. description: string;
  200. url: string;
  201. }
  202. export interface AdcreativeVideoPopupButton {
  203. videoPopupButtonText: string;
  204. videoPopupButtonUrl: string;
  205. }
  206. export interface AdCreativeBrand {
  207. brandName: string;
  208. brandImg: string;
  209. brandDescription: string;
  210. }
  211. export interface AdcreativeLabelledImg {
  212. image: string;
  213. label: Array<AdcreativeLabel>;
  214. }
  215. export interface AdCreativeEndPage {
  216. endPageType: string;
  217. endPageDesc: string;
  218. }
  219. export interface AdCreativeShopImageStruct {
  220. shopImageSwitch: boolean;
  221. dynamicShopImageSwitch: boolean;
  222. shopImageId: string;
  223. shopImageTitle: string;
  224. shopImageDescription: string;
  225. }
  226. export interface ChosenButton {
  227. chosenButtonText1: string;
  228. chosenButtonLandingPage1: LandingPageStructure;
  229. chosenButtonText2: string;
  230. chosenButtonLandingPage2: LandingPageStructure;
  231. }
  232. export interface AdCreativeLivingDescStruct {
  233. livingDescStructSwitch: boolean;
  234. livingDescList: Array<string>;
  235. }
  236. export interface FloatingZone {
  237. floatingZoneSwitch: boolean;
  238. floatingZoneImageId: string;
  239. floatingZoneName: string;
  240. floatingZoneDesc: string;
  241. floatingZoneButtonText: string;
  242. floatingZoneType: FloatingZoneType;
  243. floatingZoneSingleImageId: string;
  244. }
  245. export interface WegameInfoSpec {
  246. wegameInfoSwitch: boolean;
  247. }
  248. /**落地页信息,根据不同 promotedObjectType 和 page_type,要求的 page_spec 信息不同*/
  249. export interface PageSpec {
  250. pageId: number; //落地页 id
  251. pageUrl: string; //落地页 url
  252. miniProgramSpec: {
  253. //小程序落地页,mini_program_id 和 mini_program_path 要同时填写
  254. miniProgramId: string; //小程序 id
  255. miniProgramPath?: string; //小程序路径
  256. miniProgramPaths?: string[]; //小程序落地页 path 列表
  257. };
  258. miniGameSpec: {
  259. miniGameTrackingParameter: string; //小游戏监控参数,需以英文字符?开头
  260. miniGameOpenlink: string; //openlink 地址字段
  261. };
  262. overrideCanvasHeadOption: string; //原生推广页顶部素材和广告创意素材之间的替换关系,
  263. dynamicProductSpec: {
  264. pageUrl: string; //动态落地页 url
  265. miniProgramPaths: string[]; //动态多商品广告小程序落地页 path 列表
  266. miniGameOpenlinkPageSpec: {
  267. //小游戏蹊径落地页,当投放版位含优量汇时、推广目标是微信小游戏推广目标时
  268. landingPageType: string; //openlink 落地页页面类型,不大于 1024 个英文字符或数字
  269. landingPageId: number; //落地页 id
  270. };
  271. };
  272. }
  273. /**文字链跳转信息,根据不同 promotedObjectType 和 page_type、link_page_type,要求的 link_page_spec 信息不同*/
  274. export interface LinkPageSpec {
  275. pageId: number; // 落地页 id
  276. pageUrl: string; //落地页 url
  277. miniProgramSpec: {
  278. //小程序落地页,mini_program_id 和 mini_program_path 要同时填写
  279. miniProgramId: string; //小程序 id
  280. miniProgramPath?: string; //小程序路径
  281. miniProgramPaths?: string[]; //小程序落地页 path 列表
  282. };
  283. miniGameSpec: {
  284. //小游戏落地页信息
  285. miniGameTrackingParameter: string; //小游戏监控参数,需以英文字符?开头
  286. };
  287. }
  288. /**简版原生页分享信息*/
  289. export interface ShareContentSpec {
  290. shareTitle: string; //简版原生页分享标题,字段长度最小 1 个等宽字符,长度最大 14 个等宽字符(即字段最大长度为 14 个中文字或全角标点,28 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
  291. shareDescription: string; //简版原生页分享描述,字段长度最小 1 个等宽字符,长度最大 20 个等宽字符(即字段最大长度为 20 个中文字或全角标点,40 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
  292. }
  293. /**动态商品广告属性,当创意为动态商品广告创意时,该字段必填*/
  294. export interface DynamicAdcreativeSpec {
  295. productCatalogId: number; //商品库 id
  296. productMode: AdNum; //动态商品广告(DPA)类型
  297. productSource: string; //动态商品广告所使用的商品信息,可以填入商品系列 id 或者商品 id
  298. productExposureQuantityMode: string; //动态商品广告推荐的商品数量模式,当广告形态为动态多商品广告时该字段必填
  299. landingPageUrlType: string; //MDPA 落地页类型,当创意为动态多商品广告创意时,该字段必填
  300. }
  301. /** 视频播放结束页,(当前仅支持互动推广页)*/
  302. export interface VideoEndPageSpec {
  303. endPageId: string; //视频播放结束页 id
  304. endPageType: string; //视频播放结束页类型
  305. }
  306. /**浮层卡片创意内容*/
  307. export interface FloatingZone {
  308. floatingZoneSwitch: boolean; //浮层卡片开关
  309. floatingZoneImageId: string; //尺寸:512*512,大小:不超过 50 KB,格式:*.jpg|*.jpeg|*.png ;
  310. floatingZoneName: string; //文案一,字段长度最小 1 个等宽字符,长度最大 8 等宽字符(即字段最大长度为 8 个中文字或全角标点,16 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
  311. floatingZoneDesc: string; //文案二,字段长度最小 0 个等宽字符,长度最大 6 等宽字符(即字段最大长度为 6 个中文字或全角标点,12 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
  312. floatingZoneButtonText: string; //按钮文案,字段长度最小 0 个等宽字符,长度最大 4 等宽字符(即字段最大长度为 4 个中文字或全角标点,8 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
  313. floatingZoneType: string; //浮层卡片类型
  314. floatingZoneSingleImageId: string; //尺寸: 540*276 ,大小:不超过 50 KB,格式:*.jpg|*.jpeg|*.png ;
  315. }
  316. /**头像点击跳转信息*/
  317. export interface HeadClickSpec {
  318. brandAppId: string; //搜一搜品牌形象 app id
  319. }
  320. /**弹幕列表*/
  321. export interface BarrageListCreateStruct {
  322. id: number; //弹幕 id
  323. }
  324. /** 礼包码,微信朋友圈广告创意形式*/
  325. export interface AppGiftPackCode {
  326. code: string; //礼包码,微信朋友圈广告创意形式需要填写,礼包码
  327. tips: string; //礼包码提示,微信朋友圈广告创意形式需要填写,礼包码提示
  328. }
  329. /** 厂商下载信息*/
  330. export interface UnionMarketSpec {
  331. unionMarketJumpType: string; //厂商直达链接跳转类型
  332. }
  333. /**安卓快应用跳转信息*/
  334. export interface AndroidQuickAppSpec {
  335. androidQuickAppJumpType: string; //安卓快应用跳转类型
  336. androidQuickAppJumpUrl: string; //安卓快应用跳转 URL
  337. }
  338. /**创意参数*/
  339. export interface SysAdcreative {
  340. adcreativeName: string; //广告创意名称 *
  341. adcreativeTemplateId: number; //创意形式 id *
  342. adcreativeElements: AdcreativeCreativeElementsMp; //创意元素,不同 adcreativeTemplateId 要求的元素不尽相同 *
  343. promotedObjectType: string; //推广目标类型 *
  344. pageType: string; //落地页类型 *
  345. automaticSiteEnabled: boolean; //是否开启自动版位功能(暂不包含 SITE_SET_WECHAT 和 SITE_SET_MOMENTS),此字段与 siteSet 字段至少需要写入一个。
  346. siteSet: Array<string>; //投放版位集合
  347. pageSpec: PageSpec; //落地页信息
  348. linkPageType: string; //文字链跳转类型类型
  349. linkNameType: string; //链接名称类型
  350. linkPageSpec: LinkPageSpec; //文字链跳转信息
  351. conversionDataType: string; //投放指引,数据展示的数据类型,素材下方展示账户内积累的展示推广目标相关的转化数据,吸引用户点击。
  352. conversionTargetType: string; //数据展示转化行为,仅 conversion_data_type 为 CONVERSION_DATA_ADMETRIC 时可设置
  353. qqMiniGameTrackingQuerystring: string; //QQ 小游戏监控参数
  354. deepLinkUrl: string; //应用直达页 URL,微信朋友圈广告
  355. androidDeepLinkAppId: string; //安卓应用直达 AppId
  356. iosDeepLinkAppId: string; //IOS 应用直达 AppId
  357. universalLinkUrl: string; //通用链接页 URL
  358. promotedObjectId: string; //推广目标 id
  359. profileId: number; //朋友圈头像昵称跳转页 id
  360. shareContentSpec: ShareContentSpec; //简版原生页分享信息
  361. dynamicAdcreativeSpec: DynamicAdcreativeSpec; //动态商品广告属性
  362. componentId: number; //附加创意组件 id
  363. unionMarketSwitch: boolean; //跳转厂商应用商店
  364. playablePageMaterialId: string; //互动推广页落地页 id
  365. videoEndPage: VideoEndPageSpec; //视频播放结束页,(当前仅支持互动推广页)
  366. feedsVideoCommentSwitch: boolean; //视频广告评论开关
  367. webviewUrl: string; //简易原生页嵌入 Webview url,和 simple_canvas_sub_type 配合使用
  368. simpleCanvasSubType: string; //简版原生页子类型(灰度中),仅在简版原生页下生效,其他情况改字段内容会被忽略
  369. floatingZone: FloatingZone; //浮层卡片创意内容
  370. marketingPendantImageId: number; //挂件图,悬浮展示在竖版视频上以展示营销卖点
  371. countdownSwitch: boolean; //倒计时组件开关
  372. headClickType: string; //头像点击跳转信息
  373. headClickSpec: HeadClickSpec; //头像点击跳转信息
  374. pageTrackUrl: string; //页面级转化跟踪 URL(可选)
  375. barrageList: Array<BarrageListCreateStruct>; //弹幕列表
  376. appGiftPackCode: AppGiftPackCode; //礼包码,微信朋友圈广告创意形式需要填写,礼包码
  377. enableBreakthroughSiteset: boolean; //是否支持版位突破,广告版位选择“微信朋友圈”,当广告有机会获得更多曝光与转化时,将可能投放到微信公众号与小程序版位,若不传值默认为 true
  378. industryLabel: string; //行业标签内容
  379. unionMarketSpec: UnionMarketSpec; //厂商下载信息,厂商下载信息,仅可在跳转厂商应用商店(union_market_switch)值为 true 时使用。
  380. androidQuickAppSpec: AndroidQuickAppSpec; // 安卓快应用跳转信息
  381. }
  382. /**==============================================================================定向参数=======================================================================================*/
  383. export interface SysTargeting {
  384. targetingName: string; //定向名称
  385. targeting: WriteTargetingSetting; //定向详细设置,存放所有定向条件
  386. description: string; //定向描述
  387. }
  388. export interface WriteTargetingSetting {
  389. age: Array<AgeStruct>; //年龄定向
  390. gender: Array<string>; //性别定向
  391. education: Array<string>; //用户学历
  392. maritalStatus: Array<string>; //婚恋育儿状态
  393. geoLocation: GeoLocations; //地理位置定向,针对朋友圈广告(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS)地域必填,非朋友圈广告选填
  394. userOs: Array<string>; //操作系统定向, 该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
  395. devicePrice: Array<string>; //设备价格定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
  396. deviceBrandModel: DeviceBrandModel; //设备品牌型号定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
  397. networkType: Array<string>; //联网方式定向
  398. networkOperator: Array<string>; //移动运营商定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
  399. appInstallStatus: Array<string>; //应用安装(应用用户
  400. consumptionStatus: Array<string>; //消费水平
  401. gameConsumptionLevel: Array<string>; //游戏消费能力
  402. financialSituation: Array<string>; //财产状态,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
  403. wechatAdBehavior: WechatAdBehavior; //微信再营销,原微信广告行为定向升级为微信再营销,当且仅当投放微信流量
  404. customAudience: Array<number>; //自定义定向用户群
  405. excludedCustomAudience: Array<number>; //自定义排除用户群
  406. behaviorOrInterest: BehaviorOrInterest; //行为兴趣意向定向,2022 年 6 月 30 日起,该定向将无法在竞价 oCPC、oCPM 场景使用
  407. excludedConvertedAudience: ExcludedConvertedAudience; //排除已转化用户定向同应用,仅当推广目标为应用下载时可以使用,没有选择自定义转化行为(excluded_dimension)时,使用该定向出价需要满足是 oCPC、oCPM 广告;同商品,仅当 SDPA 商品广告下使用,不支持自定义转化行为默认排除已下单、和已付费用户,不限制出价方式;非同应用、非同商品,没有选择自定义转化行为(excluded_dimension)时,使用该定向出价需要满足是 oCPC、oCPM 广告;
  408. }
  409. export interface AgeStruct {
  410. min: number;
  411. max: number;
  412. }
  413. export interface GeoLocations {
  414. locationTypes: Array<string>; //对于微信流量(site_set=SITE_SET_WECHAT、SITE_SET_MOMENTS、SITE_SET_MINI_GAME_WECHAT),仅能选择"LIVE_IN"(常住);
  415. regions: Array<number>; //省市区县列表,当投放微信流量(site_set=SITE_SET_WECHAT、SITE_SET_MOMENTS、SITE_SET_MINI_GAME_WECHAT)时,仅支持中国大陆(不包含港澳台)地域 id
  416. businessDistricts: Array<number>;
  417. customLocations: Array<CustomLocationsItemWithName>;
  418. }
  419. export interface CustomLocationsItemWithName {
  420. longitude: Double;
  421. latitude: Double;
  422. radius: number;
  423. }
  424. export interface DeviceBrandModel {
  425. includedList: Array<number>;
  426. excludedList: Array<number>;
  427. }
  428. export interface WechatAdBehavior {
  429. actions: Array<string>;
  430. excludedActions: Array<string>;
  431. }
  432. export interface BehaviorOrInterest {
  433. interest: Interest;
  434. behavior: Array<BehaviorStruct>;
  435. intention: Intention;
  436. }
  437. export interface ExcludedConvertedAudience {
  438. excludedDimension: string; //排除已转化用户定向范围
  439. conversionBehaviorList: Array<string>; //自定义转化行为
  440. }
  441. /**==============================================================================列表接口=======================================================================================*/
  442. /**列表接口返回数据*/
  443. export interface ListData<T> {
  444. countId: number;
  445. current: number;
  446. maxLimit: any;
  447. optimizeCountSql: boolean;
  448. orders: any[];
  449. pages: number;
  450. records: T[];
  451. searchCount: boolean;
  452. size: number;
  453. total: number;
  454. }
  455. /**==============================================================================创意形式=======================================================================================*/
  456. /**创意形式列表*/
  457. export interface AdcreativeTemplateList {
  458. /**创意形式 id*/
  459. adcreativeTemplateId: number;
  460. /**创意形式类型*/
  461. adcreativeTemplateStyle: string;
  462. /**创意形式名称*/
  463. adcreativeTemplateAppellation: string;
  464. /**创意规格示意图链接*/
  465. adcreativeSampleImage: string;
  466. /**推广目标类型*/
  467. promotedObjectType: string;
  468. /**投放版位集合*/
  469. siteSet: string[];
  470. /**支持的计费信息*/
  471. supportBillingSpecList: {
  472. /**计费方式*/
  473. billingEvent: string;
  474. /**最低出价,单位分*/
  475. minPrice: number;
  476. /**最高出价,单位分*/
  477. maxPrice: number;
  478. }[];
  479. /**支持的出价方式*/
  480. supportBidModeList: string[];
  481. }
  482. /**创意形式详情*/
  483. export interface AdcreativeTemplate {
  484. /**创意形式 id*/
  485. adcreativeTemplateId: number;
  486. /**创意形式类型*/
  487. adcreativeTemplateStyle: string;
  488. /**创意形式名称*/
  489. adcreativeTemplateAppellation: string;
  490. /**创意规格示意图链接*/
  491. adcreativeSampleImage: string;
  492. /**推广目标类型*/
  493. promotedObjectType: string;
  494. /**投放版位集合*/
  495. siteSet: string[];
  496. /**支持的计费信息*/
  497. supportBillingSpecList: {
  498. /**计费方式*/
  499. billingEvent: string;
  500. /**最低出价,单位分*/
  501. minPrice: number;
  502. /**最高出价,单位分*/
  503. maxPrice: number;
  504. }[];
  505. /**支持的出价方式*/
  506. supportBidModeList: string[];
  507. /**广告创意元素列表*/
  508. adcreativeElements: {
  509. /**广告创意接口要求的 adcreativeElements 结构中的元素字段名,如 image、title 等*/
  510. name: string;
  511. /**创意元素类型*/
  512. elementType: string;
  513. /**创意元素传参类型*/
  514. fieldType: string;
  515. /**创意元素是否必填,true 或 false*/
  516. required: boolean;
  517. /**该创意元素的描述,如图片、广告文案等*/
  518. description: string;
  519. /**创意元素父节点名称,为父节点的 name 字段*/
  520. parentName: string;
  521. /**广告创意元素枚举值特性*/
  522. enumProperty: {
  523. /**创意元素枚举默认值*/
  524. default: string;
  525. /**创意元素枚举可选值数组*/
  526. enumeration: {
  527. /**创意元素枚举可选值*/
  528. value: string;
  529. /**创意元素枚举可选值描述*/
  530. description: string;
  531. }[];
  532. };
  533. /**广告创意元素数组特性*/
  534. arrayProperty: {
  535. /**广告创意元素数组个数最小值*/
  536. minNumber: number;
  537. /**广告创意元素数组个数最大值*/
  538. maxNumber: number;
  539. };
  540. /**广告创意元素结构体特性*/
  541. struct_property: {
  542. /**结构体中元素是否互斥,true: 是,仅能使用结构体中的一个元素字段; false: 否*/
  543. elementMutualExclusive: boolean;
  544. };
  545. /** 广告创意元素需满足的限制条件*/
  546. restriction: {
  547. /**文本需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_TEXT 时返回*/
  548. textRestriction: {
  549. /**最小长度,文本类型适用*/
  550. minLength: number;
  551. /**最大长度,文本类型适用*/
  552. maxLength: number;
  553. /**text 的正则表达式*/
  554. textPattern: RegExp;
  555. };
  556. /**图片需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_IMAGE_ARRAY 或 ELEMENT_TYPE_IMAGE 时返回*/
  557. imageRestriction: {
  558. /** 宽度,单位 px,图片适用*/
  559. width: number;
  560. /**高度,单位 px,图片适用*/
  561. height: number;
  562. /**支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用*/
  563. fileSize: number;
  564. /**支持的图片文件格式数组*/
  565. fileFormat: string[];
  566. };
  567. /**链接需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_URL 时返回*/
  568. urlRestriction: {
  569. /**url 的正则表达式*/
  570. urlPattern: RegExp;
  571. };
  572. /** 视频需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_VIDEO 时返回*/
  573. videoRestriction: {
  574. /**宽度*/
  575. width: number;
  576. /**高度*/
  577. height: number;
  578. /**最小宽度*/
  579. minWidth: number;
  580. /**最小高度*/
  581. minHeight: number;
  582. /**宽比例*/
  583. ratioWidth: number;
  584. /**高比例*/
  585. ratioHeight: number;
  586. /**支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用*/
  587. fileSize: number;
  588. /**支持的流媒体文件格式数组*/
  589. fileFormat: string[];
  590. /**最小时长*/
  591. minDuration: number;
  592. /**最大时长*/
  593. maxDuration: number;
  594. };
  595. /**数值型需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_INTEGER 时返回*/
  596. numberRestriction: {
  597. /**最小长度*/
  598. min: number;
  599. /**最大长度*/
  600. max: number;
  601. };
  602. };
  603. }[];
  604. /**支持的落地页类型*/
  605. landingPageConfig: {
  606. /**是否必填*/
  607. required: boolean;
  608. /**支持落地页类型列表*/
  609. supportPageTypeList: {
  610. /**名称*/
  611. pageType: string;
  612. /**描述*/
  613. description: string;
  614. /**文字链跳转类型*/
  615. supportLinkNameType: {
  616. /**是否必填*/
  617. required: boolean;
  618. /**文字链跳转类型列表*/
  619. list: {
  620. /**名称*/
  621. linkNameType: string;
  622. /**描述*/
  623. description: string;
  624. }[];
  625. };
  626. /**文字链支持落地页类型*/
  627. supportLinkPageType: {
  628. /**是否必填*/
  629. required: boolean;
  630. /**文字链跳转类型列表*/
  631. list: {
  632. /**名称*/
  633. linkNameType: string;
  634. /**描述*/
  635. description: string;
  636. }[];
  637. };
  638. }[];
  639. };
  640. /**广告创意能力项列表*/
  641. adcreativeAttributes: {
  642. /**是否必填*/
  643. required: boolean;
  644. /**广告创意接口要求的 adcreativeElements 结构中的元素字段名,如 image、title 等*/
  645. name: string;
  646. /**该创意元素的描述,如图片、广告文案等*/
  647. description: string;
  648. /**创意元素传参类型*/
  649. fieldType: string;
  650. /**能力项详情*/
  651. propertyDetail: {
  652. /**文本需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_TEXT 时返回*/
  653. stringDetail: {
  654. /**最小长度,文本类型适用*/
  655. minLength: number;
  656. /**最大长度,文本类型适用*/
  657. maxLength: number;
  658. /**text 的正则表达式*/
  659. textPattern: RegExp;
  660. };
  661. /**数值型需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_INTEGER 时返回*/
  662. integerDetail: {
  663. /**最小长度,文本类型适用*/
  664. min: number;
  665. /**最大长度,文本类型适用*/
  666. max: number;
  667. };
  668. /**广告创意元素枚举值特性*/
  669. enumDetail: {
  670. /**创意元素枚举默认值*/
  671. default: string;
  672. /**创意元素枚举可选值数组*/
  673. enumeration: {
  674. /**创意元素枚举可选值*/
  675. value: string;
  676. /**创意元素枚举可选值描述*/
  677. description: string;
  678. }[];
  679. };
  680. /**广告创意能力项子节点列表*/
  681. structDetail: {
  682. /**广告创意能力项子节点列表*/
  683. elementList: {
  684. /**是否必填*/
  685. required: boolean;
  686. /**广告创意接口要求的 adcreativeElements 结构中的元素字段名,如 image、title 等*/
  687. name: string;
  688. /**该创意元素的描述,如图片、广告文案等*/
  689. description: string;
  690. /**创意元素传参类型*/
  691. fieldType: string;
  692. /**能力项详情*/
  693. propertyDetail: {
  694. /**文本需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_TEXT 时返回*/
  695. stringDetail: {
  696. /**最小长度,文本类型适用*/
  697. minLength: number;
  698. /**最大长度,文本类型适用*/
  699. maxLength: number;
  700. /**text 的正则表达式*/
  701. textPattern: RegExp;
  702. };
  703. /**数值型需满足的限制条件,仅当 elementType 是 ELEMENT_TYPE_INTEGER 时返回*/
  704. integerDetail: {
  705. /**最小长度,文本类型适用*/
  706. min: number;
  707. /**最大长度,文本类型适用*/
  708. max: number;
  709. };
  710. /**广告创意元素枚举值特性*/
  711. enumDetail: {
  712. /**创意元素枚举默认值*/
  713. default: string;
  714. /**创意元素枚举可选值数组*/
  715. enumeration: {
  716. /**创意元素枚举可选值*/
  717. value: string;
  718. /**创意元素枚举可选值描述*/
  719. description: string;
  720. }[];
  721. /**广告创意元素数组特性*/
  722. arrayRestriction: {
  723. /**广告创意元素数组个数最小值*/
  724. minNumber: number;
  725. /**广告创意元素数组个数最大值*/
  726. maxNumber: number;
  727. };
  728. };
  729. };
  730. }[];
  731. };
  732. };
  733. }[];
  734. /**动态广告支持情况*/
  735. supportDynamicAbilitySpecList: {
  736. /**动态广告投放能力类型*/
  737. dynamicAbilityType: string[];
  738. /**在该规格位置上单个广告上的创意可展示商品数量*/
  739. productItemDisplayQuantity: string[];
  740. };
  741. /**不支持播放的版位信息列表*/
  742. unsupportSitesetDetailSpec: {
  743. /**投放版位集合,当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合*/
  744. siteSet: string[];
  745. }[];
  746. /**不支持的出价方式*/
  747. unsupportBidModeList: {
  748. /**投放版位集合,当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合*/
  749. siteSet: string[];
  750. /**支持的出价方式*/
  751. bidModeList: string[];
  752. }[];
  753. /**不支持的计费信息*/
  754. unsupportBillingSpecList: {
  755. /**投放版位集合,当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合*/
  756. siteSet: string[];
  757. /**计费方式*/
  758. billingEvent: string;
  759. /**最低出价,单位分*/
  760. minPrice: number;
  761. /**最高出价,单位分*/
  762. maxPrice: number;
  763. /**不支持类型*/
  764. unsupportType: string;
  765. }[];
  766. }