data-for-seo 0.3.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

//! Shared/utility endpoint models for the DataForSEO Labs API.

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// A previously posted task returned by the `id_list` endpoint.
/// See <https://docs.dataforseo.com/v3/dataforseo_labs/id_list/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct DataForSeoLabsIdListItem {
    /// Task identifier (UUID).
    pub id: Option<String>,
    /// When the task was created (UTC).
    pub datetime_posted: Option<String>,
    /// When the task finished (UTC).
    pub datetime_done: Option<String>,
    /// URL of the result (for an id-list entry, the endpoint the task was posted to).
    pub url: Option<String>,
    /// Task status.
    pub status: Option<String>,
    /// Cost of the task (USD).
    pub cost: Option<f64>,
    /// Original POST parameters of the task.
    pub metadata: Option<Value>,
}

/// A location supported by the Labs API, with the languages available for it.
/// See <https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct DataForSeoLabsLocation {
    /// Location code (e.g. `2840`); alternative to `location_name`.
    pub location_code: Option<i32>,
    /// Full location name (e.g. `"United States"`); alternative to `location_code`.
    pub location_name: Option<String>,
    /// Code of the parent location.
    pub location_code_parent: Option<i32>,
    /// ISO country code of the location.
    pub country_iso_code: Option<String>,
    /// Type of the location (e.g. `"Country"`, `"City"`).
    pub location_type: Option<String>,
    /// Languages available for this location.
    pub available_languages: Option<Vec<DataForSeoLabsLanguage>>,
}

/// A language available for a location.
/// See <https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct DataForSeoLabsLanguage {
    /// Full language name (e.g. `"English"`); alternative to `language_code`.
    pub language_name: Option<String>,
    /// Language code (e.g. `"en"`); alternative to `language_name`.
    pub language_code: Option<String>,
    /// Number of keywords available in the database for this language.
    pub keywords: Option<i64>,
    /// Number of SERPs available in the database for this language.
    pub serps: Option<i64>,
}

/// A node of the product-category tree returned by `categories`.
/// See <https://docs.dataforseo.com/v3/dataforseo_labs/categories/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct DataForSeoLabsCategory {
    /// Category code.
    pub category_code: Option<i64>,
    /// Human-readable category name.
    pub category_name: Option<String>,
    /// Code of the parent category.
    pub category_code_parent: Option<i64>,
}

/// Rate-limit / availability info returned by the Labs `status` endpoint.
/// See <https://docs.dataforseo.com/v3/dataforseo_labs/status/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct DataForSeoLabsStatus {
    /// Date and time of the record (UTC).
    pub datetime: Option<String>,
    /// Rate-limit information.
    pub rates: Option<Value>,
    /// Available metric types and their limits.
    pub metric_types: Option<Value>,
}