data-for-seo 0.2.0

Client library for the DataForSEO API v3 (SERP, Keywords Data, Labs, Backlinks, OnPage, and more)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use crate::SerpApiYoutube;
use crate::entity::SerpApiYoutubeVideoSubtitlesTaskAdvanced;
use crate::{DataForSeoApiResponse, SerpApiTaskReadyResult};
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// YouTube Video Subtitles SERP endpoint.
/// <https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/overview/>
impl SerpApiYoutube<'_> {
    /// <https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_post/>
    pub async fn video_subtitles_task_post(
        &self,
        data: Vec<SerpApiYoutubeVideoSubtitlesTaskPostRequest>,
    ) -> DataForSeoApiResponse<Value> {
        self.client
            .http_post("/v3/serp/youtube/video_subtitles/task_post", &data)
            .await
    }
    /// <https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/tasks_ready/>
    pub async fn video_subtitles_tasks_ready(
        &self,
    ) -> DataForSeoApiResponse<SerpApiTaskReadyResult> {
        self.client
            .serp()
            .task_ready_se("youtube/video_subtitles")
            .await
    }
    /// <https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_get/advanced/>
    pub async fn video_subtitles_task_get_advanced(
        &self,
        id: &str,
    ) -> DataForSeoApiResponse<SerpApiYoutubeVideoSubtitlesTaskAdvanced> {
        self.client
            .http_get(format!("/v3/serp/youtube/video_subtitles/task_get/advanced/{id}").as_str())
            .await
    }
    /// <https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/>
    pub async fn video_subtitles_live_advanced(
        &self,
        data: Vec<SerpApiYoutubeVideoSubtitlesTaskPostRequest>,
    ) -> DataForSeoApiResponse<SerpApiYoutubeVideoSubtitlesTaskAdvanced> {
        self.client
            .http_post("/v3/serp/youtube/video_subtitles/live/advanced", &data)
            .await
    }
}

/// Request body for YouTube Video Subtitles task_post / live.
/// See <https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_post/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct SerpApiYoutubeVideoSubtitlesTaskPostRequest {
    /// YouTube video identifier.
    pub video_id: String,
    /// Task execution priority: 1 (normal) or 2 (high).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<i32>,
    /// Full location name (e.g. "London,England,United Kingdom").
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// DataForSEO location code the search was run for.
    pub location_code: i32,
    /// Full language name of the search.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Language code the search was run for.
    pub language_code: String,
    /// Device.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device: Option<String>,
    /// Os.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub os: Option<String>,
    /// Subtitles language.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subtitles_language: Option<String>,
    /// Subtitles translate language.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subtitles_translate_language: Option<String>,
    /// User-defined identifier echoed back on the result.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    /// URL of the postback.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postback_url: Option<String>,
    /// Postback data.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postback_data: Option<String>,
    /// URL of the pingback.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pingback_url: Option<String>,
}

impl SerpApiYoutubeVideoSubtitlesTaskPostRequest {
    /// Creates a request for the given video id with required language and location codes.
    pub fn new<T: Into<String>>(video_id: T, language_code: String, location_code: i32) -> Self {
        SerpApiYoutubeVideoSubtitlesTaskPostRequest {
            video_id: video_id.into(),
            language_code,
            location_code,
            ..SerpApiYoutubeVideoSubtitlesTaskPostRequest::default()
        }
    }
}