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

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

mod baidu;
mod bing;
mod google;
mod naver;
mod seznam;
mod yahoo;
mod youtube;

pub use baidu::*;
pub use bing::*;
pub use google::*;
pub use naver::*;
pub use seznam::*;
pub use yahoo::*;
pub use youtube::*;

/// SERP data model.
pub struct SerpApi<'a> {
    client: &'a DataForSeoClient,
}

impl DataForSeoClient {
    /// Returns the SERP API domain entry point.
    /// See <https://docs.dataforseo.com/v3/serp/overview/>.
    pub fn serp(&self) -> SerpApi<'_> {
        SerpApi { client: self }
    }
}

impl SerpApi<'_> {
    /// Lists all locations supported across the SERP engines.
    pub async fn locations(&self) -> DataForSeoApiResponse<SerpApiLocation> {
        self.client.http_get("/v3/serp/locations").await
    }
    /// Lists locations supported by the given search engine.
    pub async fn locations_se(&self, se: &str) -> DataForSeoApiResponse<SerpApiLocation> {
        self.client
            .http_get(format!("/v3/serp/{}/locations", se).as_str())
            .await
    }
    /// Lists supported locations within the given country.
    pub async fn locations_country(&self, country: &str) -> DataForSeoApiResponse<SerpApiLocation> {
        self.client
            .http_get(format!("/v3/serp/locations/{}", country).as_str())
            .await
    }
    /// Lists locations within a country for the given search engine.
    pub async fn locations_country_se(
        &self,
        se: &str,
        country: &str,
    ) -> DataForSeoApiResponse<SerpApiLocation> {
        self.client
            .http_get(format!("/v3/serp/{}/locations/{}", se, country).as_str())
            .await
    }
    /// Lists completed tasks that are ready to be collected.
    pub async fn task_ready(&self) -> DataForSeoApiResponse<SerpApiTaskReadyResult> {
        self.client.http_get("/v3/serp/tasks_ready").await
    }
    /// Lists completed tasks for the given search engine.
    pub async fn task_ready_se(&self, se: &str) -> DataForSeoApiResponse<SerpApiTaskReadyResult> {
        self.client
            .http_get(format!("/v3/serp/{}/tasks_ready", se).as_str())
            .await
    }
    /// Lists tasks that were force-fixed by DataForSEO.
    pub async fn task_fixed(&self) -> DataForSeoApiResponse<SerpApiTaskReadyResult> {
        self.client.http_get("/v3/serp/tasks_fixed").await
    }
    /// Lists force-fixed tasks for the given search engine.
    pub async fn task_fixed_se(&self, se: &str) -> DataForSeoApiResponse<SerpApiTaskReadyResult> {
        self.client
            .http_get(format!("/v3/serp/{}/tasks_fixed", se).as_str())
            .await
    }
}

/// Task Ready Result SERP data model.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct SerpApiTaskReadyResult {
    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>,
}

/// Location SERP data model.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct SerpApiLocation {
    /// DataForSEO location code the search was run for.
    pub location_code: Option<i32>,
    /// Full location name (e.g. "London,England,United Kingdom").
    pub location_name: Option<String>,
    /// Location code of the parent region, if any.
    pub location_code_parent: Option<i32>,
    /// ISO country code of the location.
    pub country_iso_code: Option<String>,
    /// Type of the location (e.g. City, Region, Country).
    pub location_type: Option<String>,
}