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

use crate::DataForSeoApiResponse;
use crate::api::keywords_data::KeywordsDataApiTaskReadyResult;
use crate::api::keywords_data::bing::KeywordsDataApiBing;
use crate::entity::{
    KeywordsDataApiBingAudienceEstimation, KeywordsDataApiBingIndustry,
    KeywordsDataApiBingJobFunction,
};
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Bing Audience Estimation.
/// See <https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/live/>.
impl KeywordsDataApiBing<'_> {
    /// Job functions available for audience targeting.
    /// See <https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions/>.
    pub async fn audience_estimation_job_functions(
        &self,
    ) -> DataForSeoApiResponse<KeywordsDataApiBingJobFunction> {
        self.client
            .http_get("/v3/keywords_data/bing/audience_estimation/job_functions")
            .await
    }
    /// Industries available for audience targeting.
    /// See <https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries/>.
    pub async fn audience_estimation_industries(
        &self,
    ) -> DataForSeoApiResponse<KeywordsDataApiBingIndustry> {
        self.client
            .http_get("/v3/keywords_data/bing/audience_estimation/industries")
            .await
    }
    /// Posts an Audience Estimation task for asynchronous processing.
    pub async fn audience_estimation_task_post(
        &self,
        data: Vec<KeywordsDataApiBingAudienceEstimationTaskPostRequest>,
    ) -> DataForSeoApiResponse<Value> {
        self.client
            .http_post(
                "/v3/keywords_data/bing/audience_estimation/task_post",
                &data,
            )
            .await
    }
    /// Lists completed Audience Estimation tasks ready to be collected.
    pub async fn audience_estimation_tasks_ready(
        &self,
    ) -> DataForSeoApiResponse<KeywordsDataApiTaskReadyResult> {
        self.client
            .keywords_data()
            .task_ready_se("bing/audience_estimation")
            .await
    }
    /// Collects the result of a previously posted Audience Estimation task.
    pub async fn audience_estimation_task_get(
        &self,
        id: &str,
    ) -> DataForSeoApiResponse<KeywordsDataApiBingAudienceEstimation> {
        self.client
            .http_get(&format!(
                "/v3/keywords_data/bing/audience_estimation/task_get/{id}"
            ))
            .await
    }
    /// Retrieves Audience Estimation data synchronously.
    pub async fn audience_estimation_live(
        &self,
        data: Vec<KeywordsDataApiBingAudienceEstimationTaskPostRequest>,
    ) -> DataForSeoApiResponse<KeywordsDataApiBingAudienceEstimation> {
        self.client
            .http_post("/v3/keywords_data/bing/audience_estimation/live", &data)
            .await
    }
}

/// Request body for the Bing Audience Estimation endpoints.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct KeywordsDataApiBingAudienceEstimationTaskPostRequest {
    /// 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>,
    /// GPS coordinates as "latitude,longitude,radius(km)".
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_coordinate: Option<String>,
    /// Age brackets to target, e.g. "eighteen_to_twenty_four".
    #[serde(skip_serializing_if = "Option::is_none")]
    pub age: Option<Vec<String>>,
    /// Genders to target: "male", "female" or "unknown".
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gender: Option<Vec<String>>,
    /// Desired bid, in USD (max 1000).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bid: Option<f64>,
    /// Daily budget, in USD (max 10000).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub daily_budget: Option<f64>,
    /// Industry identifiers to target (see `audience_estimation_industries`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub industry: Option<Vec<i64>>,
    /// Job function identifiers to target (see `audience_estimation_job_functions`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub job_function: Option<Vec<i64>>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
}

impl KeywordsDataApiBingAudienceEstimationTaskPostRequest {
    /// Creates an empty request; set a location before sending.
    pub fn new() -> Self {
        KeywordsDataApiBingAudienceEstimationTaskPostRequest::default()
    }
}