api-config.json 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. {
  2. "name": "keyword-product-ranking",
  3. "displayName": "关键词产品排名查询",
  4. "description": "查询指定关键词下的产品排名列表,获取该关键词搜索结果中的产品排序。用于竞品在关键词下的位置分析、广告优化。",
  5. "category": "voc",
  6. "version": "1.1.0",
  7. "endpoint": {
  8. "method": "POST",
  9. "url": "https://server.fmode.cn/api/voc/forward",
  10. "headers": {
  11. "Content-Type": "application/json",
  12. "Authorization": "Bearer r:858b3ee92314d5447d1fc3cdc10462d7"
  13. }
  14. },
  15. "parameters": {
  16. "type": "object",
  17. "required": [
  18. "Keyword"
  19. ],
  20. "properties": {
  21. "Keyword": {
  22. "type": "string",
  23. "description": "要查询排名的关键词,如 'reed diffuser'"
  24. },
  25. "domain": {
  26. "type": "integer",
  27. "description": "Amazon 站点 ID: 1=amazon.com",
  28. "default": 1
  29. }
  30. }
  31. },
  32. "requestTransform": {
  33. "template": {
  34. "path": "/api/KeywordProductRanking",
  35. "method": "POST",
  36. "query": {
  37. "domain": "{{domain}}"
  38. },
  39. "body": {
  40. "Keyword": "{{Keyword}}"
  41. }
  42. }
  43. },
  44. "response": {
  45. "type": "array",
  46. "description": "关键词下的产品排名列表",
  47. "items": {
  48. "type": "object",
  49. "properties": {
  50. "Asin": {
  51. "type": "string",
  52. "description": "产品 ASIN"
  53. },
  54. "Title": {
  55. "type": "string",
  56. "description": "产品标题"
  57. },
  58. "Rank": {
  59. "type": "integer",
  60. "description": "在该关键词下的排名"
  61. },
  62. "Price": {
  63. "type": "number",
  64. "description": "售价"
  65. },
  66. "Rating": {
  67. "type": "number",
  68. "description": "评分"
  69. },
  70. "RatingsCount": {
  71. "type": "integer",
  72. "description": "评论数"
  73. },
  74. "IsSponsored": {
  75. "type": "boolean",
  76. "description": "是否为广告产品"
  77. }
  78. }
  79. }
  80. },
  81. "usageExamples": [
  82. {
  83. "name": "查询关键词产品排名",
  84. "input": {
  85. "Keyword": "reed diffuser",
  86. "domain": 1
  87. },
  88. "description": "获取 'reed diffuser' 搜索结果页产品排名"
  89. }
  90. ],
  91. "reportMapping": {
  92. "slides": [
  93. "趋势雷达(Slide12)",
  94. "广告关键词引擎(Slide15)"
  95. ],
  96. "dataPoints": [
  97. "关键词排名",
  98. "竞品在关键词下的位置"
  99. ]
  100. },
  101. "timeout": 10000,
  102. "retry": {
  103. "maxAttempts": 3,
  104. "delay": 1000,
  105. "backoffMultiplier": 2
  106. }
  107. }