dataforseo-client 2.1.9 → 2.1.11

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 (309) hide show
  1. package/dist/cjs/api/AiOptimizationApi.js +54 -54
  2. package/dist/cjs/api/AiOptimizationApi.js.map +1 -1
  3. package/dist/cjs/api/AppDataApi.js +42 -42
  4. package/dist/cjs/api/AppDataApi.js.map +1 -1
  5. package/dist/cjs/api/AppendixApi.js +4 -4
  6. package/dist/cjs/api/AppendixApi.js.map +1 -1
  7. package/dist/cjs/api/BacklinksApi.js +24 -24
  8. package/dist/cjs/api/BacklinksApi.js.map +1 -1
  9. package/dist/cjs/api/BusinessDataApi.js +53 -53
  10. package/dist/cjs/api/BusinessDataApi.js.map +1 -1
  11. package/dist/cjs/api/ContentAnalysisApi.js +11 -11
  12. package/dist/cjs/api/ContentAnalysisApi.js.map +1 -1
  13. package/dist/cjs/api/DataforseoLabsApi.js +48 -48
  14. package/dist/cjs/api/DataforseoLabsApi.js.map +1 -1
  15. package/dist/cjs/api/DomainAnalyticsApi.js +14 -14
  16. package/dist/cjs/api/DomainAnalyticsApi.js.map +1 -1
  17. package/dist/cjs/api/KeywordsDataApi.js +70 -70
  18. package/dist/cjs/api/KeywordsDataApi.js.map +1 -1
  19. package/dist/cjs/api/MerchantApi.js +38 -38
  20. package/dist/cjs/api/MerchantApi.js.map +1 -1
  21. package/dist/cjs/api/OnPageApi.js +31 -31
  22. package/dist/cjs/api/OnPageApi.js.map +1 -1
  23. package/dist/cjs/api/SerpApi.js +176 -176
  24. package/dist/cjs/api/SerpApi.js.map +1 -1
  25. package/dist/cjs/index.d.ts +14 -11
  26. package/dist/cjs/index.js +206 -200
  27. package/dist/cjs/index.js.map +1 -1
  28. package/dist/cjs/models/AiModeAiOverviewShoppingElementInfo.d.ts +8 -0
  29. package/dist/cjs/models/AiModeAiOverviewShoppingElementInfo.js +4 -0
  30. package/dist/cjs/models/AiModeAiOverviewShoppingElementInfo.js.map +1 -1
  31. package/dist/cjs/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.d.ts +5 -0
  32. package/dist/cjs/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js +16 -0
  33. package/dist/cjs/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js.map +1 -1
  34. package/dist/cjs/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.d.ts +5 -0
  35. package/dist/cjs/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js +16 -0
  36. package/dist/cjs/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js.map +1 -1
  37. package/dist/cjs/models/AiOptimizationChatGptLlmScraperLiveAdvancedRequestInfo.d.ts +4 -4
  38. package/dist/cjs/models/AiOptimizationChatGptLlmScraperLiveAdvancedResultInfo.d.ts +6 -6
  39. package/dist/cjs/models/AiOptimizationChatGptLlmScraperLiveHtmlRequestInfo.d.ts +4 -4
  40. package/dist/cjs/models/AiOptimizationChatGptLlmScraperLiveHtmlResultInfo.d.ts +2 -2
  41. package/dist/cjs/models/AiOptimizationChatGptLlmScraperTaskGetAdvancedResultInfo.d.ts +4 -4
  42. package/dist/cjs/models/AiOptimizationChatGptLlmScraperTaskGetHtmlResultInfo.d.ts +2 -2
  43. package/dist/cjs/models/AiOptimizationChatGptLlmScraperTaskPostRequestInfo.d.ts +6 -6
  44. package/dist/cjs/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.d.ts +5 -0
  45. package/dist/cjs/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js +16 -0
  46. package/dist/cjs/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js.map +1 -1
  47. package/dist/cjs/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.d.ts +9 -0
  48. package/dist/cjs/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js +18 -0
  49. package/dist/cjs/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js.map +1 -1
  50. package/dist/cjs/models/AiOptimizationGeminiLlmScraperLiveAdvancedRequestInfo.d.ts +2 -2
  51. package/dist/cjs/models/AiOptimizationGeminiLlmScraperLiveAdvancedResultInfo.d.ts +6 -6
  52. package/dist/cjs/models/AiOptimizationGeminiLlmScraperLiveHtmlRequestInfo.d.ts +2 -2
  53. package/dist/cjs/models/AiOptimizationGeminiLlmScraperLiveHtmlResultInfo.d.ts +2 -2
  54. package/dist/cjs/models/AiOptimizationGeminiLlmScraperTaskGetAdvancedResultInfo.d.ts +4 -4
  55. package/dist/cjs/models/AiOptimizationGeminiLlmScraperTaskGetHtmlResultInfo.d.ts +2 -2
  56. package/dist/cjs/models/AiOptimizationGeminiLlmScraperTaskPostRequestInfo.d.ts +4 -4
  57. package/dist/cjs/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.d.ts +3 -3
  58. package/dist/cjs/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js +2 -2
  59. package/dist/cjs/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js.map +1 -1
  60. package/dist/cjs/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.d.ts +7 -2
  61. package/dist/cjs/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js +16 -0
  62. package/dist/cjs/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js.map +1 -1
  63. package/dist/cjs/models/AppendixDayStatisticsDataInfo.d.ts +78 -0
  64. package/dist/cjs/models/AppendixDayStatisticsDataInfo.js +98 -0
  65. package/dist/cjs/models/AppendixDayStatisticsDataInfo.js.map +1 -0
  66. package/dist/cjs/models/AppendixMinuteStatisticsRatesData.d.ts +78 -0
  67. package/dist/cjs/models/AppendixMinuteStatisticsRatesData.js +98 -0
  68. package/dist/cjs/models/AppendixMinuteStatisticsRatesData.js.map +1 -0
  69. package/dist/cjs/models/AppendixStatisticsMoneyData.d.ts +15 -0
  70. package/dist/cjs/models/AppendixStatisticsMoneyData.js +39 -0
  71. package/dist/cjs/models/AppendixStatisticsMoneyData.js.map +1 -0
  72. package/dist/cjs/models/AppendixStatisticsRatesData.d.ts +16 -0
  73. package/dist/cjs/models/AppendixStatisticsRatesData.js +40 -0
  74. package/dist/cjs/models/AppendixStatisticsRatesData.js.map +1 -0
  75. package/dist/cjs/models/BacklinksDomainIntersection.d.ts +6 -2
  76. package/dist/cjs/models/BaseChatGptLlmScraperElementItem.d.ts +4 -4
  77. package/dist/cjs/models/BaseDataforseoLabsApiElementItem.d.ts +136 -136
  78. package/dist/cjs/models/BaseDataforseoLabsApiElementItem.js +92 -92
  79. package/dist/cjs/models/BaseDataforseoLabsApiElementItem.js.map +1 -1
  80. package/dist/cjs/models/BaseGeminiLlmScraperElementItem.d.ts +6 -6
  81. package/dist/cjs/models/BaseSerpApiAiModeAiOverviewElementItem.d.ts +22 -4
  82. package/dist/cjs/models/BaseSerpApiAiModeAiOverviewElementItem.js +36 -1
  83. package/dist/cjs/models/BaseSerpApiAiModeAiOverviewElementItem.js.map +1 -1
  84. package/dist/cjs/models/BaseSerpApiAiOverviewElementItem.d.ts +16 -0
  85. package/dist/cjs/models/BaseSerpApiAiOverviewElementItem.js +36 -1
  86. package/dist/cjs/models/BaseSerpApiAiOverviewElementItem.js.map +1 -1
  87. package/dist/cjs/models/BaseSerpApiElementItem.d.ts +8 -8
  88. package/dist/cjs/models/BaseSerpApiProductConsiderationExpandedElementItem.d.ts +2 -0
  89. package/dist/cjs/models/BaseSerpApiProductConsiderationExpandedElementItem.js.map +1 -1
  90. package/dist/cjs/models/DataforseoLabsGooglePageIntersectionLiveRequestInfo.d.ts +2 -2
  91. package/dist/cjs/models/HotelsPackElement.d.ts +8 -0
  92. package/dist/cjs/models/HotelsPackElement.js +4 -0
  93. package/dist/cjs/models/HotelsPackElement.js.map +1 -1
  94. package/dist/cjs/models/ItemsSearchResults.d.ts +38 -0
  95. package/dist/cjs/models/ItemsSearchResults.js +47 -0
  96. package/dist/cjs/models/ItemsSearchResults.js.map +1 -0
  97. package/dist/cjs/models/KnowledgeGraphHotelsBookingElement.d.ts +2 -2
  98. package/dist/cjs/models/OnPageLighthouseTaskGetJsonTaskInfo.d.ts +2 -0
  99. package/dist/cjs/models/OnPageLighthouseTaskGetJsonTaskInfo.js.map +1 -1
  100. package/dist/cjs/models/OnPageTaskPostRequestInfo.d.ts +4 -4
  101. package/dist/cjs/models/PopularProductsElement.d.ts +8 -0
  102. package/dist/cjs/models/PopularProductsElement.js +4 -0
  103. package/dist/cjs/models/PopularProductsElement.js.map +1 -1
  104. package/dist/cjs/models/RelatedResult.d.ts +2 -2
  105. package/dist/cjs/models/SearchResults.d.ts +12 -24
  106. package/dist/cjs/models/SearchResults.js +4 -10
  107. package/dist/cjs/models/SearchResults.js.map +1 -1
  108. package/dist/cjs/models/SerpGoogleAiModeLiveAdvancedRequestInfo.d.ts +2 -2
  109. package/dist/cjs/models/SerpGoogleAiModeLiveHtmlRequestInfo.d.ts +8 -8
  110. package/dist/cjs/models/SerpGoogleAiModeTaskPostRequestInfo.d.ts +2 -2
  111. package/dist/cjs/models/SerpGoogleMapsLiveAdvancedRequestInfo.d.ts +2 -2
  112. package/dist/cjs/models/SerpGoogleMapsTaskPostRequestInfo.d.ts +2 -2
  113. package/dist/cjs/models/SerpGoogleOrganicLiveAdvancedRequestInfo.d.ts +56 -56
  114. package/dist/cjs/models/SerpGoogleOrganicLiveAdvancedResponseInfo.d.ts +2 -2
  115. package/dist/cjs/models/SerpGoogleOrganicLiveAdvancedResultInfo.d.ts +26 -26
  116. package/dist/cjs/models/SerpGoogleOrganicLiveAdvancedTaskInfo.d.ts +2 -2
  117. package/dist/cjs/models/SerpNaverOrganicTaskPostRequestInfo.d.ts +2 -2
  118. package/dist/cjs/models/SerpYahooOrganicLiveAdvancedRequestInfo.d.ts +38 -30
  119. package/dist/cjs/models/SerpYahooOrganicLiveAdvancedRequestInfo.js +4 -0
  120. package/dist/cjs/models/SerpYahooOrganicLiveAdvancedRequestInfo.js.map +1 -1
  121. package/dist/cjs/models/SerpYahooOrganicLiveAdvancedResponseInfo.d.ts +2 -2
  122. package/dist/cjs/models/SerpYahooOrganicLiveAdvancedResultInfo.d.ts +26 -26
  123. package/dist/cjs/models/SerpYahooOrganicLiveAdvancedTaskInfo.d.ts +2 -2
  124. package/dist/cjs/models/SerpYahooOrganicTaskGetAdvancedResponseInfo.d.ts +2 -2
  125. package/dist/cjs/models/SerpYahooOrganicTaskGetAdvancedResultInfo.d.ts +26 -26
  126. package/dist/cjs/models/SerpYahooOrganicTaskGetAdvancedTaskInfo.d.ts +2 -2
  127. package/dist/cjs/models/SerpYoutubeOrganicLiveAdvancedRequestInfo.d.ts +20 -20
  128. package/dist/cjs/models/SerpYoutubeOrganicLiveAdvancedResponseInfo.d.ts +2 -2
  129. package/dist/cjs/models/SerpYoutubeOrganicLiveAdvancedResultInfo.d.ts +22 -22
  130. package/dist/cjs/models/SerpYoutubeOrganicLiveAdvancedTaskInfo.d.ts +2 -2
  131. package/dist/cjs/models/SerpYoutubeOrganicTaskPostRequestInfo.d.ts +28 -28
  132. package/dist/cjs/models/SerpYoutubeOrganicTaskPostResponseInfo.d.ts +2 -2
  133. package/dist/cjs/models/SerpYoutubeOrganicTaskPostTaskInfo.d.ts +2 -2
  134. package/dist/cjs/models/SerpYoutubeVideoCommentsTaskPostRequestInfo.d.ts +26 -26
  135. package/dist/cjs/models/SerpYoutubeVideoCommentsTaskPostResponseInfo.d.ts +2 -2
  136. package/dist/cjs/models/SerpYoutubeVideoCommentsTaskPostTaskInfo.d.ts +2 -2
  137. package/dist/cjs/models/SerpYoutubeVideoInfoLiveAdvancedRequestInfo.d.ts +16 -16
  138. package/dist/cjs/models/SerpYoutubeVideoInfoLiveAdvancedResponseInfo.d.ts +2 -2
  139. package/dist/cjs/models/SerpYoutubeVideoInfoLiveAdvancedResultInfo.d.ts +20 -20
  140. package/dist/cjs/models/SerpYoutubeVideoInfoLiveAdvancedTaskInfo.d.ts +2 -2
  141. package/dist/cjs/models/SerpYoutubeVideoInfoTaskPostRequestInfo.d.ts +24 -24
  142. package/dist/cjs/models/SerpYoutubeVideoInfoTaskPostResponseInfo.d.ts +2 -2
  143. package/dist/cjs/models/SerpYoutubeVideoInfoTaskPostTaskInfo.d.ts +2 -2
  144. package/dist/cjs/models/SerpYoutubeVideoSubtitlesLiveAdvancedRequestInfo.d.ts +20 -20
  145. package/dist/cjs/models/SerpYoutubeVideoSubtitlesLiveAdvancedResponseInfo.d.ts +2 -2
  146. package/dist/cjs/models/SerpYoutubeVideoSubtitlesLiveAdvancedResultInfo.d.ts +32 -32
  147. package/dist/cjs/models/SerpYoutubeVideoSubtitlesLiveAdvancedTaskInfo.d.ts +2 -2
  148. package/dist/cjs/models/SerpYoutubeVideoSubtitlesTaskPostRequestInfo.d.ts +28 -28
  149. package/dist/cjs/models/SerpYoutubeVideoSubtitlesTaskPostResponseInfo.d.ts +2 -2
  150. package/dist/cjs/models/SerpYoutubeVideoSubtitlesTaskPostTaskInfo.d.ts +2 -2
  151. package/dist/cjs/models/SourceInfo.d.ts +4 -4
  152. package/dist/cjs/models/index.d.ts +14 -11
  153. package/dist/cjs/models/index.js +206 -199
  154. package/dist/cjs/models/index.js.map +1 -1
  155. package/dist/esm/api/AiOptimizationApi.js +54 -54
  156. package/dist/esm/api/AiOptimizationApi.js.map +1 -1
  157. package/dist/esm/api/AppDataApi.js +42 -42
  158. package/dist/esm/api/AppDataApi.js.map +1 -1
  159. package/dist/esm/api/AppendixApi.js +4 -4
  160. package/dist/esm/api/AppendixApi.js.map +1 -1
  161. package/dist/esm/api/BacklinksApi.js +24 -24
  162. package/dist/esm/api/BacklinksApi.js.map +1 -1
  163. package/dist/esm/api/BusinessDataApi.js +53 -53
  164. package/dist/esm/api/BusinessDataApi.js.map +1 -1
  165. package/dist/esm/api/ContentAnalysisApi.js +11 -11
  166. package/dist/esm/api/ContentAnalysisApi.js.map +1 -1
  167. package/dist/esm/api/DataforseoLabsApi.js +48 -48
  168. package/dist/esm/api/DataforseoLabsApi.js.map +1 -1
  169. package/dist/esm/api/DomainAnalyticsApi.js +14 -14
  170. package/dist/esm/api/DomainAnalyticsApi.js.map +1 -1
  171. package/dist/esm/api/KeywordsDataApi.js +70 -70
  172. package/dist/esm/api/KeywordsDataApi.js.map +1 -1
  173. package/dist/esm/api/MerchantApi.js +38 -38
  174. package/dist/esm/api/MerchantApi.js.map +1 -1
  175. package/dist/esm/api/OnPageApi.js +31 -31
  176. package/dist/esm/api/OnPageApi.js.map +1 -1
  177. package/dist/esm/api/SerpApi.js +176 -176
  178. package/dist/esm/api/SerpApi.js.map +1 -1
  179. package/dist/esm/index.d.ts +14 -11
  180. package/dist/esm/index.js +14 -11
  181. package/dist/esm/index.js.map +1 -1
  182. package/dist/esm/models/AiModeAiOverviewShoppingElementInfo.d.ts +8 -0
  183. package/dist/esm/models/AiModeAiOverviewShoppingElementInfo.js +4 -0
  184. package/dist/esm/models/AiModeAiOverviewShoppingElementInfo.js.map +1 -1
  185. package/dist/esm/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.d.ts +5 -0
  186. package/dist/esm/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js +16 -0
  187. package/dist/esm/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js.map +1 -1
  188. package/dist/esm/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.d.ts +5 -0
  189. package/dist/esm/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js +16 -0
  190. package/dist/esm/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js.map +1 -1
  191. package/dist/esm/models/AiOptimizationChatGptLlmScraperLiveAdvancedRequestInfo.d.ts +4 -4
  192. package/dist/esm/models/AiOptimizationChatGptLlmScraperLiveAdvancedResultInfo.d.ts +6 -6
  193. package/dist/esm/models/AiOptimizationChatGptLlmScraperLiveHtmlRequestInfo.d.ts +4 -4
  194. package/dist/esm/models/AiOptimizationChatGptLlmScraperLiveHtmlResultInfo.d.ts +2 -2
  195. package/dist/esm/models/AiOptimizationChatGptLlmScraperTaskGetAdvancedResultInfo.d.ts +4 -4
  196. package/dist/esm/models/AiOptimizationChatGptLlmScraperTaskGetHtmlResultInfo.d.ts +2 -2
  197. package/dist/esm/models/AiOptimizationChatGptLlmScraperTaskPostRequestInfo.d.ts +6 -6
  198. package/dist/esm/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.d.ts +5 -0
  199. package/dist/esm/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js +16 -0
  200. package/dist/esm/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js.map +1 -1
  201. package/dist/esm/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.d.ts +9 -0
  202. package/dist/esm/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js +18 -0
  203. package/dist/esm/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js.map +1 -1
  204. package/dist/esm/models/AiOptimizationGeminiLlmScraperLiveAdvancedRequestInfo.d.ts +2 -2
  205. package/dist/esm/models/AiOptimizationGeminiLlmScraperLiveAdvancedResultInfo.d.ts +6 -6
  206. package/dist/esm/models/AiOptimizationGeminiLlmScraperLiveHtmlRequestInfo.d.ts +2 -2
  207. package/dist/esm/models/AiOptimizationGeminiLlmScraperLiveHtmlResultInfo.d.ts +2 -2
  208. package/dist/esm/models/AiOptimizationGeminiLlmScraperTaskGetAdvancedResultInfo.d.ts +4 -4
  209. package/dist/esm/models/AiOptimizationGeminiLlmScraperTaskGetHtmlResultInfo.d.ts +2 -2
  210. package/dist/esm/models/AiOptimizationGeminiLlmScraperTaskPostRequestInfo.d.ts +4 -4
  211. package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.d.ts +3 -3
  212. package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js +2 -2
  213. package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js.map +1 -1
  214. package/dist/esm/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.d.ts +7 -2
  215. package/dist/esm/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js +16 -0
  216. package/dist/esm/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js.map +1 -1
  217. package/dist/esm/models/AppendixDayStatisticsDataInfo.d.ts +78 -0
  218. package/dist/esm/models/AppendixDayStatisticsDataInfo.js +94 -0
  219. package/dist/esm/models/AppendixDayStatisticsDataInfo.js.map +1 -0
  220. package/dist/esm/models/AppendixMinuteStatisticsRatesData.d.ts +78 -0
  221. package/dist/esm/models/AppendixMinuteStatisticsRatesData.js +94 -0
  222. package/dist/esm/models/AppendixMinuteStatisticsRatesData.js.map +1 -0
  223. package/dist/esm/models/AppendixStatisticsMoneyData.d.ts +15 -0
  224. package/dist/esm/models/AppendixStatisticsMoneyData.js +35 -0
  225. package/dist/esm/models/AppendixStatisticsMoneyData.js.map +1 -0
  226. package/dist/esm/models/AppendixStatisticsRatesData.d.ts +16 -0
  227. package/dist/esm/models/AppendixStatisticsRatesData.js +36 -0
  228. package/dist/esm/models/AppendixStatisticsRatesData.js.map +1 -0
  229. package/dist/esm/models/BacklinksDomainIntersection.d.ts +6 -2
  230. package/dist/esm/models/BaseChatGptLlmScraperElementItem.d.ts +4 -4
  231. package/dist/esm/models/BaseDataforseoLabsApiElementItem.d.ts +136 -136
  232. package/dist/esm/models/BaseDataforseoLabsApiElementItem.js +88 -88
  233. package/dist/esm/models/BaseDataforseoLabsApiElementItem.js.map +1 -1
  234. package/dist/esm/models/BaseGeminiLlmScraperElementItem.d.ts +6 -6
  235. package/dist/esm/models/BaseSerpApiAiModeAiOverviewElementItem.d.ts +22 -4
  236. package/dist/esm/models/BaseSerpApiAiModeAiOverviewElementItem.js +34 -0
  237. package/dist/esm/models/BaseSerpApiAiModeAiOverviewElementItem.js.map +1 -1
  238. package/dist/esm/models/BaseSerpApiAiOverviewElementItem.d.ts +16 -0
  239. package/dist/esm/models/BaseSerpApiAiOverviewElementItem.js +34 -0
  240. package/dist/esm/models/BaseSerpApiAiOverviewElementItem.js.map +1 -1
  241. package/dist/esm/models/BaseSerpApiElementItem.d.ts +8 -8
  242. package/dist/esm/models/BaseSerpApiProductConsiderationExpandedElementItem.d.ts +2 -0
  243. package/dist/esm/models/BaseSerpApiProductConsiderationExpandedElementItem.js.map +1 -1
  244. package/dist/esm/models/DataforseoLabsGooglePageIntersectionLiveRequestInfo.d.ts +2 -2
  245. package/dist/esm/models/HotelsPackElement.d.ts +8 -0
  246. package/dist/esm/models/HotelsPackElement.js +4 -0
  247. package/dist/esm/models/HotelsPackElement.js.map +1 -1
  248. package/dist/esm/models/ItemsSearchResults.d.ts +38 -0
  249. package/dist/esm/models/ItemsSearchResults.js +43 -0
  250. package/dist/esm/models/ItemsSearchResults.js.map +1 -0
  251. package/dist/esm/models/KnowledgeGraphHotelsBookingElement.d.ts +2 -2
  252. package/dist/esm/models/OnPageLighthouseTaskGetJsonTaskInfo.d.ts +2 -0
  253. package/dist/esm/models/OnPageLighthouseTaskGetJsonTaskInfo.js.map +1 -1
  254. package/dist/esm/models/OnPageTaskPostRequestInfo.d.ts +4 -4
  255. package/dist/esm/models/PopularProductsElement.d.ts +8 -0
  256. package/dist/esm/models/PopularProductsElement.js +4 -0
  257. package/dist/esm/models/PopularProductsElement.js.map +1 -1
  258. package/dist/esm/models/RelatedResult.d.ts +2 -2
  259. package/dist/esm/models/SearchResults.d.ts +12 -24
  260. package/dist/esm/models/SearchResults.js +4 -10
  261. package/dist/esm/models/SearchResults.js.map +1 -1
  262. package/dist/esm/models/SerpGoogleAiModeLiveAdvancedRequestInfo.d.ts +2 -2
  263. package/dist/esm/models/SerpGoogleAiModeLiveHtmlRequestInfo.d.ts +8 -8
  264. package/dist/esm/models/SerpGoogleAiModeTaskPostRequestInfo.d.ts +2 -2
  265. package/dist/esm/models/SerpGoogleMapsLiveAdvancedRequestInfo.d.ts +2 -2
  266. package/dist/esm/models/SerpGoogleMapsTaskPostRequestInfo.d.ts +2 -2
  267. package/dist/esm/models/SerpGoogleOrganicLiveAdvancedRequestInfo.d.ts +56 -56
  268. package/dist/esm/models/SerpGoogleOrganicLiveAdvancedResponseInfo.d.ts +2 -2
  269. package/dist/esm/models/SerpGoogleOrganicLiveAdvancedResultInfo.d.ts +26 -26
  270. package/dist/esm/models/SerpGoogleOrganicLiveAdvancedTaskInfo.d.ts +2 -2
  271. package/dist/esm/models/SerpNaverOrganicTaskPostRequestInfo.d.ts +2 -2
  272. package/dist/esm/models/SerpYahooOrganicLiveAdvancedRequestInfo.d.ts +38 -30
  273. package/dist/esm/models/SerpYahooOrganicLiveAdvancedRequestInfo.js +4 -0
  274. package/dist/esm/models/SerpYahooOrganicLiveAdvancedRequestInfo.js.map +1 -1
  275. package/dist/esm/models/SerpYahooOrganicLiveAdvancedResponseInfo.d.ts +2 -2
  276. package/dist/esm/models/SerpYahooOrganicLiveAdvancedResultInfo.d.ts +26 -26
  277. package/dist/esm/models/SerpYahooOrganicLiveAdvancedTaskInfo.d.ts +2 -2
  278. package/dist/esm/models/SerpYahooOrganicTaskGetAdvancedResponseInfo.d.ts +2 -2
  279. package/dist/esm/models/SerpYahooOrganicTaskGetAdvancedResultInfo.d.ts +26 -26
  280. package/dist/esm/models/SerpYahooOrganicTaskGetAdvancedTaskInfo.d.ts +2 -2
  281. package/dist/esm/models/SerpYoutubeOrganicLiveAdvancedRequestInfo.d.ts +20 -20
  282. package/dist/esm/models/SerpYoutubeOrganicLiveAdvancedResponseInfo.d.ts +2 -2
  283. package/dist/esm/models/SerpYoutubeOrganicLiveAdvancedResultInfo.d.ts +22 -22
  284. package/dist/esm/models/SerpYoutubeOrganicLiveAdvancedTaskInfo.d.ts +2 -2
  285. package/dist/esm/models/SerpYoutubeOrganicTaskPostRequestInfo.d.ts +28 -28
  286. package/dist/esm/models/SerpYoutubeOrganicTaskPostResponseInfo.d.ts +2 -2
  287. package/dist/esm/models/SerpYoutubeOrganicTaskPostTaskInfo.d.ts +2 -2
  288. package/dist/esm/models/SerpYoutubeVideoCommentsTaskPostRequestInfo.d.ts +26 -26
  289. package/dist/esm/models/SerpYoutubeVideoCommentsTaskPostResponseInfo.d.ts +2 -2
  290. package/dist/esm/models/SerpYoutubeVideoCommentsTaskPostTaskInfo.d.ts +2 -2
  291. package/dist/esm/models/SerpYoutubeVideoInfoLiveAdvancedRequestInfo.d.ts +16 -16
  292. package/dist/esm/models/SerpYoutubeVideoInfoLiveAdvancedResponseInfo.d.ts +2 -2
  293. package/dist/esm/models/SerpYoutubeVideoInfoLiveAdvancedResultInfo.d.ts +20 -20
  294. package/dist/esm/models/SerpYoutubeVideoInfoLiveAdvancedTaskInfo.d.ts +2 -2
  295. package/dist/esm/models/SerpYoutubeVideoInfoTaskPostRequestInfo.d.ts +24 -24
  296. package/dist/esm/models/SerpYoutubeVideoInfoTaskPostResponseInfo.d.ts +2 -2
  297. package/dist/esm/models/SerpYoutubeVideoInfoTaskPostTaskInfo.d.ts +2 -2
  298. package/dist/esm/models/SerpYoutubeVideoSubtitlesLiveAdvancedRequestInfo.d.ts +20 -20
  299. package/dist/esm/models/SerpYoutubeVideoSubtitlesLiveAdvancedResponseInfo.d.ts +2 -2
  300. package/dist/esm/models/SerpYoutubeVideoSubtitlesLiveAdvancedResultInfo.d.ts +32 -32
  301. package/dist/esm/models/SerpYoutubeVideoSubtitlesLiveAdvancedTaskInfo.d.ts +2 -2
  302. package/dist/esm/models/SerpYoutubeVideoSubtitlesTaskPostRequestInfo.d.ts +28 -28
  303. package/dist/esm/models/SerpYoutubeVideoSubtitlesTaskPostResponseInfo.d.ts +2 -2
  304. package/dist/esm/models/SerpYoutubeVideoSubtitlesTaskPostTaskInfo.d.ts +2 -2
  305. package/dist/esm/models/SourceInfo.d.ts +4 -4
  306. package/dist/esm/models/index.d.ts +14 -11
  307. package/dist/esm/models/index.js +14 -11
  308. package/dist/esm/models/index.js.map +1 -1
  309. package/package.json +1 -1
