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

//! AI Keyword Data sub-API.
//!
//! See <https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/overview/>.

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

/// Endpoints under `/v3/ai_optimization/ai_keyword_data/`.
pub struct AiOptimizationApiKeywordData<'a> {
    pub(crate) client: &'a DataForSeoClient,
}

impl AiOptimizationApiKeywordData<'_> {
    /// Lists the locations and languages supported by AI Keyword Data.
    ///
    /// `GET /v3/ai_optimization/ai_keyword_data/locations_and_languages`
    /// See <https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages/>.
    pub async fn locations_and_languages(
        &self,
    ) -> DataForSeoApiResponse<AiOptimizationLocationLanguage> {
        self.client
            .http_get("/v3/ai_optimization/ai_keyword_data/locations_and_languages")
            .await
    }

    /// Returns AI search volume for the given keywords.
    ///
    /// `POST /v3/ai_optimization/ai_keyword_data/keywords_search_volume/live`
    /// See <https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live/>.
    pub async fn keywords_search_volume(
        &self,
        data: Vec<AiOptimizationKeywordDataSearchVolumePost>,
    ) -> DataForSeoApiResponse<AiOptimizationKeywordDataSearchVolume> {
        self.client
            .http_post(
                "/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live",
                &data,
            )
            .await
    }
}

/// Request body for `keywords_search_volume/live`.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct AiOptimizationKeywordDataSearchVolumePost {
    /// Keywords to look up (up to 1000, max 250 characters each).
    pub keywords: Vec<String>,
    /// Full name of the search location (alternative to `location_code`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// Search location code (alternative to `location_name`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_code: Option<i32>,
    /// Full name of the search language (alternative to `language_code`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Search language code (alternative to `language_name`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_code: Option<String>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
}

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