Skip to main content

google_maps_scraper_sdk/
types.rs

1//! Response types for the GMaps Lead Finder Agent HTTP API.
2
3use serde::{Deserialize, Serialize};
4use std::collections::HashMap;
5
6#[derive(Debug, Clone, Deserialize, Serialize)]
7#[serde(rename_all = "camelCase")]
8pub struct MeResponse {
9    pub plan: String,
10    pub credits_limit: f64,
11    pub credits_used: f64,
12    pub credits_remaining: f64,
13}
14
15#[derive(Debug, Clone, Deserialize, Serialize)]
16#[serde(rename_all = "camelCase")]
17pub struct CreateJobResponse {
18    pub job_id: String,
19    pub keyword_count: i32,
20    pub credits_remaining: f64,
21}
22
23#[derive(Debug, Clone, Deserialize, Serialize)]
24#[serde(rename_all = "camelCase")]
25pub struct JobFile {
26    pub id: Option<String>,
27    pub keyword: Option<String>,
28    pub position: Option<i32>,
29    pub status: Option<String>,
30    pub page_count: Option<i32>,
31    pub row_count: Option<i32>,
32    pub enrich_status: Option<String>,
33    pub error: Option<String>,
34}
35
36#[derive(Debug, Clone, Deserialize, Serialize)]
37#[serde(rename_all = "camelCase")]
38pub struct JobResponse {
39    pub id: Option<String>,
40    pub status: Option<String>,
41    pub keywords: Option<Vec<String>>,
42    pub keyword_count: Option<i32>,
43    pub current_keyword_index: Option<i32>,
44    pub row_count: Option<i32>,
45    pub error: Option<String>,
46    pub created_at: Option<String>,
47    pub finished_at: Option<String>,
48    pub files: Option<Vec<JobFile>>,
49    pub credits_remaining: Option<f64>,
50}
51
52pub type PlaceRow = HashMap<String, String>;
53
54#[derive(Debug, Clone, Deserialize, Serialize)]
55#[serde(rename_all = "camelCase")]
56pub struct ResultsResponse {
57    pub job_id: Option<String>,
58    pub status: Option<String>,
59    pub columns: Option<Vec<String>>,
60    pub rows: Option<Vec<PlaceRow>>,
61    pub count: Option<i32>,
62    pub total: Option<i32>,
63    pub cursor: Option<i32>,
64    pub next_cursor: Option<String>,
65}
66
67#[derive(Debug, Clone, Default)]
68pub struct ClientOptions {
69    pub api_key: Option<String>,
70    pub base_url: Option<String>,
71    /// Per-request HTTP timeout in milliseconds (default 60_000).
72    pub timeout_ms: Option<u64>,
73}
74
75#[derive(Debug, Clone, Default)]
76pub struct ScrapeOptions {
77    pub poll_interval_ms: Option<u64>,
78    /// Max wait for job completion in milliseconds (default 600_000).
79    pub timeout_ms: Option<u64>,
80    pub result_limit: Option<u32>,
81}
82
83#[derive(Debug, Clone, Default)]
84pub struct GetResultsOptions {
85    pub limit: Option<u32>,
86    pub cursor: Option<String>,
87}
88
89pub fn is_terminal_status(status: &str) -> bool {
90    matches!(
91        status.to_ascii_lowercase().as_str(),
92        "completed" | "partial" | "failed"
93    )
94}