@@ -1,12 +1,12 @@
1
1
  import { SerpYahooOrganicTaskGetAdvancedResultInfo } from "./SerpYahooOrganicTaskGetAdvancedResultInfo";
2
2
  import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
3
3
  export interface ISerpYahooOrganicTaskGetAdvancedTaskInfo extends IBaseResponseTaskInfo {
4
- /** *array of results* */
4
+ /** array of results */
5
5
  result?: SerpYahooOrganicTaskGetAdvancedResultInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class SerpYahooOrganicTaskGetAdvancedTaskInfo extends BaseResponseTaskInfo implements ISerpYahooOrganicTaskGetAdvancedTaskInfo {
9
- /** *array of results* */
9
+ /** array of results */
10
10
  result?: SerpYahooOrganicTaskGetAdvancedResultInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: ISerpYahooOrganicTaskGetAdvancedTaskInfo);
@@ -1,46 +1,46 @@
1
1
  export interface ISerpYoutubeOrganicLiveAdvancedRequestInfo {
2
- /** keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
2
+ /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
3
3
  keyword?: string | undefined;
4
- /** search engine location code required field if you don't specify location_name  if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: 2840 */
4
+ /** *search engine location code* **required field if you don't specify** `location_name`  **if you use this field, you don't need to specify `location_name`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `2840` */
5
5
  location_code?: number | undefined;
6
- /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: en */
6
+ /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages`**example:**`en` */
7
7
  language_code?: string | undefined;
8
- /** device type optional field return results for a specific device type available values: desktop, mobile */
8
+ /** *device type* optional field return results for a specific device type available values: `desktop`, `mobile` */
9
9
  device?: string | undefined;
10
- /** parsing depth optional field number of blocks of results in SERP default value: 20 max value: 200 Note: your account will be billed per each SERP containing up to 20 results; thus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
10
+ /** *parsing depth* optional field number of blocks of results in SERP default value: `20` max value: `200` **Note:** your account will be billed per each SERP containing up to 20 results; thus, setting a block depth above `20` may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
11
11
  block_depth?: number | undefined;
12
- /** full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: United States */
12
+ /** *full name of search engine location* **required field if you don't specify** `location_code` **if you use this field, you don't need to specify `location_code`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `United States` */
13
13
  location_name?: string | undefined;
14
- /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: English */
14
+ /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages` example: `English` */
15
15
  language_name?: string | undefined;
16
- /** device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android */
16
+ /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
17
17
  os?: string | undefined;
18
- /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
18
+ /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
19
19
  tag?: string | undefined;
20
- /** additional parameters of the search query optional field example: sp=EgIQAg%253D%253D */
20
+ /** *additional parameters of the search query* optional field example: `sp=EgIQAg%253D%253D` */
21
21
  search_param?: string | undefined;
22
22
  [key: string]: any;
23
23
  }
24
24
  export declare class SerpYoutubeOrganicLiveAdvancedRequestInfo implements ISerpYoutubeOrganicLiveAdvancedRequestInfo {
25
- /** keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
25
+ /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
26
26
  keyword?: string | undefined;
27
- /** search engine location code required field if you don't specify location_name  if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: 2840 */
27
+ /** *search engine location code* **required field if you don't specify** `location_name`  **if you use this field, you don't need to specify `location_name`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `2840` */
28
28
  location_code?: number | undefined;
29
- /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: en */
29
+ /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages`**example:**`en` */
30
30
  language_code?: string | undefined;
31
- /** device type optional field return results for a specific device type available values: desktop, mobile */
31
+ /** *device type* optional field return results for a specific device type available values: `desktop`, `mobile` */
32
32
  device?: string | undefined;
33
- /** parsing depth optional field number of blocks of results in SERP default value: 20 max value: 200 Note: your account will be billed per each SERP containing up to 20 results; thus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
33
+ /** *parsing depth* optional field number of blocks of results in SERP default value: `20` max value: `200` **Note:** your account will be billed per each SERP containing up to 20 results; thus, setting a block depth above `20` may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
34
34
  block_depth?: number | undefined;
35
- /** full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: United States */
35
+ /** *full name of search engine location* **required field if you don't specify** `location_code` **if you use this field, you don't need to specify `location_code`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `United States` */
36
36
  location_name?: string | undefined;
37
- /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: English */
37
+ /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages` example: `English` */
38
38
  language_name?: string | undefined;
39
- /** device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android */
39
+ /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
40
40
  os?: string | undefined;
41
- /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
41
+ /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
42
42
  tag?: string | undefined;
43
- /** additional parameters of the search query optional field example: sp=EgIQAg%253D%253D */
43
+ /** *additional parameters of the search query* optional field example: `sp=EgIQAg%253D%253D` */
44
44
  search_param?: string | undefined;
45
45
  [key: string]: any;
46
46
  constructor(data?: ISerpYoutubeOrganicLiveAdvancedRequestInfo);
@@ -1,12 +1,12 @@
1
1
  import { SerpYoutubeOrganicLiveAdvancedTaskInfo } from "./SerpYoutubeOrganicLiveAdvancedTaskInfo";
2
2
  import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
3
3
  export interface ISerpYoutubeOrganicLiveAdvancedResponseInfo extends IBaseResponseInfo {
4
- /** array of tasks */
4
+ /** *array of tasks* */
5
5
  tasks?: SerpYoutubeOrganicLiveAdvancedTaskInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class SerpYoutubeOrganicLiveAdvancedResponseInfo extends BaseResponseInfo implements ISerpYoutubeOrganicLiveAdvancedResponseInfo {
9
- /** array of tasks */
9
+ /** *array of tasks* */
10
10
  tasks?: SerpYoutubeOrganicLiveAdvancedTaskInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: ISerpYoutubeOrganicLiveAdvancedResponseInfo);
@@ -1,52 +1,52 @@
1
1
  import { SpellInfo } from "./SpellInfo";
2
2
  import { BaseSerpApiYoutubeOrganicElementItem } from "./BaseSerpApiYoutubeOrganicElementItem";
3
3
  export interface ISerpYoutubeOrganicLiveAdvancedResultInfo {
4
- /** keyword received in a POST array the keyword is returned with decoded %## (plus character '+' will be decoded to a space character) */
4
+ /** *keyword received in a POST array***the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)** */
5
5
  keyword?: string | undefined;
6
- /** search engine domain in a POST array */
6
+ /** *search engine domain in a POST array* */
7
7
  se_domain?: string | undefined;
8
- /** location code in a POST array */
8
+ /** *location code in a POST array* */
9
9
  location_code?: number | undefined;
10
- /** language code in a POST array */
10
+ /** *language code in a POST array* */
11
11
  language_code?: string | undefined;
12
- /** direct URL to search engine results you can use it to make sure that we provided accurate results */
12
+ /** *direct URL to search engine results*you can use it to make sure that we provided accurate results */
13
13
  check_url?: string | undefined;
14
- /** date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
14
+ /** *date and time when the result was received* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
15
15
  datetime?: string | undefined;
16
- /** autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
16
+ /** *autocorrection of the search engine* if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
17
17
  spell?: SpellInfo | undefined;
18
- /** types of search results in SERP contains types of search results (items) found in SERP. possible item types: youtube_channel, youtube_video, youtube_video_paid, youtube_playlist */
18
+ /** *types of search results in SERP* contains types of search results (`items`) found in SERP. possible item types: `youtube_channel`, `youtube_video`, `youtube_video_paid`, `youtube_playlist` */
19
19
  item_types?: string[] | undefined;
20
- /** total number of results in SERP */
20
+ /** *total number of results in SERP* */
21
21
  se_results_count?: number | undefined;
22
- /** the number of results returned in the items array */
22
+ /** *the number of results returned in the **`items`** array* */
23
23
  items_count?: number | undefined;
24
- /** elements of search results found in SERP */
24
+ /** *elements of search results found in SERP* */
25
25
  items?: BaseSerpApiYoutubeOrganicElementItem[] | undefined;
26
26
  [key: string]: any;
27
27
  }
28
28
  export declare class SerpYoutubeOrganicLiveAdvancedResultInfo implements ISerpYoutubeOrganicLiveAdvancedResultInfo {
29
- /** keyword received in a POST array the keyword is returned with decoded %## (plus character '+' will be decoded to a space character) */
29
+ /** *keyword received in a POST array***the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)** */
30
30
  keyword?: string | undefined;
31
- /** search engine domain in a POST array */
31
+ /** *search engine domain in a POST array* */
32
32
  se_domain?: string | undefined;
33
- /** location code in a POST array */
33
+ /** *location code in a POST array* */
34
34
  location_code?: number | undefined;
35
- /** language code in a POST array */
35
+ /** *language code in a POST array* */
36
36
  language_code?: string | undefined;
37
- /** direct URL to search engine results you can use it to make sure that we provided accurate results */
37
+ /** *direct URL to search engine results*you can use it to make sure that we provided accurate results */
38
38
  check_url?: string | undefined;
39
- /** date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
39
+ /** *date and time when the result was received* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
40
40
  datetime?: string | undefined;
41
- /** autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
41
+ /** *autocorrection of the search engine* if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
42
42
  spell?: SpellInfo | undefined;
43
- /** types of search results in SERP contains types of search results (items) found in SERP. possible item types: youtube_channel, youtube_video, youtube_video_paid, youtube_playlist */
43
+ /** *types of search results in SERP* contains types of search results (`items`) found in SERP. possible item types: `youtube_channel`, `youtube_video`, `youtube_video_paid`, `youtube_playlist` */
44
44
  item_types?: string[] | undefined;
45
- /** total number of results in SERP */
45
+ /** *total number of results in SERP* */
46
46
  se_results_count?: number | undefined;
47
- /** the number of results returned in the items array */
47
+ /** *the number of results returned in the **`items`** array* */
48
48
  items_count?: number | undefined;
49
- /** elements of search results found in SERP */
49
+ /** *elements of search results found in SERP* */
50
50
  items?: BaseSerpApiYoutubeOrganicElementItem[] | undefined;
51
51
  [key: string]: any;
52
52
  constructor(data?: ISerpYoutubeOrganicLiveAdvancedResultInfo);
@@ -1,12 +1,12 @@
1
1
  import { SerpYoutubeOrganicLiveAdvancedResultInfo } from "./SerpYoutubeOrganicLiveAdvancedResultInfo";
2
2
  import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
3
3
  export interface ISerpYoutubeOrganicLiveAdvancedTaskInfo extends IBaseResponseTaskInfo {
4
- /** array of results */
4
+ /** *array of results* */
5
5
  result?: SerpYoutubeOrganicLiveAdvancedResultInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class SerpYoutubeOrganicLiveAdvancedTaskInfo extends BaseResponseTaskInfo implements ISerpYoutubeOrganicLiveAdvancedTaskInfo {
9
- /** array of results */
9
+ /** *array of results* */
10
10
  result?: SerpYoutubeOrganicLiveAdvancedResultInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: ISerpYoutubeOrganicLiveAdvancedTaskInfo);
@@ -1,62 +1,62 @@
1
1
  export interface ISerpYoutubeOrganicTaskPostRequestInfo {
2
- /** keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
2
+ /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
3
3
  keyword?: string | undefined;
4
- /** search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: 2840 */
4
+ /** *search engine location code* **required field if you don't specify** `location_name` **if you use this field, you don't need to specify `location_name`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `2840` */
5
5
  location_code?: number | undefined;
6
- /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: en */
6
+ /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages`**example:**`en` */
7
7
  language_code?: string | undefined;
8
- /** device type optional field return results for a specific device type available values: desktop, mobile */
8
+ /** *device type* optional field return results for a specific device type available values: `desktop`, `mobile` */
9
9
  device?: string | undefined;
10
- /** task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. */
10
+ /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/youtube-serp-api) page. */
11
11
  priority?: number | undefined;
12
- /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
12
+ /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
13
13
  pingback_url?: string | undefined;
14
- /** return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
14
+ /** *return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
15
15
  postback_url?: string | undefined;
16
- /** postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible value: advanced */
16
+ /** *postback_url datatype* **required field if you specify `postback_url`** corresponds to the datatype that will be sent to your server possible value: `advanced` */
17
17
  postback_data?: string | undefined;
18
- /** full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: United States */
18
+ /** *full name of search engine location* **required field if you don't specify** `location_code` **if you use this field, you don't need to specify `location_code`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `United States` */
19
19
  location_name?: string | undefined;
20
- /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: English */
20
+ /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages` example: `English` */
21
21
  language_name?: string | undefined;
22
- /** device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android */
22
+ /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
23
23
  os?: string | undefined;
24
- /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
24
+ /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
25
25
  tag?: string | undefined;
26
- /** additional parameters of the search query optional field example: sp=EgIQAg%253D%253D */
26
+ /** *additional parameters of the search query* optional field example: `sp=EgIQAg%253D%253D` */
27
27
  search_param?: string | undefined;
28
- /** parsing depth optional field number of blocks of results in SERP default value: 20 max value: 700 Note: your account will be billed per each SERP containing up to 20 blocks of results; thus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
28
+ /** *parsing depth* optional field number of blocks of results in SERP default value: `20` max value: `700` **Note:** your account will be billed per each SERP containing up to 20 blocks of results; thus, setting a block depth above `20` may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
29
29
  block_depth?: number | undefined;
30
30
  [key: string]: any;
31
31
  }
32
32
  export declare class SerpYoutubeOrganicTaskPostRequestInfo implements ISerpYoutubeOrganicTaskPostRequestInfo {
33
- /** keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
33
+ /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if you need to use the “+” character for your `keyword`, please specify it as “%2B”; learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
34
34
  keyword?: string | undefined;
35
- /** search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: 2840 */
35
+ /** *search engine location code* **required field if you don't specify** `location_name` **if you use this field, you don't need to specify `location_name`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `2840` */
36
36
  location_code?: number | undefined;
37
- /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: en */
37
+ /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages`**example:**`en` */
38
38
  language_code?: string | undefined;
39
- /** device type optional field return results for a specific device type available values: desktop, mobile */
39
+ /** *device type* optional field return results for a specific device type available values: `desktop`, `mobile` */
40
40
  device?: string | undefined;
41
- /** task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. */
41
+ /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/youtube-serp-api) page. */
42
42
  priority?: number | undefined;
43
- /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
43
+ /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
44
44
  pingback_url?: string | undefined;
45
- /** return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
45
+ /** *return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
46
46
  postback_url?: string | undefined;
47
- /** postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible value: advanced */
47
+ /** *postback_url datatype* **required field if you specify `postback_url`** corresponds to the datatype that will be sent to your server possible value: `advanced` */
48
48
  postback_data?: string | undefined;
49
- /** full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: United States */
49
+ /** *full name of search engine location* **required field if you don't specify** `location_code` **if you use this field, you don't need to specify `location_code`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `United States` */
50
50
  location_name?: string | undefined;
51
- /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: English */
51
+ /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages` example: `English` */
52
52
  language_name?: string | undefined;
53
- /** device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android */
53
+ /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
54
54
  os?: string | undefined;
55
- /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
55
+ /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
56
56
  tag?: string | undefined;
57
- /** additional parameters of the search query optional field example: sp=EgIQAg%253D%253D */
57
+ /** *additional parameters of the search query* optional field example: `sp=EgIQAg%253D%253D` */
58
58
  search_param?: string | undefined;
59
- /** parsing depth optional field number of blocks of results in SERP default value: 20 max value: 700 Note: your account will be billed per each SERP containing up to 20 blocks of results; thus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
59
+ /** *parsing depth* optional field number of blocks of results in SERP default value: `20` max value: `700` **Note:** your account will be billed per each SERP containing up to 20 blocks of results; thus, setting a block depth above `20` may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
60
60
  block_depth?: number | undefined;
61
61
  [key: string]: any;
62
62
  constructor(data?: ISerpYoutubeOrganicTaskPostRequestInfo);
@@ -1,12 +1,12 @@
1
1
  import { SerpYoutubeOrganicTaskPostTaskInfo } from "./SerpYoutubeOrganicTaskPostTaskInfo";
2
2
  import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
3
3
  export interface ISerpYoutubeOrganicTaskPostResponseInfo extends IBaseResponseInfo {
4
- /** array of tasks */
4
+ /** *array of tasks* */
5
5
  tasks?: SerpYoutubeOrganicTaskPostTaskInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class SerpYoutubeOrganicTaskPostResponseInfo extends BaseResponseInfo implements ISerpYoutubeOrganicTaskPostResponseInfo {
9
- /** array of tasks */
9
+ /** *array of tasks* */
10
10
  tasks?: SerpYoutubeOrganicTaskPostTaskInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: ISerpYoutubeOrganicTaskPostResponseInfo);
@@ -1,11 +1,11 @@
1
1
  import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
2
2
  export interface ISerpYoutubeOrganicTaskPostTaskInfo extends IBaseResponseTaskInfo {
3
- /** array of resultsin this case, the value will be null */
3
+ /** *array of results* in this case, the value will be `null` */
4
4
  result?: any | undefined;
5
5
  [key: string]: any;
6
6
  }
7
7
  export declare class SerpYoutubeOrganicTaskPostTaskInfo extends BaseResponseTaskInfo implements ISerpYoutubeOrganicTaskPostTaskInfo {
8
- /** array of resultsin this case, the value will be null */
8
+ /** *array of results* in this case, the value will be `null` */
9
9
  result?: any | undefined;
10
10
  [key: string]: any;
11
11
  constructor(data?: ISerpYoutubeOrganicTaskPostTaskInfo);
@@ -1,58 +1,58 @@
1
1
  export interface ISerpYoutubeVideoCommentsTaskPostRequestInfo {
2
- /** ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4 */
2
+ /** *ID of the video* **required field** you can find video ID in the URL or 'youtube_video' item of [YouTube Organic](/v3/serp/youtube/organic/live/advanced/) result example: `vQXvyV0zIP4` */
3
3
  video_id?: string | undefined;
4
- /** search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: 2840 */
4
+ /** *search engine location code* **required field if you don't specify** `location_name` **if you use this field, you don't need to specify `location_name`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `2840` */
5
5
  location_code?: number | undefined;
6
- /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: en */
6
+ /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages`**example:**`en` */
7
7
  language_code?: string | undefined;
8
- /** parsing depth optional field number of results in SERP default value: 20 max value: 700 Note: your account will be billed per each SERP containing up to 20 results; thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
8
+ /** *parsing depth* optional field number of results in SERP default value: `20` max value: `700` **Note:** your account will be billed per each SERP containing up to 20 results; thus, setting a depth above `20` may result in additional charges if the search engine returns more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
9
9
  depth?: number | undefined;
10
- /** task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. */
10
+ /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/youtube-serp-api) page. */
11
11
  priority?: number | undefined;
12
- /** device type optional field only value: desktop */
12
+ /** *device type* optional field only value: `desktop` */
13
13
  device?: string | undefined;
14
- /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
14
+ /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
15
15
  pingback_url?: string | undefined;
16
- /** return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
16
+ /** *return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
17
17
  postback_url?: string | undefined;
18
- /** postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible value: advanced */
18
+ /** *postback_url datatype* **required field if you specify `postback_url`** corresponds to the datatype that will be sent to your server possible value: `advanced` */
19
19
  postback_data?: string | undefined;
20
- /** full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: United States */
20
+ /** *full name of search engine location* **required field if you don't specify** `location_code` **if you use this field, you don't need to specify `location_code`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `United States` */
21
21
  location_name?: string | undefined;
22
- /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: English */
22
+ /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages` example: `English` */
23
23
  language_name?: string | undefined;
24
- /** device operating system optional field choose from the following values: windows, macos default value: windows */
24
+ /** *device operating system* optional field choose from the following values: `windows`, `macos` default value: `windows` */
25
25
  os?: string | undefined;
26
- /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
26
+ /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
27
27
  tag?: string | undefined;
28
28
  [key: string]: any;
29
29
  }
30
30
  export declare class SerpYoutubeVideoCommentsTaskPostRequestInfo implements ISerpYoutubeVideoCommentsTaskPostRequestInfo {
31
- /** ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4 */
31
+ /** *ID of the video* **required field** you can find video ID in the URL or 'youtube_video' item of [YouTube Organic](/v3/serp/youtube/organic/live/advanced/) result example: `vQXvyV0zIP4` */
32
32
  video_id?: string | undefined;
33
- /** search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: 2840 */
33
+ /** *search engine location code* **required field if you don't specify** `location_name` **if you use this field, you don't need to specify `location_name`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `2840` */
34
34
  location_code?: number | undefined;
35
- /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: en */
35
+ /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages`**example:**`en` */
36
36
  language_code?: string | undefined;
37
- /** parsing depth optional field number of results in SERP default value: 20 max value: 700 Note: your account will be billed per each SERP containing up to 20 results; thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
37
+ /** *parsing depth* optional field number of results in SERP default value: `20` max value: `700` **Note:** your account will be billed per each SERP containing up to 20 results; thus, setting a depth above `20` may result in additional charges if the search engine returns more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
38
38
  depth?: number | undefined;
39
- /** task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. */
39
+ /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/youtube-serp-api) page. */
40
40
  priority?: number | undefined;
41
- /** device type optional field only value: desktop */
41
+ /** *device type* optional field only value: `desktop` */
42
42
  device?: string | undefined;
43
- /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
43
+ /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
44
44
  pingback_url?: string | undefined;
45
- /** return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
45
+ /** *return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
46
46
  postback_url?: string | undefined;
47
- /** postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible value: advanced */
47
+ /** *postback_url datatype* **required field if you specify `postback_url`** corresponds to the datatype that will be sent to your server possible value: `advanced` */
48
48
  postback_data?: string | undefined;
49
- /** full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations example: United States */
49
+ /** *full name of search engine location* **required field if you don't specify** `location_code` **if you use this field, you don't need to specify `location_code`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/locations` example: `United States` */
50
50
  location_name?: string | undefined;
51
- /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages example: English */
51
+ /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/youtube/languages` example: `English` */
52
52
  language_name?: string | undefined;
53
- /** device operating system optional field choose from the following values: windows, macos default value: windows */
53
+ /** *device operating system* optional field choose from the following values: `windows`, `macos` default value: `windows` */
54
54
  os?: string | undefined;
55
- /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
55
+ /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
56
56
  tag?: string | undefined;
57
57
  [key: string]: any;
58
58
  constructor(data?: ISerpYoutubeVideoCommentsTaskPostRequestInfo);
@@ -1,12 +1,12 @@
1
1
  import { SerpYoutubeVideoCommentsTaskPostTaskInfo } from "./SerpYoutubeVideoCommentsTaskPostTaskInfo";
2
2
  import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
3
3
  export interface ISerpYoutubeVideoCommentsTaskPostResponseInfo extends IBaseResponseInfo {
4
- /** array of tasks */
4
+ /** *array of tasks* */
5
5
  tasks?: SerpYoutubeVideoCommentsTaskPostTaskInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class SerpYoutubeVideoCommentsTaskPostResponseInfo extends BaseResponseInfo implements ISerpYoutubeVideoCommentsTaskPostResponseInfo {
9
- /** array of tasks */
9
+ /** *array of tasks* */
10
10
  tasks?: SerpYoutubeVideoCommentsTaskPostTaskInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: ISerpYoutubeVideoCommentsTaskPostResponseInfo);
@@ -1,11 +1,11 @@
1
1
  import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
2
2
  export interface ISerpYoutubeVideoCommentsTaskPostTaskInfo extends IBaseResponseTaskInfo {
3
- /** array of resultsin this case, the value will be null */
3
+ /** *array of results* in this case, the value will be `null` */
4
4
  result?: any | undefined;
5
5
  [key: string]: any;
6
6
  }
7
7
  export declare class SerpYoutubeVideoCommentsTaskPostTaskInfo extends BaseResponseTaskInfo implements ISerpYoutubeVideoCommentsTaskPostTaskInfo {
8
- /** array of resultsin this case, the value will be null */
8
+ /** *array of results* in this case, the value will be `null` */
9
9
  result?: any | undefined;
10
10
  [key: string]: any;
11
11
  constructor(data?: ISerpYoutubeVideoCommentsTaskPostTaskInfo);