@tikomni/skills 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (474) hide show
  1. package/.skill-package-allowlist.txt +1 -3
  2. package/README.md +41 -49
  3. package/README.zh-CN.md +43 -51
  4. package/bin/tikomni-skills.js +2 -2
  5. package/env.example +37 -56
  6. package/package.json +7 -5
  7. package/skills/social-media-crawl/SKILL.md +53 -0
  8. package/skills/social-media-crawl/agents/openai.yaml +5 -0
  9. package/skills/social-media-crawl/references/contracts/output-envelope.md +22 -0
  10. package/skills/social-media-crawl/references/contracts/work-fact-card-fields.md +48 -0
  11. package/skills/social-media-crawl/references/guides/generic-mcp-objects.md +30 -0
  12. package/skills/social-media-crawl/references/mcp-usage-contract.md +30 -0
  13. package/skills/social-media-crawl/references/pipelines/douyin-creator-home.md +7 -0
  14. package/skills/social-media-crawl/references/pipelines/douyin-single-work.md +7 -0
  15. package/skills/social-media-crawl/references/pipelines/xiaohongshu-creator-home.md +7 -0
  16. package/skills/social-media-crawl/references/pipelines/xiaohongshu-single-work.md +7 -0
  17. package/skills/social-media-crawl/references/schemas/creator-profile.schema.json +33 -0
  18. package/skills/social-media-crawl/references/schemas/output-envelope.schema.json +41 -0
  19. package/skills/social-media-crawl/references/schemas/work-collection.schema.json +29 -0
  20. package/skills/social-media-crawl/references/schemas/work-fact-card.schema.json +67 -0
  21. package/skills/social-media-crawl/references/service-guides/u2-u3-mandatory-fallback.md +21 -0
  22. package/skills/social-media-crawl/scripts/__init__.py +2 -0
  23. package/skills/social-media-crawl/scripts/core/__init__.py +2 -0
  24. package/skills/{single-work-analysis/scripts/pipeline/asr → social-media-crawl/scripts/core}/asr_pipeline.py +98 -2
  25. package/skills/social-media-crawl/scripts/core/completeness.py +83 -0
  26. package/skills/{single-work-analysis → social-media-crawl}/scripts/core/config_loader.py +106 -141
  27. package/skills/social-media-crawl/scripts/core/mcp_dispatch.py +145 -0
  28. package/skills/social-media-crawl/scripts/core/object_detection.py +63 -0
  29. package/skills/{single-work-analysis/scripts/pipeline/asr → social-media-crawl/scripts/core}/poll_u2_task.py +3 -1
  30. package/skills/{creator-analysis → social-media-crawl}/scripts/core/progress_report.py +32 -0
  31. package/skills/social-media-crawl/scripts/core/storage_router.py +160 -0
  32. package/skills/social-media-crawl/scripts/core/u3_fallback.py +328 -0
  33. package/skills/social-media-crawl/scripts/pipelines/__init__.py +2 -0
  34. package/skills/social-media-crawl/scripts/pipelines/douyin_creator_home_helpers.py +35 -0
  35. package/skills/social-media-crawl/scripts/pipelines/douyin_platform_adapter.py +7 -0
  36. package/skills/{creator-analysis/scripts/author_home/asr → social-media-crawl/scripts/pipelines}/home_asr.py +1 -1
  37. package/skills/{creator-analysis/scripts/author_home/adapters → social-media-crawl/scripts/pipelines}/platform_adapters.py +8 -2
  38. package/skills/social-media-crawl/scripts/pipelines/run_douyin_creator_home.py +237 -0
  39. package/skills/{single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py → social-media-crawl/scripts/pipelines/run_douyin_single_work.py} +58 -149
  40. package/skills/social-media-crawl/scripts/pipelines/run_xiaohongshu_creator_home.py +237 -0
  41. package/skills/{single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py → social-media-crawl/scripts/pipelines/run_xiaohongshu_single_work.py} +30 -119
  42. package/skills/{creator-analysis/scripts/author_home → social-media-crawl/scripts/pipelines}/schema.py +1 -1
  43. package/skills/social-media-crawl/scripts/pipelines/xiaohongshu_creator_home_helpers.py +35 -0
  44. package/skills/social-media-crawl/scripts/pipelines/xiaohongshu_platform_adapter.py +7 -0
  45. package/skills/social-media-crawl/scripts/writers/__init__.py +1 -0
  46. package/skills/social-media-crawl/scripts/writers/write_work_fact_card.py +391 -0
  47. package/skills/creator-analysis/SKILL.md +0 -95
  48. package/skills/creator-analysis/agents/openai.yaml +0 -4
  49. package/skills/creator-analysis/env.example +0 -36
  50. package/skills/creator-analysis/references/api-capability-index.md +0 -92
  51. package/skills/creator-analysis/references/api-contracts/asr-api.md +0 -130
  52. package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +0 -776
  53. package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +0 -2017
  54. package/skills/creator-analysis/references/api-contracts/demo-api.md +0 -717
  55. package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +0 -3594
  56. package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +0 -2274
  57. package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +0 -1575
  58. package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +0 -3254
  59. package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +0 -4118
  60. package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +0 -5544
  61. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +0 -1916
  62. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +0 -1540
  63. package/skills/creator-analysis/references/api-contracts/health-check.md +0 -69
  64. package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +0 -78
  65. package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +0 -2256
  66. package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +0 -2011
  67. package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +0 -2630
  68. package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +0 -44
  69. package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +0 -1518
  70. package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +0 -1242
  71. package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +0 -1088
  72. package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +0 -1949
  73. package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +0 -126
  74. package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +0 -1142
  75. package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +0 -2025
  76. package/skills/creator-analysis/references/api-contracts/sora2-api.md +0 -2266
  77. package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +0 -208
  78. package/skills/creator-analysis/references/api-contracts/threads-web-api.md +0 -897
  79. package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +0 -134
  80. package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +0 -494
  81. package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +0 -5947
  82. package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +0 -968
  83. package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +0 -5735
  84. package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +0 -1951
  85. package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +0 -742
  86. package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +0 -1890
  87. package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +0 -4448
  88. package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +0 -342
  89. package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +0 -143
  90. package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +0 -989
  91. package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +0 -809
  92. package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +0 -677
  93. package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +0 -1547
  94. package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +0 -798
  95. package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +0 -2459
  96. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +0 -1291
  97. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +0 -1683
  98. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +0 -1324
  99. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +0 -1209
  100. package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +0 -489
  101. package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +0 -2636
  102. package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +0 -2660
  103. package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +0 -2315
  104. package/skills/creator-analysis/references/api-tags/asr-api.md +0 -100
  105. package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +0 -482
  106. package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +0 -1267
  107. package/skills/creator-analysis/references/api-tags/demo-api.md +0 -365
  108. package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +0 -2012
  109. package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +0 -1428
  110. package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +0 -694
  111. package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +0 -694
  112. package/skills/creator-analysis/references/api-tags/douyin-search-api.md +0 -1059
  113. package/skills/creator-analysis/references/api-tags/douyin-web-api.md +0 -3314
  114. package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +0 -935
  115. package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +0 -925
  116. package/skills/creator-analysis/references/api-tags/health-check.md +0 -40
  117. package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +0 -57
  118. package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +0 -1224
  119. package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +0 -1147
  120. package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +0 -1123
  121. package/skills/creator-analysis/references/api-tags/ios-shortcut.md +0 -45
  122. package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +0 -846
  123. package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +0 -551
  124. package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +0 -687
  125. package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +0 -1105
  126. package/skills/creator-analysis/references/api-tags/media-ingest-api.md +0 -112
  127. package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +0 -721
  128. package/skills/creator-analysis/references/api-tags/reddit-app-api.md +0 -1057
  129. package/skills/creator-analysis/references/api-tags/sora2-api.md +0 -737
  130. package/skills/creator-analysis/references/api-tags/temp-mail-api.md +0 -136
  131. package/skills/creator-analysis/references/api-tags/threads-web-api.md +0 -472
  132. package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +0 -65
  133. package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +0 -253
  134. package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +0 -1393
  135. package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +0 -179
  136. package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +0 -3264
  137. package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +0 -709
  138. package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +0 -366
  139. package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +0 -663
  140. package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +0 -2516
  141. package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +0 -220
  142. package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +0 -96
  143. package/skills/creator-analysis/references/api-tags/twitter-web-api.md +0 -562
  144. package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +0 -405
  145. package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +0 -431
  146. package/skills/creator-analysis/references/api-tags/weibo-app-api.md +0 -851
  147. package/skills/creator-analysis/references/api-tags/weibo-web-api.md +0 -470
  148. package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +0 -1405
  149. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +0 -534
  150. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +0 -934
  151. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +0 -757
  152. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +0 -762
  153. package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +0 -308
  154. package/skills/creator-analysis/references/api-tags/youtube-web-api.md +0 -934
  155. package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +0 -717
  156. package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +0 -1384
  157. package/skills/creator-analysis/references/asr-orchestration.md +0 -33
  158. package/skills/creator-analysis/references/config-templates/defaults.yaml +0 -60
  159. package/skills/creator-analysis/references/contracts/creator-card-fields.md +0 -25
  160. package/skills/creator-analysis/references/contracts/work-card-fields.md +0 -68
  161. package/skills/creator-analysis/references/platform-guides/douyin.md +0 -54
  162. package/skills/creator-analysis/references/platform-guides/generic.md +0 -50
  163. package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +0 -69
  164. package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +0 -28
  165. package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +0 -46
  166. package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +0 -49
  167. package/skills/creator-analysis/references/prompt-contracts/cta.md +0 -24
  168. package/skills/creator-analysis/references/prompt-contracts/hook.md +0 -25
  169. package/skills/creator-analysis/references/prompt-contracts/insight.md +0 -47
  170. package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +0 -30
  171. package/skills/creator-analysis/references/prompt-contracts/structure.md +0 -25
  172. package/skills/creator-analysis/references/prompt-contracts/style.md +0 -27
  173. package/skills/creator-analysis/references/prompt-contracts/summary.md +0 -29
  174. package/skills/creator-analysis/references/prompt-contracts/topic.md +0 -29
  175. package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +0 -325
  176. package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +0 -287
  177. package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +0 -41
  178. package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +0 -75
  179. package/skills/creator-analysis/references/workflow.md +0 -23
  180. package/skills/creator-analysis/scripts/__init__.py +0 -0
  181. package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
  182. package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
  183. package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
  184. package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +0 -1165
  185. package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +0 -447
  186. package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +0 -331
  187. package/skills/creator-analysis/scripts/author_home/asr/__init__.py +0 -5
  188. package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
  189. package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +0 -213
  190. package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
  191. package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
  192. package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +0 -834
  193. package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +0 -609
  194. package/skills/creator-analysis/scripts/core/__init__.py +0 -0
  195. package/skills/creator-analysis/scripts/core/analysis_pipeline.py +0 -133
  196. package/skills/creator-analysis/scripts/core/config_loader.py +0 -418
  197. package/skills/creator-analysis/scripts/core/storage_router.py +0 -256
  198. package/skills/creator-analysis/scripts/core/tikomni_common.py +0 -588
  199. package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
  200. package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
  201. package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +0 -1189
  202. package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +0 -95
  203. package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
  204. package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
  205. package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +0 -1208
  206. package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  207. package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +0 -2128
  208. package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
  209. package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +0 -107
  210. package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +0 -1579
  211. package/skills/meta-capability/SKILL.md +0 -69
  212. package/skills/meta-capability/agents/openai.yaml +0 -4
  213. package/skills/meta-capability/env.example +0 -42
  214. package/skills/meta-capability/references/api-capability-index.md +0 -92
  215. package/skills/meta-capability/references/api-contracts/asr-api.md +0 -130
  216. package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +0 -776
  217. package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +0 -2017
  218. package/skills/meta-capability/references/api-contracts/demo-api.md +0 -717
  219. package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +0 -3594
  220. package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +0 -2274
  221. package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +0 -1575
  222. package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +0 -3254
  223. package/skills/meta-capability/references/api-contracts/douyin-search-api.md +0 -4118
  224. package/skills/meta-capability/references/api-contracts/douyin-web-api.md +0 -5544
  225. package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +0 -1916
  226. package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +0 -1540
  227. package/skills/meta-capability/references/api-contracts/health-check.md +0 -69
  228. package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +0 -78
  229. package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +0 -2256
  230. package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +0 -2011
  231. package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +0 -2630
  232. package/skills/meta-capability/references/api-contracts/ios-shortcut.md +0 -44
  233. package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +0 -1518
  234. package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +0 -1242
  235. package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +0 -1088
  236. package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +0 -1949
  237. package/skills/meta-capability/references/api-contracts/media-ingest-api.md +0 -126
  238. package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +0 -1142
  239. package/skills/meta-capability/references/api-contracts/reddit-app-api.md +0 -2025
  240. package/skills/meta-capability/references/api-contracts/sora2-api.md +0 -2266
  241. package/skills/meta-capability/references/api-contracts/temp-mail-api.md +0 -208
  242. package/skills/meta-capability/references/api-contracts/threads-web-api.md +0 -897
  243. package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +0 -134
  244. package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +0 -494
  245. package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +0 -5947
  246. package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +0 -968
  247. package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +0 -5735
  248. package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +0 -1951
  249. package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +0 -742
  250. package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +0 -1890
  251. package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +0 -4448
  252. package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +0 -342
  253. package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +0 -143
  254. package/skills/meta-capability/references/api-contracts/twitter-web-api.md +0 -989
  255. package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +0 -809
  256. package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +0 -677
  257. package/skills/meta-capability/references/api-contracts/weibo-app-api.md +0 -1547
  258. package/skills/meta-capability/references/api-contracts/weibo-web-api.md +0 -798
  259. package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +0 -2459
  260. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +0 -1291
  261. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +0 -1683
  262. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +0 -1324
  263. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +0 -1209
  264. package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +0 -489
  265. package/skills/meta-capability/references/api-contracts/youtube-web-api.md +0 -2636
  266. package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +0 -2660
  267. package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +0 -2315
  268. package/skills/meta-capability/references/api-tags/asr-api.md +0 -100
  269. package/skills/meta-capability/references/api-tags/bilibili-app-api.md +0 -482
  270. package/skills/meta-capability/references/api-tags/bilibili-web-api.md +0 -1267
  271. package/skills/meta-capability/references/api-tags/demo-api.md +0 -365
  272. package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +0 -2012
  273. package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +0 -1428
  274. package/skills/meta-capability/references/api-tags/douyin-creator-api.md +0 -694
  275. package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +0 -694
  276. package/skills/meta-capability/references/api-tags/douyin-search-api.md +0 -1059
  277. package/skills/meta-capability/references/api-tags/douyin-web-api.md +0 -3314
  278. package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +0 -935
  279. package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +0 -925
  280. package/skills/meta-capability/references/api-tags/health-check.md +0 -40
  281. package/skills/meta-capability/references/api-tags/hybrid-parsing.md +0 -57
  282. package/skills/meta-capability/references/api-tags/instagram-v1-api.md +0 -1224
  283. package/skills/meta-capability/references/api-tags/instagram-v2-api.md +0 -1147
  284. package/skills/meta-capability/references/api-tags/instagram-v3-api.md +0 -1123
  285. package/skills/meta-capability/references/api-tags/ios-shortcut.md +0 -45
  286. package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +0 -846
  287. package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +0 -551
  288. package/skills/meta-capability/references/api-tags/lemon8-app-api.md +0 -687
  289. package/skills/meta-capability/references/api-tags/linkedin-web-api.md +0 -1105
  290. package/skills/meta-capability/references/api-tags/media-ingest-api.md +0 -112
  291. package/skills/meta-capability/references/api-tags/pipixia-app-api.md +0 -721
  292. package/skills/meta-capability/references/api-tags/reddit-app-api.md +0 -1057
  293. package/skills/meta-capability/references/api-tags/sora2-api.md +0 -737
  294. package/skills/meta-capability/references/api-tags/temp-mail-api.md +0 -136
  295. package/skills/meta-capability/references/api-tags/threads-web-api.md +0 -472
  296. package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +0 -65
  297. package/skills/meta-capability/references/api-tags/tikhub-user-api.md +0 -253
  298. package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +0 -1393
  299. package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +0 -179
  300. package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +0 -3264
  301. package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +0 -709
  302. package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +0 -366
  303. package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +0 -663
  304. package/skills/meta-capability/references/api-tags/tiktok-web-api.md +0 -2516
  305. package/skills/meta-capability/references/api-tags/toutiao-app-api.md +0 -220
  306. package/skills/meta-capability/references/api-tags/toutiao-web-api.md +0 -96
  307. package/skills/meta-capability/references/api-tags/twitter-web-api.md +0 -562
  308. package/skills/meta-capability/references/api-tags/wechat-channels-api.md +0 -405
  309. package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +0 -431
  310. package/skills/meta-capability/references/api-tags/weibo-app-api.md +0 -851
  311. package/skills/meta-capability/references/api-tags/weibo-web-api.md +0 -470
  312. package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +0 -1405
  313. package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +0 -534
  314. package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +0 -934
  315. package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +0 -757
  316. package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +0 -762
  317. package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +0 -308
  318. package/skills/meta-capability/references/api-tags/youtube-web-api.md +0 -934
  319. package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +0 -717
  320. package/skills/meta-capability/references/api-tags/zhihu-web-api.md +0 -1384
  321. package/skills/meta-capability/references/config-templates/defaults.yaml +0 -18
  322. package/skills/meta-capability/references/dispatch.md +0 -27
  323. package/skills/meta-capability/references/execution-guidelines.md +0 -25
  324. package/skills/meta-capability/references/implemented-route-map.md +0 -177
  325. package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +0 -75
  326. package/skills/meta-capability/scripts/__init__.py +0 -1
  327. package/skills/meta-capability/scripts/call_route.py +0 -141
  328. package/skills/meta-capability/scripts/core/__init__.py +0 -1
  329. package/skills/meta-capability/scripts/core/bootstrap_env.py +0 -32
  330. package/skills/meta-capability/scripts/core/config_loader.py +0 -204
  331. package/skills/meta-capability/scripts/core/tikomni_common.py +0 -443
  332. package/skills/meta-capability/scripts/test_auth.py +0 -98
  333. package/skills/single-work-analysis/SKILL.md +0 -62
  334. package/skills/single-work-analysis/agents/openai.yaml +0 -4
  335. package/skills/single-work-analysis/env.example +0 -36
  336. package/skills/single-work-analysis/references/api-capability-index.md +0 -92
  337. package/skills/single-work-analysis/references/api-contracts/asr-api.md +0 -130
  338. package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +0 -776
  339. package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +0 -2017
  340. package/skills/single-work-analysis/references/api-contracts/demo-api.md +0 -717
  341. package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +0 -3594
  342. package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +0 -2274
  343. package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +0 -1575
  344. package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +0 -3254
  345. package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +0 -4118
  346. package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +0 -5544
  347. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +0 -1916
  348. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +0 -1540
  349. package/skills/single-work-analysis/references/api-contracts/health-check.md +0 -69
  350. package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +0 -78
  351. package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +0 -2256
  352. package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +0 -2011
  353. package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +0 -2630
  354. package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +0 -44
  355. package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +0 -1518
  356. package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +0 -1242
  357. package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +0 -1088
  358. package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +0 -1949
  359. package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +0 -126
  360. package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +0 -1142
  361. package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +0 -2025
  362. package/skills/single-work-analysis/references/api-contracts/sora2-api.md +0 -2266
  363. package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +0 -208
  364. package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +0 -897
  365. package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +0 -134
  366. package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +0 -494
  367. package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +0 -5947
  368. package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +0 -968
  369. package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +0 -5735
  370. package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +0 -1951
  371. package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +0 -742
  372. package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +0 -1890
  373. package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +0 -4448
  374. package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +0 -342
  375. package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +0 -143
  376. package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +0 -989
  377. package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +0 -809
  378. package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +0 -677
  379. package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +0 -1547
  380. package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +0 -798
  381. package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +0 -2459
  382. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +0 -1291
  383. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +0 -1683
  384. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +0 -1324
  385. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +0 -1209
  386. package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +0 -489
  387. package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +0 -2636
  388. package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +0 -2660
  389. package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +0 -2315
  390. package/skills/single-work-analysis/references/api-tags/asr-api.md +0 -100
  391. package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +0 -482
  392. package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +0 -1267
  393. package/skills/single-work-analysis/references/api-tags/demo-api.md +0 -365
  394. package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +0 -2012
  395. package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +0 -1428
  396. package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +0 -694
  397. package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +0 -694
  398. package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +0 -1059
  399. package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +0 -3314
  400. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +0 -935
  401. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +0 -925
  402. package/skills/single-work-analysis/references/api-tags/health-check.md +0 -40
  403. package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +0 -57
  404. package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +0 -1224
  405. package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +0 -1147
  406. package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +0 -1123
  407. package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +0 -45
  408. package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +0 -846
  409. package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +0 -551
  410. package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +0 -687
  411. package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +0 -1105
  412. package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +0 -112
  413. package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +0 -721
  414. package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +0 -1057
  415. package/skills/single-work-analysis/references/api-tags/sora2-api.md +0 -737
  416. package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +0 -136
  417. package/skills/single-work-analysis/references/api-tags/threads-web-api.md +0 -472
  418. package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +0 -65
  419. package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +0 -253
  420. package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +0 -1393
  421. package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +0 -179
  422. package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +0 -3264
  423. package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +0 -709
  424. package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +0 -366
  425. package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +0 -663
  426. package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +0 -2516
  427. package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +0 -220
  428. package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +0 -96
  429. package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +0 -562
  430. package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +0 -405
  431. package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +0 -431
  432. package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +0 -851
  433. package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +0 -470
  434. package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +0 -1405
  435. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +0 -534
  436. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +0 -934
  437. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +0 -757
  438. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +0 -762
  439. package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +0 -308
  440. package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +0 -934
  441. package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +0 -717
  442. package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +0 -1384
  443. package/skills/single-work-analysis/references/asr-and-fallback.md +0 -20
  444. package/skills/single-work-analysis/references/config-templates/defaults.yaml +0 -47
  445. package/skills/single-work-analysis/references/contracts/work-card-fields.md +0 -41
  446. package/skills/single-work-analysis/references/platform-guides/douyin.md +0 -47
  447. package/skills/single-work-analysis/references/platform-guides/generic.md +0 -43
  448. package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +0 -54
  449. package/skills/single-work-analysis/references/prompt-contracts/analysis-bundle.md +0 -82
  450. package/skills/single-work-analysis/references/schemas/work-card.schema.json +0 -39
  451. package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +0 -75
  452. package/skills/single-work-analysis/scripts/__init__.py +0 -0
  453. package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
  454. package/skills/single-work-analysis/scripts/core/analysis_adapter.py +0 -384
  455. package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +0 -456
  456. package/skills/single-work-analysis/scripts/core/bootstrap_env.py +0 -35
  457. package/skills/single-work-analysis/scripts/core/extract_pipeline.py +0 -173
  458. package/skills/single-work-analysis/scripts/core/progress_report.py +0 -258
  459. package/skills/single-work-analysis/scripts/core/storage_router.py +0 -220
  460. package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
  461. package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
  462. package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
  463. package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
  464. package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +0 -224
  465. package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +0 -200
  466. package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  467. package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
  468. package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +0 -752
  469. /package/skills/{creator-analysis → social-media-crawl}/scripts/core/bootstrap_env.py +0 -0
  470. /package/skills/{creator-analysis → social-media-crawl}/scripts/core/extract_pipeline.py +0 -0
  471. /package/skills/{single-work-analysis → social-media-crawl}/scripts/core/tikomni_common.py +0 -0
  472. /package/skills/{creator-analysis/scripts/platform/douyin → social-media-crawl/scripts/pipelines}/douyin_video_type_matrix.py +0 -0
  473. /package/skills/{creator-analysis/scripts/author_home/collectors → social-media-crawl/scripts/pipelines}/homepage_collectors.py +0 -0
  474. /package/skills/{creator-analysis/scripts/platform/douyin → social-media-crawl/scripts/pipelines}/select_low_quality_video_url.py +0 -0
