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

use crate::DataForSeoApiResponse;
use crate::api::keywords_data::KeywordsDataApiTaskReadyResult;
use crate::api::keywords_data::google_trends::KeywordsDataApiGoogleTrends;
use crate::entity::KeywordsDataApiGoogleTrendsExplore;
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Google Trends Explore.
/// See <https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/live/>.
impl KeywordsDataApiGoogleTrends<'_> {
    /// Posts an Explore task for asynchronous processing.
    pub async fn explore_task_post(
        &self,
        data: Vec<KeywordsDataApiGoogleTrendsExploreTaskPostRequest>,
    ) -> DataForSeoApiResponse<Value> {
        self.client
            .http_post("/v3/keywords_data/google_trends/explore/task_post", &data)
            .await
    }
    /// Lists completed Explore tasks ready to be collected.
    pub async fn explore_tasks_ready(
        &self,
    ) -> DataForSeoApiResponse<KeywordsDataApiTaskReadyResult> {
        self.client
            .keywords_data()
            .task_ready_se("google_trends/explore")
            .await
    }
    /// Collects the result of a previously posted Explore task.
    pub async fn explore_task_get(
        &self,
        id: &str,
    ) -> DataForSeoApiResponse<KeywordsDataApiGoogleTrendsExplore> {
        self.client
            .http_get(&format!(
                "/v3/keywords_data/google_trends/explore/task_get/{id}"
            ))
            .await
    }
    /// Retrieves Explore data synchronously.
    pub async fn explore_live(
        &self,
        data: Vec<KeywordsDataApiGoogleTrendsExploreTaskPostRequest>,
    ) -> DataForSeoApiResponse<KeywordsDataApiGoogleTrendsExplore> {
        self.client
            .http_post("/v3/keywords_data/google_trends/explore/live", &data)
            .await
    }
}

/// Request body for the Google Trends Explore endpoints.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct KeywordsDataApiGoogleTrendsExploreTaskPostRequest {
    /// Keywords to explore (up to 5).
    pub keywords: Vec<String>,
    /// Full location name; alternative to `location_code`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// Numeric location identifier; alternative to `location_name`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_code: Option<i32>,
    /// Full language name; alternative to `language_code`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Language code, e.g. "en"; alternative to `language_name`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_code: Option<String>,
    /// Trends data source: `web`, `news`, `youtube`, `images` or `froogle`.
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub explore_type: Option<String>,
    /// Google Trends category code to narrow results (0 = all categories).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub category_code: Option<i32>,
    /// Start of the range, in "yyyy-mm-dd" format.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub date_from: Option<String>,
    /// End of the range, in "yyyy-mm-dd" format.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub date_to: Option<String>,
    /// Preset range, e.g. "past_7_days" or "past_12_months"; alternative to dates.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub time_range: Option<String>,
    /// Which elements to return, e.g. "google_trends_graph" or "google_trends_map".
    #[serde(skip_serializing_if = "Option::is_none")]
    pub item_types: Option<Vec<String>>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
}

impl KeywordsDataApiGoogleTrendsExploreTaskPostRequest {
    /// Creates a request for the given keywords (max 5).
    pub fn new(keywords: Vec<String>) -> Self {
        KeywordsDataApiGoogleTrendsExploreTaskPostRequest {
            keywords,
            ..KeywordsDataApiGoogleTrendsExploreTaskPostRequest::default()
        }
    }
}