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
104
105
106
107
108
109
110
111
112
113
114
115

mod bing;
mod clickstream_data;
mod dataforseo_trends;
mod google_ads;
mod google_trends;

use crate::{DataForSeoApiResponse, DataForSeoClient};
use serde::{Deserialize, Serialize};

pub use bing::*;
pub use clickstream_data::*;
pub use dataforseo_trends::*;
pub use google_ads::*;
pub use google_trends::*;

/// Entry point for the Keywords Data API domain.
pub struct KeywordsDataApi<'a> {
    client: &'a DataForSeoClient,
}

impl DataForSeoClient {
    /// Keywords Data API (Google Ads, Bing, Google Trends, DataForSEO Trends, Clickstream).
    /// See <https://docs.dataforseo.com/v3/keywords_data/overview/>.
    pub fn keywords_data(&self) -> KeywordsDataApi<'_> {
        KeywordsDataApi { client: self }
    }
}

impl KeywordsDataApi<'_> {
    /// Lists all locations supported across the Keywords Data sub-APIs.
    pub async fn locations(&self) -> DataForSeoApiResponse<KeywordsDataApiLocation> {
        self.client.http_get("/v3/keywords_data/locations").await
    }
    /// Lists locations supported by a given search engine path, e.g. "google_ads".
    pub async fn locations_se(&self, se: &str) -> DataForSeoApiResponse<KeywordsDataApiLocation> {
        self.client
            .http_get(format!("/v3/keywords_data/{}/locations", se).as_str())
            .await
    }
    /// Lists locations within a country (by ISO code).
    pub async fn locations_country(
        &self,
        country: &str,
    ) -> DataForSeoApiResponse<KeywordsDataApiLocation> {
        self.client
            .http_get(format!("/v3/keywords_data/locations/{}", country).as_str())
            .await
    }
    /// Lists locations within a country for a given search engine path.
    pub async fn locations_country_se(
        &self,
        se: &str,
        country: &str,
    ) -> DataForSeoApiResponse<KeywordsDataApiLocation> {
        self.client
            .http_get(format!("/v3/keywords_data/{}/locations/{}", se, country).as_str())
            .await
    }
    /// Lists completed tasks ready to be collected across all sub-APIs.
    pub async fn task_ready(&self) -> DataForSeoApiResponse<KeywordsDataApiTaskReadyResult> {
        self.client.http_get("/v3/keywords_data/tasks_ready").await
    }
    /// Lists completed tasks ready to be collected for a given search engine path.
    pub async fn task_ready_se(
        &self,
        se: &str,
    ) -> DataForSeoApiResponse<KeywordsDataApiTaskReadyResult> {
        self.client
            .http_get(format!("/v3/keywords_data/{}/tasks_ready", se).as_str())
            .await
    }
    /// Lists tasks that were re-run after an error across all sub-APIs.
    pub async fn task_fixed(&self) -> DataForSeoApiResponse<KeywordsDataApiTaskReadyResult> {
        self.client.http_get("/v3/keywords_data/tasks_fixed").await
    }
    /// Lists tasks that were re-run after an error for a given search engine path.
    pub async fn task_fixed_se(
        &self,
        se: &str,
    ) -> DataForSeoApiResponse<KeywordsDataApiTaskReadyResult> {
        self.client
            .http_get(format!("/v3/keywords_data/{}/tasks_fixed", se).as_str())
            .await
    }
}

/// An entry from a `tasks_ready` or `tasks_fixed` listing.
/// See <https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/tasks_ready/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct KeywordsDataApiTaskReadyResult {
    id: Option<String>,
    se: Option<String>,
    se_type: Option<String>,
    date_posted: Option<String>,
    tag: Option<String>,
    endpoint_regular: Option<String>,
    endpoint_advanced: Option<String>,
    endpoint_html: Option<String>,
}

/// A location supported by a Keywords Data sub-API.
/// See <https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct KeywordsDataApiLocation {
    /// Numeric location identifier.
    pub location_code: Option<i32>,
    /// Full location name.
    pub location_name: Option<String>,
    /// Code of the parent location, if any.
    pub location_code_parent: Option<i32>,
    /// ISO country code of the location.
    pub country_iso_code: Option<String>,
    /// Location type, e.g. "Country", "Region" or "City".
    pub location_type: Option<String>,
}