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
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

//! Request bodies shared by Business Data `task_post` / `live` endpoints.

use serde::{Deserialize, Serialize};

/// Task request shared by the simple Google Business Data `task_post` endpoints
/// (My Business Info, My Business Updates, Questions & Answers).
/// See <https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_post/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct BusinessDataApiGoogleTaskPost {
    /// Business name, or a `cid:` / `place_id:` identifier to look up.
    pub keyword: String,
    /// Full location name, e.g. `"London,England,United Kingdom"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// Location code from the `locations` endpoint.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_code: Option<i32>,
    /// GPS coordinates as `"latitude,longitude"` or `"latitude,longitude,radius"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_coordinate: Option<String>,
    /// Full language name, e.g. `"English"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Language code, e.g. `"en"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_code: Option<String>,
    /// Task priority: `1` (normal, default) or `2` (high, extra cost).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<i32>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    /// URL that receives the finished results via POST.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postback_url: Option<String>,
    /// URL notified via GET when the task completes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pingback_url: Option<String>,
}

impl BusinessDataApiGoogleTaskPost {
    /// Builds a task request for the given business name, `cid:`, or `place_id:`.
    pub fn new<T: Into<String>>(keyword: T) -> Self {
        BusinessDataApiGoogleTaskPost {
            keyword: keyword.into(),
            ..BusinessDataApiGoogleTaskPost::default()
        }
    }
}

/// Task request for the Google Reviews and Extended Reviews `task_post` endpoints.
/// See <https://docs.dataforseo.com/v3/business_data/google/reviews/task_post/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct BusinessDataApiReviewsTaskPost {
    /// Business name, or a `cid:` / `place_id:` identifier to look up.
    pub keyword: String,
    /// Full location name, e.g. `"London,England,United Kingdom"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// Location code from the `locations` endpoint.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_code: Option<i32>,
    /// GPS coordinates as `"latitude,longitude"` or `"latitude,longitude,radius"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_coordinate: Option<String>,
    /// Full language name, e.g. `"English"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Language code, e.g. `"en"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_code: Option<String>,
    /// Number of reviews to parse (default `10`, in multiples of 10).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub depth: Option<i32>,
    /// Review ordering, e.g. `"relevant"`, `"newest"`, `"highest_rating"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sort_by: Option<String>,
    /// Task priority: `1` (normal, default) or `2` (high, extra cost).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<i32>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    /// URL that receives the finished results via POST.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postback_url: Option<String>,
    /// URL notified via GET when the task completes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pingback_url: Option<String>,
}

impl BusinessDataApiReviewsTaskPost {
    /// Builds a reviews task request for the given business name, `cid:`, or `place_id:`.
    pub fn new<T: Into<String>>(keyword: T) -> Self {
        BusinessDataApiReviewsTaskPost {
            keyword: keyword.into(),
            ..BusinessDataApiReviewsTaskPost::default()
        }
    }
}

/// Task request for the Google Hotel Searches `task_post` / `live` endpoints.
/// See <https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct BusinessDataApiHotelSearchesTaskPost {
    /// Search query, typically a destination or hotel name.
    pub keyword: String,
    /// Full location name, e.g. `"London,England,United Kingdom"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// Location code from the `locations` endpoint.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_code: Option<i32>,
    /// GPS coordinates as `"latitude,longitude"` or `"latitude,longitude,radius"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_coordinate: Option<String>,
    /// Full language name, e.g. `"English"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Language code, e.g. `"en"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_code: Option<String>,
    /// Check-in date in `yyyy-mm-dd` format.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub check_in: Option<String>,
    /// Check-out date in `yyyy-mm-dd` format.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub check_out: Option<String>,
    /// Three-letter currency code prices are returned in (e.g. `"USD"`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Number of adult guests to price the stay for.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub adults: Option<i32>,
    /// Number of child guests to price the stay for.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub children: Option<i32>,
    /// Task priority: `1` (normal, default) or `2` (high, extra cost).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<i32>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    /// URL that receives the finished results via POST.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postback_url: Option<String>,
    /// URL notified via GET when the task completes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pingback_url: Option<String>,
}

impl BusinessDataApiHotelSearchesTaskPost {
    /// Builds a hotel searches task request for the given keyword.
    pub fn new<T: Into<String>>(keyword: T) -> Self {
        BusinessDataApiHotelSearchesTaskPost {
            keyword: keyword.into(),
            ..BusinessDataApiHotelSearchesTaskPost::default()
        }
    }
}

/// Task request for the Google Hotel Info `task_post` / `live` endpoints.
/// See <https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_post/>.
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct BusinessDataApiHotelInfoTaskPost {
    /// Hotel name or `hotel_identifier:` value identifying the property.
    pub keyword: String,
    /// Full location name, e.g. `"London,England,United Kingdom"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    /// Location code from the `locations` endpoint.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_code: Option<i32>,
    /// Full language name, e.g. `"English"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_name: Option<String>,
    /// Language code, e.g. `"en"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language_code: Option<String>,
    /// Check-in date in `yyyy-mm-dd` format.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub check_in: Option<String>,
    /// Check-out date in `yyyy-mm-dd` format.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub check_out: Option<String>,
    /// Three-letter currency code prices are returned in (e.g. `"USD"`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Task priority: `1` (normal, default) or `2` (high, extra cost).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<i32>,
    /// User-defined task identifier (max 255 characters).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    /// URL that receives the finished results via POST.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postback_url: Option<String>,
    /// URL notified via GET when the task completes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pingback_url: Option<String>,
}

impl BusinessDataApiHotelInfoTaskPost {
    /// Builds a hotel info task request for the given keyword.
    pub fn new<T: Into<String>>(keyword: T) -> Self {
        BusinessDataApiHotelInfoTaskPost {
            keyword: keyword.into(),
            ..BusinessDataApiHotelInfoTaskPost::default()
        }
    }
}