@@ -1,1393 +0,0 @@
1
- # TikTok-Ads-API Route Summary
2
-
3
- - Back to index: [`api-capability-index.md`](../api-capability-index.md)
4
- - Current tag file: `api-tags/tiktok-ads-api.md`
5
- - Full contract: [`api-contracts/tiktok-ads-api.md`](../api-contracts/tiktok-ads-api.md)
6
- - Source: `https://app.tikomni.com/openapi/tikomni-openapi.full.with-u2.public.latest.json`
7
- - Fetched at: `2026-03-08T06:54:04+00:00`
8
- - Route count: `31`
9
- - Common capabilities: ads / search / details / creators / commerce / topics
10
- - Default auth: Header `Authorization` Bearer
11
- - Common inputs: `limit`, `page`, `country_code`, `period`, `keyword`, `period_type`, `industry`, `order_by`, `rank_type`, `material_id`
12
- - Tag description: **(TikTok广告创意中心数据接口/TikTok-Ads-Creative-Center-API endpoints)**
13
-
14
- ## Routes
15
-
16
- ### `GET /api/u1/v1/tiktok/ads/get_ad_interactive_analysis`
17
-
18
- - Summary: 获取广告互动分析/Get ad interactive analysis
19
- - Capabilities: ads
20
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
21
- - operationId: `get_ad_interactive_analysis_api_v1_tiktok_ads_get_ad_interactive_analysis_get`
22
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ad-interactive-analysis`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ad-interactive-analysis)
23
-
24
- #### Parameters
25
-
26
- | Field | In | Type | Required | Description |
27
- | --- | --- | --- | --- | --- |
28
- | material_id | query | string | Yes | 广告素材ID/Ad material ID |
29
- | metric_type | query | string | No | 分析类型/Analysis type (ctr, cvr, clicks, conversion, remain) |
30
- | period_type | query | integer | No | 时间范围(天)/Period type (days) |
31
-
32
- #### Request Body
33
-
34
- None
35
-
36
- #### Success Response
37
-
38
- ##### `200 application/json`
39
-
40
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
41
-
42
- | Field | Type | Required | Description |
43
- | --- | --- | --- | --- |
44
- | code | integer | No | HTTP status code \| HTTP状态码 |
45
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
46
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
47
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
48
- | support | string | No | Support message \| 支持消息 |
49
- | time | string | No | The time the response was generated \| 生成响应的时间 |
50
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
51
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
52
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
53
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
54
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
55
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
56
-
57
- - Fields truncated: this layer shows only the first `12` rows.
58
-
59
- ### `GET /api/u1/v1/tiktok/ads/get_ad_keyframe_analysis`
60
-
61
- - Summary: 获取广告关键帧分析/Get ad keyframe analysis
62
- - Capabilities: ads
63
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
64
- - operationId: `get_ad_keyframe_analysis_api_v1_tiktok_ads_get_ad_keyframe_analysis_get`
65
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ad-keyframe-analysis`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ad-keyframe-analysis)
66
-
67
- #### Parameters
68
-
69
- | Field | In | Type | Required | Description |
70
- | --- | --- | --- | --- | --- |
71
- | material_id | query | string | Yes | 广告素材ID/Ad material ID |
72
- | metric | query | string | No | 分析指标/Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt) |
73
-
74
- #### Request Body
75
-
76
- None
77
-
78
- #### Success Response
79
-
80
- ##### `200 application/json`
81
-
82
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
83
-
84
- | Field | Type | Required | Description |
85
- | --- | --- | --- | --- |
86
- | code | integer | No | HTTP status code \| HTTP状态码 |
87
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
88
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
89
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
90
- | support | string | No | Support message \| 支持消息 |
91
- | time | string | No | The time the response was generated \| 生成响应的时间 |
92
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
93
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
94
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
95
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
96
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
97
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
98
-
99
- - Fields truncated: this layer shows only the first `12` rows.
100
-
101
- ### `GET /api/u1/v1/tiktok/ads/get_ad_percentile`
102
-
103
- - Summary: 获取广告百分位数据/Get ad percentile data
104
- - Capabilities: ads
105
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
106
- - operationId: `get_ad_percentile_api_v1_tiktok_ads_get_ad_percentile_get`
107
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ad-percentile`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ad-percentile)
108
-
109
- #### Parameters
110
-
111
- | Field | In | Type | Required | Description |
112
- | --- | --- | --- | --- | --- |
113
- | material_id | query | string | Yes | 广告素材ID/Ad material ID |
114
- | metric | query | string | No | 分析指标/Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt… |
115
- | period_type | query | integer | No | 时间范围(天)/Time period (days) |
116
-
117
- #### Request Body
118
-
119
- None
120
-
121
- #### Success Response
122
-
123
- ##### `200 application/json`
124
-
125
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
126
-
127
- | Field | Type | Required | Description |
128
- | --- | --- | --- | --- |
129
- | code | integer | No | HTTP status code \| HTTP状态码 |
130
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
131
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
132
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
133
- | support | string | No | Support message \| 支持消息 |
134
- | time | string | No | The time the response was generated \| 生成响应的时间 |
135
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
136
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
137
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
138
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
139
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
140
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
141
-
142
- - Fields truncated: this layer shows only the first `12` rows.
143
-
144
- ### `GET /api/u1/v1/tiktok/ads/get_ads_detail`
145
-
146
- - Summary: 获取单个广告详情/Get single ad detail
147
- - Capabilities: details / ads
148
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
149
- - operationId: `get_ads_detail_api_v1_tiktok_ads_get_ads_detail_get`
150
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ads-detail`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-ads-detail)
151
-
152
- #### Parameters
153
-
154
- | Field | In | Type | Required | Description |
155
- | --- | --- | --- | --- | --- |
156
- | ads_id | query | string | Yes | 广告ID/Ad ID |
157
-
158
- #### Request Body
159
-
160
- None
161
-
162
- #### Success Response
163
-
164
- ##### `200 application/json`
165
-
166
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
167
-
168
- | Field | Type | Required | Description |
169
- | --- | --- | --- | --- |
170
- | code | integer | No | HTTP status code \| HTTP状态码 |
171
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
172
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
173
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
174
- | support | string | No | Support message \| 支持消息 |
175
- | time | string | No | The time the response was generated \| 生成响应的时间 |
176
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
177
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
178
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
179
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
180
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
181
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
182
-
183
- - Fields truncated: this layer shows only the first `12` rows.
184
-
185
- ### `GET /api/u1/v1/tiktok/ads/get_creative_patterns`
186
-
187
- - Summary: 获取创意模式排行榜/Get creative pattern rankings
188
- - Capabilities: ads
189
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
190
- - operationId: `get_creative_patterns_api_v1_tiktok_ads_get_creative_patterns_get`
191
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-creative-patterns`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-creative-patterns)
192
-
193
- #### Parameters
194
-
195
- | Field | In | Type | Required | Description |
196
- | --- | --- | --- | --- | --- |
197
- | first_industry_id | query | string | No | 一级行业ID/First industry ID |
198
- | period_type | query | string | No | 时间周期类型/Period type (week, month) |
199
- | order_field | query | string | No | 排序字段/Order field (ctr, play_over_rate) |
200
- | order_type | query | string | No | 排序方式/Sort order (desc, asc) |
201
- | week | query | string | No | 特定周(可选)/Specific week (optional) |
202
- | page | query | integer | No | 页码/Page number |
203
- | limit | query | integer | No | 每页数量/Items per page |
204
-
205
- #### Request Body
206
-
207
- None
208
-
209
- #### Success Response
210
-
211
- ##### `200 application/json`
212
-
213
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
214
-
215
- | Field | Type | Required | Description |
216
- | --- | --- | --- | --- |
217
- | code | integer | No | HTTP status code \| HTTP状态码 |
218
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
219
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
220
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
221
- | support | string | No | Support message \| 支持消息 |
222
- | time | string | No | The time the response was generated \| 生成响应的时间 |
223
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
224
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
225
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
226
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
227
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
228
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
229
-
230
- - Fields truncated: this layer shows only the first `12` rows.
231
-
232
- ### `GET /api/u1/v1/tiktok/ads/get_creator_filters`
233
-
234
- - Summary: 获取创作者筛选器/Get creator filters
235
- - Capabilities: creators / ads
236
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
237
- - operationId: `get_creator_filters_api_v1_tiktok_ads_get_creator_filters_get`
238
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-creator-filters`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-creator-filters)
239
-
240
- #### Parameters
241
-
242
- None
243
-
244
- #### Request Body
245
-
246
- None
247
-
248
- #### Success Response
249
-
250
- ##### `200 application/json`
251
-
252
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
253
-
254
- | Field | Type | Required | Description |
255
- | --- | --- | --- | --- |
256
- | code | integer | No | HTTP status code \| HTTP状态码 |
257
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
258
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
259
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
260
- | support | string | No | Support message \| 支持消息 |
261
- | time | string | No | The time the response was generated \| 生成响应的时间 |
262
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
263
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
264
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
265
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
266
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
267
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
268
-
269
- - Fields truncated: this layer shows only the first `12` rows.
270
-
271
- ### `GET /api/u1/v1/tiktok/ads/get_creator_list`
272
-
273
- - Summary: 获取创作者列表/Get creator list
274
- - Capabilities: creators / ads
275
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
276
- - operationId: `get_creator_list_api_v1_tiktok_ads_get_creator_list_get`
277
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-creator-list`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-creator-list)
278
-
279
- #### Parameters
280
-
281
- | Field | In | Type | Required | Description |
282
- | --- | --- | --- | --- | --- |
283
- | page | query | integer | No | 页码/Page number |
284
- | limit | query | integer | No | 每页数量/Items per page |
285
- | sort_by | query | string | No | 排序方式/Sort by (follower, engagement, avg_views) |
286
- | creator_country | query | string | No | 创作者国家/Creator country |
287
- | audience_country | query | string | No | 受众国家/Audience country |
288
- | audience_count | query | integer | No | 受众数量筛选/Audience count filter |
289
- | keyword | query | string | No | 关键词/Keyword |
290
-
291
- #### Request Body
292
-
293
- None
294
-
295
- #### Success Response
296
-
297
- ##### `200 application/json`
298
-
299
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
300
-
301
- | Field | Type | Required | Description |
302
- | --- | --- | --- | --- |
303
- | code | integer | No | HTTP status code \| HTTP状态码 |
304
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
305
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
306
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
307
- | support | string | No | Support message \| 支持消息 |
308
- | time | string | No | The time the response was generated \| 生成响应的时间 |
309
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
310
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
311
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
312
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
313
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
314
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
315
-
316
- - Fields truncated: this layer shows only the first `12` rows.
317
-
318
- ### `GET /api/u1/v1/tiktok/ads/get_hashtag_creator`
319
-
320
- - Summary: 获取标签创作者信息/Get hashtag creator info
321
- - Capabilities: creators / ads / topics
322
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
323
- - operationId: `get_hashtag_creator_api_v1_tiktok_ads_get_hashtag_creator_get`
324
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-hashtag-creator`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-hashtag-creator)
325
-
326
- #### Parameters
327
-
328
- | Field | In | Type | Required | Description |
329
- | --- | --- | --- | --- | --- |
330
- | hashtag | query | string | Yes | 标签名称,不包含#符号/Hashtag name (without # symbol) |
331
-
332
- #### Request Body
333
-
334
- None
335
-
336
- #### Success Response
337
-
338
- ##### `200 application/json`
339
-
340
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
341
-
342
- | Field | Type | Required | Description |
343
- | --- | --- | --- | --- |
344
- | code | integer | No | HTTP status code \| HTTP状态码 |
345
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
346
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
347
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
348
- | support | string | No | Support message \| 支持消息 |
349
- | time | string | No | The time the response was generated \| 生成响应的时间 |
350
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
351
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
352
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
353
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
354
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
355
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
356
-
357
- - Fields truncated: this layer shows only the first `12` rows.
358
-
359
- ### `GET /api/u1/v1/tiktok/ads/get_hashtag_filters`
360
-
361
- - Summary: 获取标签筛选器/Get hashtag filters
362
- - Capabilities: ads / topics
363
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
364
- - operationId: `get_hashtag_filters_api_v1_tiktok_ads_get_hashtag_filters_get`
365
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-hashtag-filters`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-hashtag-filters)
366
-
367
- #### Parameters
368
-
369
- None
370
-
371
- #### Request Body
372
-
373
- None
374
-
375
- #### Success Response
376
-
377
- ##### `200 application/json`
378
-
379
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
380
-
381
- | Field | Type | Required | Description |
382
- | --- | --- | --- | --- |
383
- | code | integer | No | HTTP status code \| HTTP状态码 |
384
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
385
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
386
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
387
- | support | string | No | Support message \| 支持消息 |
388
- | time | string | No | The time the response was generated \| 生成响应的时间 |
389
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
390
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
391
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
392
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
393
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
394
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
395
-
396
- - Fields truncated: this layer shows only the first `12` rows.
397
-
398
- ### `GET /api/u1/v1/tiktok/ads/get_hashtag_list`
399
-
400
- - Summary: 获取热门标签列表/Get popular hashtags list
401
- - Capabilities: ads / topics
402
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
403
- - operationId: `get_hashtag_list_api_v1_tiktok_ads_get_hashtag_list_get`
404
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-hashtag-list`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-hashtag-list)
405
-
406
- #### Parameters
407
-
408
- | Field | In | Type | Required | Description |
409
- | --- | --- | --- | --- | --- |
410
- | page | query | integer | No | 页码/Page number |
411
- | limit | query | integer | No | 每页数量/Items per page |
412
- | period | query | integer | No | 时间范围(天)/Time period (days) |
413
- | country_code | query | string | No | 国家代码/Country code |
414
- | sort_by | query | string | No | 排序方式/Sort by (popular, new) |
415
- | industry_id | query | string | No | 行业ID/Industry ID |
416
- | filter_by | query | string | No | 筛选条件/Filter (new_on_board) |
417
-
418
- #### Request Body
419
-
420
- None
421
-
422
- #### Success Response
423
-
424
- ##### `200 application/json`
425
-
426
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
427
-
428
- | Field | Type | Required | Description |
429
- | --- | --- | --- | --- |
430
- | code | integer | No | HTTP status code \| HTTP状态码 |
431
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
432
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
433
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
434
- | support | string | No | Support message \| 支持消息 |
435
- | time | string | No | The time the response was generated \| 生成响应的时间 |
436
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
437
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
438
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
439
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
440
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
441
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
442
-
443
- - Fields truncated: this layer shows only the first `12` rows.
444
-
445
- ### `GET /api/u1/v1/tiktok/ads/get_keyword_details`
446
-
447
- - Summary: 获取关键词详细信息/Get keyword details
448
- - Capabilities: details / ads
449
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
450
- - operationId: `get_keyword_details_api_v1_tiktok_ads_get_keyword_details_get`
451
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-details`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-details)
452
-
453
- #### Parameters
454
-
455
- | Field | In | Type | Required | Description |
456
- | --- | --- | --- | --- | --- |
457
- | keyword | query | string | No | 关键词(可选)/Keyword (optional) |
458
- | page | query | integer | No | 页码/Page number |
459
- | limit | query | integer | No | 每页数量/Items per page |
460
- | period | query | integer | No | 时间范围(天)/Time period (days) |
461
- | country_code | query | string | No | 国家代码/Country code |
462
- | order_by | query | string | No | 排序字段/Sort field |
463
- | order_type | query | string | No | 排序方式/Sort order (desc, asc) |
464
- | industry | query | string | No | 行业ID/Industry ID |
465
- | objective | query | string | No | 广告目标/Ad objective |
466
- | keyword_type | query | string | No | 关键词类型/Keyword type |
467
-
468
- #### Request Body
469
-
470
- None
471
-
472
- #### Success Response
473
-
474
- ##### `200 application/json`
475
-
476
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
477
-
478
- | Field | Type | Required | Description |
479
- | --- | --- | --- | --- |
480
- | code | integer | No | HTTP status code \| HTTP状态码 |
481
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
482
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
483
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
484
- | support | string | No | Support message \| 支持消息 |
485
- | time | string | No | The time the response was generated \| 生成响应的时间 |
486
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
487
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
488
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
489
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
490
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
491
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
492
-
493
- - Fields truncated: this layer shows only the first `12` rows.
494
-
495
- ### `GET /api/u1/v1/tiktok/ads/get_keyword_filters`
496
-
497
- - Summary: 获取关键词筛选器/Get keyword filters
498
- - Capabilities: ads
499
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
500
- - operationId: `get_keyword_filters_api_v1_tiktok_ads_get_keyword_filters_get`
501
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-filters`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-filters)
502
-
503
- #### Parameters
504
-
505
- None
506
-
507
- #### Request Body
508
-
509
- None
510
-
511
- #### Success Response
512
-
513
- ##### `200 application/json`
514
-
515
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
516
-
517
- | Field | Type | Required | Description |
518
- | --- | --- | --- | --- |
519
- | code | integer | No | HTTP status code \| HTTP状态码 |
520
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
521
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
522
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
523
- | support | string | No | Support message \| 支持消息 |
524
- | time | string | No | The time the response was generated \| 生成响应的时间 |
525
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
526
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
527
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
528
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
529
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
530
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
531
-
532
- - Fields truncated: this layer shows only the first `12` rows.
533
-
534
- ### `GET /api/u1/v1/tiktok/ads/get_keyword_insights`
535
-
536
- - Summary: 获取关键词洞察数据/Get keyword insights data
537
- - Capabilities: ads / analytics
538
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
539
- - operationId: `get_keyword_insights_api_v1_tiktok_ads_get_keyword_insights_get`
540
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-insights`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-insights)
541
-
542
- #### Parameters
543
-
544
- | Field | In | Type | Required | Description |
545
- | --- | --- | --- | --- | --- |
546
- | page | query | integer | No | 页码/Page number |
547
- | limit | query | integer | No | 每页数量/Items per page |
548
- | period | query | integer | No | 时间段(天)/Time period (days, 7/30/120/180) |
549
- | country_code | query | string | No | 国家代码/Country code |
550
- | order_by | query | string | No | 排序字段/Sort field (post, ctr, click_rate, etc.) |
551
- | order_type | query | string | No | 排序方式/Sort order (desc, asc) |
552
- | industry | query | string | No | 行业ID/Industry ID |
553
- | objective | query | string | No | 广告目标/Ad objective |
554
- | keyword_type | query | string | No | 关键词类型/Keyword type |
555
- | keyword | query | string | No | 关键词/Keyword |
556
-
557
- #### Request Body
558
-
559
- None
560
-
561
- #### Success Response
562
-
563
- ##### `200 application/json`
564
-
565
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
566
-
567
- | Field | Type | Required | Description |
568
- | --- | --- | --- | --- |
569
- | code | integer | No | HTTP status code \| HTTP状态码 |
570
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
571
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
572
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
573
- | support | string | No | Support message \| 支持消息 |
574
- | time | string | No | The time the response was generated \| 生成响应的时间 |
575
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
576
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
577
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
578
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
579
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
580
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
581
-
582
- - Fields truncated: this layer shows only the first `12` rows.
583
-
584
- ### `GET /api/u1/v1/tiktok/ads/get_keyword_list`
585
-
586
- - Summary: 获取关键词列表/Get keyword list
587
- - Capabilities: ads
588
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
589
- - operationId: `get_keyword_list_api_v1_tiktok_ads_get_keyword_list_get`
590
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-list`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-keyword-list)
591
-
592
- #### Parameters
593
-
594
- | Field | In | Type | Required | Description |
595
- | --- | --- | --- | --- | --- |
596
- | keyword | query | string | No | 关键词/Keyword |
597
- | period | query | integer | No | 时间范围(天)/Time period (days) |
598
- | page | query | integer | No | 页码/Page number |
599
- | limit | query | integer | No | 每页数量/Items per page |
600
- | country_code | query | string | No | 国家代码/Country code |
601
- | industry | query | string | No | 行业ID列表,逗号分隔/Industry IDs, comma separated |
602
-
603
- #### Request Body
604
-
605
- None
606
-
607
- #### Success Response
608
-
609
- ##### `200 application/json`
610
-
611
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
612
-
613
- | Field | Type | Required | Description |
614
- | --- | --- | --- | --- |
615
- | code | integer | No | HTTP status code \| HTTP状态码 |
616
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
617
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
618
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
619
- | support | string | No | Support message \| 支持消息 |
620
- | time | string | No | The time the response was generated \| 生成响应的时间 |
621
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
622
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
623
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
624
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
625
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
626
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
627
-
628
- - Fields truncated: this layer shows only the first `12` rows.
629
-
630
- ### `GET /api/u1/v1/tiktok/ads/get_popular_trends`
631
-
632
- - Summary: 获取流行趋势视频/Get popular trend videos
633
- - Capabilities: trends / rankings / ads
634
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
635
- - operationId: `get_popular_trends_api_v1_tiktok_ads_get_popular_trends_get`
636
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-popular-trends`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-popular-trends)
637
-
638
- #### Parameters
639
-
640
- | Field | In | Type | Required | Description |
641
- | --- | --- | --- | --- | --- |
642
- | period | query | integer | No | 时间范围(天)/Time period (days) |
643
- | page | query | integer | No | 页码/Page number |
644
- | limit | query | integer | No | 每页数量/Items per page |
645
- | order_by | query | string | No | 排序字段/Order by (vv, like, comment, repost) |
646
- | country_code | query | string | No | 国家代码/Country code |
647
-
648
- #### Request Body
649
-
650
- None
651
-
652
- #### Success Response
653
-
654
- ##### `200 application/json`
655
-
656
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
657
-
658
- | Field | Type | Required | Description |
659
- | --- | --- | --- | --- |
660
- | code | integer | No | HTTP status code \| HTTP状态码 |
661
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
662
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
663
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
664
- | support | string | No | Support message \| 支持消息 |
665
- | time | string | No | The time the response was generated \| 生成响应的时间 |
666
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
667
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
668
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
669
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
670
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
671
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
672
-
673
- - Fields truncated: this layer shows only the first `12` rows.
674
-
675
- ### `GET /api/u1/v1/tiktok/ads/get_product_detail`
676
-
677
- - Summary: 获取产品详细信息/Get product detail
678
- - Capabilities: details / commerce / ads
679
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
680
- - operationId: `get_product_detail_api_v1_tiktok_ads_get_product_detail_get`
681
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-product-detail`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-product-detail)
682
-
683
- #### Parameters
684
-
685
- | Field | In | Type | Required | Description |
686
- | --- | --- | --- | --- | --- |
687
- | id | query | string | Yes | 产品类目ID/Product category ID |
688
- | last | query | integer | No | 最近天数/Last days |
689
- | ecom_type | query | string | No | 电商类型/E-commerce type |
690
- | period_type | query | string | No | 时间类型/Period type |
691
- | country_code | query | string | No | 国家代码/Country code |
692
-
693
- #### Request Body
694
-
695
- None
696
-
697
- #### Success Response
698
-
699
- ##### `200 application/json`
700
-
701
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
702
-
703
- | Field | Type | Required | Description |
704
- | --- | --- | --- | --- |
705
- | code | integer | No | HTTP status code \| HTTP状态码 |
706
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
707
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
708
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
709
- | support | string | No | Support message \| 支持消息 |
710
- | time | string | No | The time the response was generated \| 生成响应的时间 |
711
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
712
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
713
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
714
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
715
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
716
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
717
-
718
- - Fields truncated: this layer shows only the first `12` rows.
719
-
720
- ### `GET /api/u1/v1/tiktok/ads/get_product_filters`
721
-
722
- - Summary: 获取产品筛选器/Get product filters
723
- - Capabilities: commerce / ads
724
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
725
- - operationId: `get_product_filters_api_v1_tiktok_ads_get_product_filters_get`
726
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-product-filters`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-product-filters)
727
-
728
- #### Parameters
729
-
730
- None
731
-
732
- #### Request Body
733
-
734
- None
735
-
736
- #### Success Response
737
-
738
- ##### `200 application/json`
739
-
740
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
741
-
742
- | Field | Type | Required | Description |
743
- | --- | --- | --- | --- |
744
- | code | integer | No | HTTP status code \| HTTP状态码 |
745
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
746
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
747
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
748
- | support | string | No | Support message \| 支持消息 |
749
- | time | string | No | The time the response was generated \| 生成响应的时间 |
750
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
751
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
752
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
753
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
754
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
755
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
756
-
757
- - Fields truncated: this layer shows only the first `12` rows.
758
-
759
- ### `GET /api/u1/v1/tiktok/ads/get_product_metrics`
760
-
761
- - Summary: 获取产品指标数据/Get product metrics
762
- - Capabilities: commerce / ads
763
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
764
- - operationId: `get_product_metrics_api_v1_tiktok_ads_get_product_metrics_get`
765
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-product-metrics`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-product-metrics)
766
-
767
- #### Parameters
768
-
769
- | Field | In | Type | Required | Description |
770
- | --- | --- | --- | --- | --- |
771
- | id | query | string | Yes | 产品类目ID/Product category ID |
772
- | last | query | integer | No | 最近天数/Last days |
773
- | metrics | query | string | No | 指标类型,逗号分隔/Metrics types, comma separated |
774
- | ecom_type | query | string | No | 电商类型/E-commerce type |
775
- | period_type | query | string | No | 时间类型/Period type |
776
- | country_code | query | string | No | 国家代码/Country code |
777
-
778
- #### Request Body
779
-
780
- None
781
-
782
- #### Success Response
783
-
784
- ##### `200 application/json`
785
-
786
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
787
-
788
- | Field | Type | Required | Description |
789
- | --- | --- | --- | --- |
790
- | code | integer | No | HTTP status code \| HTTP状态码 |
791
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
792
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
793
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
794
- | support | string | No | Support message \| 支持消息 |
795
- | time | string | No | The time the response was generated \| 生成响应的时间 |
796
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
797
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
798
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
799
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
800
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
801
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
802
-
803
- - Fields truncated: this layer shows only the first `12` rows.
804
-
805
- ### `GET /api/u1/v1/tiktok/ads/get_query_suggestions`
806
-
807
- - Summary: 获取查询建议/Get query suggestions
808
- - Capabilities: search / ads
809
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
810
- - operationId: `get_query_suggestions_api_v1_tiktok_ads_get_query_suggestions_get`
811
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-query-suggestions`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-query-suggestions)
812
-
813
- #### Parameters
814
-
815
- | Field | In | Type | Required | Description |
816
- | --- | --- | --- | --- | --- |
817
- | count | query | integer | No | 建议数量/Suggestion count |
818
- | scenario | query | integer | No | 场景类型/Scenario type |
819
-
820
- #### Request Body
821
-
822
- None
823
-
824
- #### Success Response
825
-
826
- ##### `200 application/json`
827
-
828
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
829
-
830
- | Field | Type | Required | Description |
831
- | --- | --- | --- | --- |
832
- | code | integer | No | HTTP status code \| HTTP状态码 |
833
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
834
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
835
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
836
- | support | string | No | Support message \| 支持消息 |
837
- | time | string | No | The time the response was generated \| 生成响应的时间 |
838
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
839
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
840
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
841
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
842
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
843
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
844
-
845
- - Fields truncated: this layer shows only the first `12` rows.
846
-
847
- ### `GET /api/u1/v1/tiktok/ads/get_recommended_ads`
848
-
849
- - Summary: 获取推荐广告/Get recommended ads
850
- - Capabilities: ads
851
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
852
- - operationId: `get_recommended_ads_api_v1_tiktok_ads_get_recommended_ads_get`
853
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-recommended-ads`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-recommended-ads)
854
-
855
- #### Parameters
856
-
857
- | Field | In | Type | Required | Description |
858
- | --- | --- | --- | --- | --- |
859
- | material_id | query | string | Yes | 广告素材ID/Ad material ID |
860
- | industry | query | string | No | 行业ID/Industry ID |
861
- | country_code | query | string | No | 国家代码/Country code |
862
-
863
- #### Request Body
864
-
865
- None
866
-
867
- #### Success Response
868
-
869
- ##### `200 application/json`
870
-
871
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
872
-
873
- | Field | Type | Required | Description |
874
- | --- | --- | --- | --- |
875
- | code | integer | No | HTTP status code \| HTTP状态码 |
876
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
877
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
878
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
879
- | support | string | No | Support message \| 支持消息 |
880
- | time | string | No | The time the response was generated \| 生成响应的时间 |
881
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
882
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
883
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
884
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
885
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
886
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
887
-
888
- - Fields truncated: this layer shows only the first `12` rows.
889
-
890
- ### `GET /api/u1/v1/tiktok/ads/get_related_keywords`
891
-
892
- - Summary: 获取相关关键词/Get related keywords
893
- - Capabilities: ads
894
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
895
- - operationId: `get_related_keywords_api_v1_tiktok_ads_get_related_keywords_get`
896
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-related-keywords`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-related-keywords)
897
-
898
- #### Parameters
899
-
900
- | Field | In | Type | Required | Description |
901
- | --- | --- | --- | --- | --- |
902
- | keyword | query | string | No | 目标关键词/Target keyword |
903
- | period | query | integer | No | 时间段(天)/Time period (days, 7/30/120) |
904
- | country_code | query | string | No | 国家/地区代码/Country code |
905
- | rank_type | query | string | No | 排名类型/Rank type (popular: 热门, breakout: 突破性) |
906
- | content_type | query | string | No | 内容类型/Content type (keyword, hashtag) |
907
- | page | query | integer | No | 页码/Page number |
908
- | limit | query | integer | No | 每页数量/Items per page |
909
-
910
- #### Request Body
911
-
912
- None
913
-
914
- #### Success Response
915
-
916
- ##### `200 application/json`
917
-
918
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
919
-
920
- | Field | Type | Required | Description |
921
- | --- | --- | --- | --- |
922
- | code | integer | No | HTTP status code \| HTTP状态码 |
923
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
924
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
925
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
926
- | support | string | No | Support message \| 支持消息 |
927
- | time | string | No | The time the response was generated \| 生成响应的时间 |
928
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
929
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
930
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
931
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
932
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
933
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
934
-
935
- - Fields truncated: this layer shows only the first `12` rows.
936
-
937
- ### `GET /api/u1/v1/tiktok/ads/get_sound_detail`
938
-
939
- - Summary: 获取音乐详情/Get sound detail
940
- - Capabilities: details / ads
941
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
942
- - operationId: `get_sound_detail_api_v1_tiktok_ads_get_sound_detail_get`
943
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-detail`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-detail)
944
-
945
- #### Parameters
946
-
947
- | Field | In | Type | Required | Description |
948
- | --- | --- | --- | --- | --- |
949
- | clip_id | query | string | Yes | 音乐ID/Sound clip ID |
950
- | period | query | integer | No | 时间范围(天)/Time period (days) |
951
- | country_code | query | string | No | 国家代码/Country code |
952
-
953
- #### Request Body
954
-
955
- None
956
-
957
- #### Success Response
958
-
959
- ##### `200 application/json`
960
-
961
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
962
-
963
- | Field | Type | Required | Description |
964
- | --- | --- | --- | --- |
965
- | code | integer | No | HTTP status code \| HTTP状态码 |
966
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
967
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
968
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
969
- | support | string | No | Support message \| 支持消息 |
970
- | time | string | No | The time the response was generated \| 生成响应的时间 |
971
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
972
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
973
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
974
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
975
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
976
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
977
-
978
- - Fields truncated: this layer shows only the first `12` rows.
979
-
980
- ### `GET /api/u1/v1/tiktok/ads/get_sound_filters`
981
-
982
- - Summary: 获取音乐筛选器/Get sound filters
983
- - Capabilities: ads
984
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
985
- - operationId: `get_sound_filters_api_v1_tiktok_ads_get_sound_filters_get`
986
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-filters`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-filters)
987
-
988
- #### Parameters
989
-
990
- | Field | In | Type | Required | Description |
991
- | --- | --- | --- | --- | --- |
992
- | rank_type | query | string | No | 排行类型/Rank type (popular, surging) |
993
-
994
- #### Request Body
995
-
996
- None
997
-
998
- #### Success Response
999
-
1000
- ##### `200 application/json`
1001
-
1002
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1003
-
1004
- | Field | Type | Required | Description |
1005
- | --- | --- | --- | --- |
1006
- | code | integer | No | HTTP status code \| HTTP状态码 |
1007
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1008
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1009
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1010
- | support | string | No | Support message \| 支持消息 |
1011
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1012
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1013
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1014
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1015
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1016
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1017
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1018
-
1019
- - Fields truncated: this layer shows only the first `12` rows.
1020
-
1021
- ### `GET /api/u1/v1/tiktok/ads/get_sound_rank_list`
1022
-
1023
- - Summary: 获取热门音乐排行榜/Get popular sound rankings
1024
- - Capabilities: ads
1025
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1026
- - operationId: `get_sound_rank_list_api_v1_tiktok_ads_get_sound_rank_list_get`
1027
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-rank-list`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-rank-list)
1028
-
1029
- #### Parameters
1030
-
1031
- | Field | In | Type | Required | Description |
1032
- | --- | --- | --- | --- | --- |
1033
- | period | query | integer | No | 时间范围(天)/Time period (days) |
1034
- | page | query | integer | No | 页码/Page number |
1035
- | limit | query | integer | No | 每页数量/Items per page |
1036
- | rank_type | query | string | No | 排行类型/Rank type (popular, surging) |
1037
- | new_on_board | query | boolean | No | 是否只看新上榜/Only new on board |
1038
- | commercial_music | query | boolean | No | 是否商业音乐/Commercial music only |
1039
- | country_code | query | string | No | 国家代码/Country code |
1040
-
1041
- #### Request Body
1042
-
1043
- None
1044
-
1045
- #### Success Response
1046
-
1047
- ##### `200 application/json`
1048
-
1049
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1050
-
1051
- | Field | Type | Required | Description |
1052
- | --- | --- | --- | --- |
1053
- | code | integer | No | HTTP status code \| HTTP状态码 |
1054
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1055
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1056
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1057
- | support | string | No | Support message \| 支持消息 |
1058
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1059
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1060
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1061
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1062
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1063
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1064
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1065
-
1066
- - Fields truncated: this layer shows only the first `12` rows.
1067
-
1068
- ### `GET /api/u1/v1/tiktok/ads/get_sound_recommendations`
1069
-
1070
- - Summary: 获取音乐推荐/Get sound recommendations
1071
- - Capabilities: ads
1072
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1073
- - operationId: `get_sound_recommendations_api_v1_tiktok_ads_get_sound_recommendations_get`
1074
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-recommendations`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-sound-recommendations)
1075
-
1076
- #### Parameters
1077
-
1078
- | Field | In | Type | Required | Description |
1079
- | --- | --- | --- | --- | --- |
1080
- | clip_id | query | string | Yes | 参考音乐ID/Reference sound clip ID |
1081
- | limit | query | integer | No | 推荐数量/Number of recommendations |
1082
-
1083
- #### Request Body
1084
-
1085
- None
1086
-
1087
- #### Success Response
1088
-
1089
- ##### `200 application/json`
1090
-
1091
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1092
-
1093
- | Field | Type | Required | Description |
1094
- | --- | --- | --- | --- |
1095
- | code | integer | No | HTTP status code \| HTTP状态码 |
1096
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1097
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1098
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1099
- | support | string | No | Support message \| 支持消息 |
1100
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1101
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1102
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1103
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1104
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1105
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1106
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1107
-
1108
- - Fields truncated: this layer shows only the first `12` rows.
1109
-
1110
- ### `GET /api/u1/v1/tiktok/ads/get_top_ads_spotlight`
1111
-
1112
- - Summary: 获取热门广告聚光灯/Get top ads spotlight
1113
- - Capabilities: ads
1114
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1115
- - operationId: `get_top_ads_spotlight_api_v1_tiktok_ads_get_top_ads_spotlight_get`
1116
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-top-ads-spotlight`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-top-ads-spotlight)
1117
-
1118
- #### Parameters
1119
-
1120
- | Field | In | Type | Required | Description |
1121
- | --- | --- | --- | --- | --- |
1122
- | industry | query | string | No | 行业ID/Industry ID |
1123
- | page | query | integer | No | 页码/Page number |
1124
- | limit | query | integer | No | 每页数量/Items per page |
1125
-
1126
- #### Request Body
1127
-
1128
- None
1129
-
1130
- #### Success Response
1131
-
1132
- ##### `200 application/json`
1133
-
1134
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1135
-
1136
- | Field | Type | Required | Description |
1137
- | --- | --- | --- | --- |
1138
- | code | integer | No | HTTP status code \| HTTP状态码 |
1139
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1140
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1141
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1142
- | support | string | No | Support message \| 支持消息 |
1143
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1144
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1145
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1146
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1147
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1148
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1149
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1150
-
1151
- - Fields truncated: this layer shows only the first `12` rows.
1152
-
1153
- ### `GET /api/u1/v1/tiktok/ads/get_top_products`
1154
-
1155
- - Summary: 获取热门产品列表/Get top products list
1156
- - Capabilities: commerce / ads
1157
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1158
- - operationId: `get_top_products_api_v1_tiktok_ads_get_top_products_get`
1159
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-top-products`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-get-top-products)
1160
-
1161
- #### Parameters
1162
-
1163
- | Field | In | Type | Required | Description |
1164
- | --- | --- | --- | --- | --- |
1165
- | last | query | integer | No | 最近天数/Last days |
1166
- | page | query | integer | No | 页码/Page number |
1167
- | limit | query | integer | No | 每页数量/Items per page |
1168
- | country_code | query | string | No | 国家代码/Country code |
1169
- | first_ecom_category_id | query | string | No | 电商类目ID,多个用逗号分隔/E-commerce category IDs, comma separated |
1170
- | ecom_type | query | string | No | 电商类型/E-commerce type (l3) |
1171
- | period_type | query | string | No | 时间类型/Period type (last) |
1172
- | order_by | query | string | No | 排序字段/Sort field (post, ctr, cvr) |
1173
- | order_type | query | string | No | 排序方式/Sort order (desc, asc) |
1174
-
1175
- #### Request Body
1176
-
1177
- None
1178
-
1179
- #### Success Response
1180
-
1181
- ##### `200 application/json`
1182
-
1183
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1184
-
1185
- | Field | Type | Required | Description |
1186
- | --- | --- | --- | --- |
1187
- | code | integer | No | HTTP status code \| HTTP状态码 |
1188
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1189
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1190
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1191
- | support | string | No | Support message \| 支持消息 |
1192
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1193
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1194
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1195
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1196
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1197
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1198
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1199
-
1200
- - Fields truncated: this layer shows only the first `12` rows.
1201
-
1202
- ### `GET /api/u1/v1/tiktok/ads/search_ads`
1203
-
1204
- - Summary: 搜索广告/Search ads
1205
- - Capabilities: search / ads
1206
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1207
- - operationId: `search_ads_api_v1_tiktok_ads_search_ads_get`
1208
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-ads`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-ads)
1209
-
1210
- #### Parameters
1211
-
1212
- | Field | In | Type | Required | Description |
1213
- | --- | --- | --- | --- | --- |
1214
- | objective | query | integer | No | 广告目标类型/Ad objective (1:流量 2:应用安装 3:转化 4:视频浏览 5:触达 6:潜在客户 7:产品销售) |
1215
- | like | query | integer | No | 表现排名/Performance rank (1:前1-20% 2:前21-40% 3:前41-60% 4:前61-80%) |
1216
- | period | query | integer | No | 时间段/Time period (days) |
1217
- | industry | query | string | No | 行业ID/Industry ID |
1218
- | keyword | query | string | No | 搜索关键词/Search keyword |
1219
- | page | query | integer | No | 页码/Page number |
1220
- | limit | query | integer | No | 每页数量/Items per page |
1221
- | order_by | query | string | No | 排序方式/Sort by (for_you, likes) |
1222
- | country_code | query | string | No | 国家代码/Country code |
1223
- | ad_format | query | integer | No | 广告格式/Ad format (1:视频) |
1224
- | ad_language | query | string | No | 广告语言/Ad language |
1225
- | search_id | query | string | No | 搜索ID(可选)/Search ID (optional) |
1226
-
1227
- #### Request Body
1228
-
1229
- None
1230
-
1231
- #### Success Response
1232
-
1233
- ##### `200 application/json`
1234
-
1235
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1236
-
1237
- | Field | Type | Required | Description |
1238
- | --- | --- | --- | --- |
1239
- | code | integer | No | HTTP status code \| HTTP状态码 |
1240
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1241
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1242
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1243
- | support | string | No | Support message \| 支持消息 |
1244
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1245
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1246
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1247
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1248
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1249
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1250
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1251
-
1252
- - Fields truncated: this layer shows only the first `12` rows.
1253
-
1254
- ### `GET /api/u1/v1/tiktok/ads/search_creators`
1255
-
1256
- - Summary: 搜索创作者/Search creators
1257
- - Capabilities: search / creators / ads
1258
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1259
- - operationId: `search_creators_api_v1_tiktok_ads_search_creators_get`
1260
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-creators`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-creators)
1261
-
1262
- #### Parameters
1263
-
1264
- | Field | In | Type | Required | Description |
1265
- | --- | --- | --- | --- | --- |
1266
- | keyword | query | string | Yes | 搜索关键词/Search keyword |
1267
- | page | query | integer | No | 页码/Page number |
1268
- | limit | query | integer | No | 每页数量/Items per page |
1269
- | sort_by | query | string | No | 排序方式/Sort by (follower, avg_views) |
1270
- | creator_country | query | string | No | 创作者国家/Creator country |
1271
-
1272
- #### Request Body
1273
-
1274
- None
1275
-
1276
- #### Success Response
1277
-
1278
- ##### `200 application/json`
1279
-
1280
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1281
-
1282
- | Field | Type | Required | Description |
1283
- | --- | --- | --- | --- |
1284
- | code | integer | No | HTTP status code \| HTTP状态码 |
1285
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1286
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1287
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1288
- | support | string | No | Support message \| 支持消息 |
1289
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1290
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1291
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1292
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1293
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1294
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1295
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1296
-
1297
- - Fields truncated: this layer shows only the first `12` rows.
1298
-
1299
- ### `GET /api/u1/v1/tiktok/ads/search_sound`
1300
-
1301
- - Summary: 搜索音乐/Search sounds
1302
- - Capabilities: search / ads
1303
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1304
- - operationId: `search_sound_api_v1_tiktok_ads_search_sound_get`
1305
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-sound`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-sound)
1306
-
1307
- #### Parameters
1308
-
1309
- | Field | In | Type | Required | Description |
1310
- | --- | --- | --- | --- | --- |
1311
- | keyword | query | string | Yes | 搜索关键词/Search keyword |
1312
- | period | query | integer | No | 时间范围(天)/Time period (days) |
1313
- | page | query | integer | No | 页码/Page number |
1314
- | limit | query | integer | No | 每页数量/Items per page |
1315
- | rank_type | query | string | No | 排行类型/Rank type (popular, surging) |
1316
- | new_on_board | query | boolean | No | 是否只看新上榜/Only new on board |
1317
- | commercial_music | query | boolean | No | 是否商业音乐/Commercial music only |
1318
- | country_code | query | string | No | 国家代码/Country code |
1319
-
1320
- #### Request Body
1321
-
1322
- None
1323
-
1324
- #### Success Response
1325
-
1326
- ##### `200 application/json`
1327
-
1328
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1329
-
1330
- | Field | Type | Required | Description |
1331
- | --- | --- | --- | --- |
1332
- | code | integer | No | HTTP status code \| HTTP状态码 |
1333
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1334
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1335
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1336
- | support | string | No | Support message \| 支持消息 |
1337
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1338
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1339
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1340
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1341
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1342
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1343
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1344
-
1345
- - Fields truncated: this layer shows only the first `12` rows.
1346
-
1347
- ### `GET /api/u1/v1/tiktok/ads/search_sound_hint`
1348
-
1349
- - Summary: 搜索音乐提示/Search sound hints
1350
- - Capabilities: search / ads
1351
- - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1352
- - operationId: `search_sound_hint_api_v1_tiktok_ads_search_sound_hint_get`
1353
- - Full contract: [`api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-sound-hint`](../api-contracts/tiktok-ads-api.md#get-api-u1-v1-tiktok-ads-search-sound-hint)
1354
-
1355
- #### Parameters
1356
-
1357
- | Field | In | Type | Required | Description |
1358
- | --- | --- | --- | --- | --- |
1359
- | keyword | query | string | Yes | 搜索关键词/Search keyword |
1360
- | period | query | integer | No | 时间范围(天)/Time period (days) |
1361
- | page | query | integer | No | 页码/Page number |
1362
- | limit | query | integer | No | 每页数量/Items per page |
1363
- | rank_type | query | string | No | 排行类型/Rank type (popular, surging) |
1364
- | country_code | query | string | No | 国家代码/Country code |
1365
- | filter_by_checked | query | boolean | No | 是否只看已验证/Only verified |
1366
- | commercial_music | query | boolean | No | 是否商业音乐/Commercial music only |
1367
-
1368
- #### Request Body
1369
-
1370
- None
1371
-
1372
- #### Success Response
1373
-
1374
- ##### `200 application/json`
1375
-
1376
- - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1377
-
1378
- | Field | Type | Required | Description |
1379
- | --- | --- | --- | --- |
1380
- | code | integer | No | HTTP status code \| HTTP状态码 |
1381
- | request_id | string | No | Unique request identifier \| 唯一请求标识符 |
1382
- | message | string | No | Response message (EN-US) \| 响应消息 (English) |
1383
- | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) |
1384
- | support | string | No | Support message \| 支持消息 |
1385
- | time | string | No | The time the response was generated \| 生成响应的时间 |
1386
- | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 |
1387
- | time_zone | string | No | The timezone of the response time \| 响应时间的时区 |
1388
- | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 |
1389
- | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) |
1390
- | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) |
1391
- | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL |
1392
-
1393
- - Fields truncated: this layer shows only the first `12` rows.