mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
make regen-apis
This commit is contained in:
1141
gen/customsearch1/src/api/call_builders.rs
Normal file
1141
gen/customsearch1/src/api/call_builders.rs
Normal file
File diff suppressed because it is too large
Load Diff
137
gen/customsearch1/src/api/hub.rs
Normal file
137
gen/customsearch1/src/api/hub.rs
Normal file
@@ -0,0 +1,137 @@
|
||||
use super::*;
|
||||
|
||||
/// Central instance to access all CustomSearchAPI related resource activities
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Instantiate a new hub
|
||||
///
|
||||
/// ```test_harness,no_run
|
||||
/// extern crate hyper;
|
||||
/// extern crate hyper_rustls;
|
||||
/// extern crate google_customsearch1 as customsearch1;
|
||||
/// use customsearch1::{Result, Error};
|
||||
/// # async fn dox() {
|
||||
/// use std::default::Default;
|
||||
/// use customsearch1::{CustomSearchAPI, oauth2, hyper, hyper_rustls, chrono, FieldMask};
|
||||
///
|
||||
/// // Get an ApplicationSecret instance by some means. It contains the `client_id` and
|
||||
/// // `client_secret`, among other things.
|
||||
/// let secret: oauth2::ApplicationSecret = Default::default();
|
||||
/// // Instantiate the authenticator. It will choose a suitable authentication flow for you,
|
||||
/// // unless you replace `None` with the desired Flow.
|
||||
/// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
|
||||
/// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
|
||||
/// // retrieve them from storage.
|
||||
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
|
||||
/// secret,
|
||||
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
|
||||
/// ).build().await.unwrap();
|
||||
/// let mut hub = CustomSearchAPI::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
|
||||
/// // You can configure optional parameters by calling the respective setters at will, and
|
||||
/// // execute the final call using `doit()`.
|
||||
/// // Values shown here are possibly random and not representative !
|
||||
/// let result = hub.cse().siterestrict_list()
|
||||
/// .start(86)
|
||||
/// .sort("dolor")
|
||||
/// .site_search_filter("duo")
|
||||
/// .site_search("vero")
|
||||
/// .search_type("vero")
|
||||
/// .safe("invidunt")
|
||||
/// .rights("Stet")
|
||||
/// .related_site("vero")
|
||||
/// .q("elitr")
|
||||
/// .or_terms("Lorem")
|
||||
/// .num(-29)
|
||||
/// .lr("no")
|
||||
/// .low_range("ipsum")
|
||||
/// .link_site("accusam")
|
||||
/// .img_type("takimata")
|
||||
/// .img_size("consetetur")
|
||||
/// .img_dominant_color("voluptua.")
|
||||
/// .img_color_type("et")
|
||||
/// .hq("erat")
|
||||
/// .hl("consetetur")
|
||||
/// .high_range("amet.")
|
||||
/// .googlehost("sed")
|
||||
/// .gl("takimata")
|
||||
/// .filter("dolores")
|
||||
/// .file_type("gubergren")
|
||||
/// .exclude_terms("et")
|
||||
/// .exact_terms("accusam")
|
||||
/// .date_restrict("voluptua.")
|
||||
/// .cx("dolore")
|
||||
/// .cr("dolore")
|
||||
/// .c2coff("dolore")
|
||||
/// .doit().await;
|
||||
///
|
||||
/// match result {
|
||||
/// Err(e) => match e {
|
||||
/// // The Error enum provides details about what exactly happened.
|
||||
/// // You can also just use its `Debug`, `Display` or `Error` traits
|
||||
/// Error::HttpError(_)
|
||||
/// |Error::Io(_)
|
||||
/// |Error::MissingAPIKey
|
||||
/// |Error::MissingToken(_)
|
||||
/// |Error::Cancelled
|
||||
/// |Error::UploadSizeLimitExceeded(_, _)
|
||||
/// |Error::Failure(_)
|
||||
/// |Error::BadRequest(_)
|
||||
/// |Error::FieldClash(_)
|
||||
/// |Error::JsonDecodeError(_, _) => println!("{}", e),
|
||||
/// },
|
||||
/// Ok(res) => println!("Success: {:?}", res),
|
||||
/// }
|
||||
/// # }
|
||||
/// ```
|
||||
#[derive(Clone)]
|
||||
pub struct CustomSearchAPI<S> {
|
||||
pub client: hyper::Client<S, hyper::body::Body>,
|
||||
pub auth: Box<dyn client::GetToken>,
|
||||
pub(super) _user_agent: String,
|
||||
pub(super) _base_url: String,
|
||||
pub(super) _root_url: String,
|
||||
}
|
||||
|
||||
impl<'a, S> client::Hub for CustomSearchAPI<S> {}
|
||||
|
||||
impl<'a, S> CustomSearchAPI<S> {
|
||||
|
||||
pub fn new<A: 'static + client::GetToken>(client: hyper::Client<S, hyper::body::Body>, auth: A) -> CustomSearchAPI<S> {
|
||||
CustomSearchAPI {
|
||||
client,
|
||||
auth: Box::new(auth),
|
||||
_user_agent: "google-api-rust-client/5.0.3".to_string(),
|
||||
_base_url: "https://customsearch.googleapis.com/".to_string(),
|
||||
_root_url: "https://customsearch.googleapis.com/".to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn cse(&'a self) -> CseMethods<'a, S> {
|
||||
CseMethods { hub: &self }
|
||||
}
|
||||
|
||||
/// Set the user-agent header field to use in all requests to the server.
|
||||
/// It defaults to `google-api-rust-client/5.0.3`.
|
||||
///
|
||||
/// Returns the previously set user-agent.
|
||||
pub fn user_agent(&mut self, agent_name: String) -> String {
|
||||
mem::replace(&mut self._user_agent, agent_name)
|
||||
}
|
||||
|
||||
/// Set the base url to use in all requests to the server.
|
||||
/// It defaults to `https://customsearch.googleapis.com/`.
|
||||
///
|
||||
/// Returns the previously set base url.
|
||||
pub fn base_url(&mut self, new_base_url: String) -> String {
|
||||
mem::replace(&mut self._base_url, new_base_url)
|
||||
}
|
||||
|
||||
/// Set the root url to use in all requests to the server.
|
||||
/// It defaults to `https://customsearch.googleapis.com/`.
|
||||
///
|
||||
/// Returns the previously set root url.
|
||||
pub fn root_url(&mut self, new_root_url: String) -> String {
|
||||
mem::replace(&mut self._root_url, new_root_url)
|
||||
}
|
||||
}
|
||||
126
gen/customsearch1/src/api/method_builders.rs
Normal file
126
gen/customsearch1/src/api/method_builders.rs
Normal file
@@ -0,0 +1,126 @@
|
||||
use super::*;
|
||||
/// A builder providing access to all methods supported on *cse* resources.
|
||||
/// It is not used directly, but through the [`CustomSearchAPI`] hub.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// Instantiate a resource builder
|
||||
///
|
||||
/// ```test_harness,no_run
|
||||
/// extern crate hyper;
|
||||
/// extern crate hyper_rustls;
|
||||
/// extern crate google_customsearch1 as customsearch1;
|
||||
///
|
||||
/// # async fn dox() {
|
||||
/// use std::default::Default;
|
||||
/// use customsearch1::{CustomSearchAPI, oauth2, hyper, hyper_rustls, chrono, FieldMask};
|
||||
///
|
||||
/// let secret: oauth2::ApplicationSecret = Default::default();
|
||||
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
|
||||
/// secret,
|
||||
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
|
||||
/// ).build().await.unwrap();
|
||||
/// let mut hub = CustomSearchAPI::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
|
||||
/// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
|
||||
/// // like `list(...)` and `siterestrict_list(...)`
|
||||
/// // to build up your call.
|
||||
/// let rb = hub.cse();
|
||||
/// # }
|
||||
/// ```
|
||||
pub struct CseMethods<'a, S>
|
||||
where S: 'a {
|
||||
|
||||
pub(super) hub: &'a CustomSearchAPI<S>,
|
||||
}
|
||||
|
||||
impl<'a, S> client::MethodsBuilder for CseMethods<'a, S> {}
|
||||
|
||||
impl<'a, S> CseMethods<'a, S> {
|
||||
|
||||
/// Create a builder to help you perform the following task:
|
||||
///
|
||||
/// Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.
|
||||
pub fn siterestrict_list(&self) -> CseSiterestrictListCall<'a, S> {
|
||||
CseSiterestrictListCall {
|
||||
hub: self.hub,
|
||||
_start: Default::default(),
|
||||
_sort: Default::default(),
|
||||
_site_search_filter: Default::default(),
|
||||
_site_search: Default::default(),
|
||||
_search_type: Default::default(),
|
||||
_safe: Default::default(),
|
||||
_rights: Default::default(),
|
||||
_related_site: Default::default(),
|
||||
_q: Default::default(),
|
||||
_or_terms: Default::default(),
|
||||
_num: Default::default(),
|
||||
_lr: Default::default(),
|
||||
_low_range: Default::default(),
|
||||
_link_site: Default::default(),
|
||||
_img_type: Default::default(),
|
||||
_img_size: Default::default(),
|
||||
_img_dominant_color: Default::default(),
|
||||
_img_color_type: Default::default(),
|
||||
_hq: Default::default(),
|
||||
_hl: Default::default(),
|
||||
_high_range: Default::default(),
|
||||
_googlehost: Default::default(),
|
||||
_gl: Default::default(),
|
||||
_filter: Default::default(),
|
||||
_file_type: Default::default(),
|
||||
_exclude_terms: Default::default(),
|
||||
_exact_terms: Default::default(),
|
||||
_date_restrict: Default::default(),
|
||||
_cx: Default::default(),
|
||||
_cr: Default::default(),
|
||||
_c2coff: Default::default(),
|
||||
_delegate: Default::default(),
|
||||
_additional_params: Default::default(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a builder to help you perform the following task:
|
||||
///
|
||||
/// Returns metadata about the search performed, metadata about the engine used for the search, and the search results.
|
||||
pub fn list(&self) -> CseListCall<'a, S> {
|
||||
CseListCall {
|
||||
hub: self.hub,
|
||||
_start: Default::default(),
|
||||
_sort: Default::default(),
|
||||
_site_search_filter: Default::default(),
|
||||
_site_search: Default::default(),
|
||||
_search_type: Default::default(),
|
||||
_safe: Default::default(),
|
||||
_rights: Default::default(),
|
||||
_related_site: Default::default(),
|
||||
_q: Default::default(),
|
||||
_or_terms: Default::default(),
|
||||
_num: Default::default(),
|
||||
_lr: Default::default(),
|
||||
_low_range: Default::default(),
|
||||
_link_site: Default::default(),
|
||||
_img_type: Default::default(),
|
||||
_img_size: Default::default(),
|
||||
_img_dominant_color: Default::default(),
|
||||
_img_color_type: Default::default(),
|
||||
_hq: Default::default(),
|
||||
_hl: Default::default(),
|
||||
_high_range: Default::default(),
|
||||
_googlehost: Default::default(),
|
||||
_gl: Default::default(),
|
||||
_filter: Default::default(),
|
||||
_file_type: Default::default(),
|
||||
_exclude_terms: Default::default(),
|
||||
_exact_terms: Default::default(),
|
||||
_date_restrict: Default::default(),
|
||||
_cx: Default::default(),
|
||||
_cr: Default::default(),
|
||||
_c2coff: Default::default(),
|
||||
_delegate: Default::default(),
|
||||
_additional_params: Default::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
32
gen/customsearch1/src/api/mod.rs
Normal file
32
gen/customsearch1/src/api/mod.rs
Normal file
@@ -0,0 +1,32 @@
|
||||
use std::collections::HashMap;
|
||||
use std::cell::RefCell;
|
||||
use std::default::Default;
|
||||
use std::collections::BTreeSet;
|
||||
use std::error::Error as StdError;
|
||||
use serde_json as json;
|
||||
use std::io;
|
||||
use std::fs;
|
||||
use std::mem;
|
||||
|
||||
use hyper::client::connect;
|
||||
use tokio::io::{AsyncRead, AsyncWrite};
|
||||
use tokio::time::sleep;
|
||||
use tower_service;
|
||||
use serde::{Serialize, Deserialize};
|
||||
|
||||
use crate::{client, client::GetToken, client::serde_with};
|
||||
|
||||
mod utilities;
|
||||
pub use utilities::*;
|
||||
|
||||
mod hub;
|
||||
pub use hub::*;
|
||||
|
||||
mod schemas;
|
||||
pub use schemas::*;
|
||||
|
||||
mod method_builders;
|
||||
pub use method_builders::*;
|
||||
|
||||
mod call_builders;
|
||||
pub use call_builders::*;
|
||||
782
gen/customsearch1/src/api/schemas.rs
Normal file
782
gen/customsearch1/src/api/schemas.rs
Normal file
@@ -0,0 +1,782 @@
|
||||
use super::*;
|
||||
/// Promotion result.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct Promotion {
|
||||
/// An array of block objects for this promotion.
|
||||
#[serde(rename="bodyLines")]
|
||||
|
||||
pub body_lines: Option<Vec<PromotionBodyLines>>,
|
||||
/// An abridged version of this search's result URL, e.g. www.example.com.
|
||||
#[serde(rename="displayLink")]
|
||||
|
||||
pub display_link: Option<String>,
|
||||
/// The title of the promotion, in HTML.
|
||||
#[serde(rename="htmlTitle")]
|
||||
|
||||
pub html_title: Option<String>,
|
||||
/// Image belonging to a promotion.
|
||||
|
||||
pub image: Option<PromotionImage>,
|
||||
/// The URL of the promotion.
|
||||
|
||||
pub link: Option<String>,
|
||||
/// The title of the promotion.
|
||||
|
||||
pub title: Option<String>,
|
||||
}
|
||||
|
||||
impl client::Part for Promotion {}
|
||||
|
||||
|
||||
/// A custom search result.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct Result {
|
||||
/// Indicates the ID of Google's cached version of the search result.
|
||||
#[serde(rename="cacheId")]
|
||||
|
||||
pub cache_id: Option<String>,
|
||||
/// An abridged version of this search result’s URL, e.g. www.example.com.
|
||||
#[serde(rename="displayLink")]
|
||||
|
||||
pub display_link: Option<String>,
|
||||
/// The file format of the search result.
|
||||
#[serde(rename="fileFormat")]
|
||||
|
||||
pub file_format: Option<String>,
|
||||
/// The URL displayed after the snippet for each search result.
|
||||
#[serde(rename="formattedUrl")]
|
||||
|
||||
pub formatted_url: Option<String>,
|
||||
/// The HTML-formatted URL displayed after the snippet for each search result.
|
||||
#[serde(rename="htmlFormattedUrl")]
|
||||
|
||||
pub html_formatted_url: Option<String>,
|
||||
/// The snippet of the search result, in HTML.
|
||||
#[serde(rename="htmlSnippet")]
|
||||
|
||||
pub html_snippet: Option<String>,
|
||||
/// The title of the search result, in HTML.
|
||||
#[serde(rename="htmlTitle")]
|
||||
|
||||
pub html_title: Option<String>,
|
||||
/// Image belonging to a custom search result.
|
||||
|
||||
pub image: Option<ResultImage>,
|
||||
/// A unique identifier for the type of current object. For this API, it is `customsearch#result.`
|
||||
|
||||
pub kind: Option<String>,
|
||||
/// Encapsulates all information about refinement labels.
|
||||
|
||||
pub labels: Option<Vec<ResultLabels>>,
|
||||
/// The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.
|
||||
|
||||
pub link: Option<String>,
|
||||
/// The MIME type of the search result.
|
||||
|
||||
pub mime: Option<String>,
|
||||
/// Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.
|
||||
|
||||
pub pagemap: Option<HashMap<String, json::Value>>,
|
||||
/// The snippet of the search result, in plain text.
|
||||
|
||||
pub snippet: Option<String>,
|
||||
/// The title of the search result, in plain text.
|
||||
|
||||
pub title: Option<String>,
|
||||
}
|
||||
|
||||
impl client::Part for Result {}
|
||||
|
||||
|
||||
/// Response to a custom search request.
|
||||
///
|
||||
/// # Activities
|
||||
///
|
||||
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
|
||||
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
|
||||
///
|
||||
/// * [siterestrict list cse](CseSiterestrictListCall) (response)
|
||||
/// * [list cse](CseListCall) (response)
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct Search {
|
||||
/// Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.
|
||||
|
||||
pub context: Option<HashMap<String, json::Value>>,
|
||||
/// The current set of custom search results.
|
||||
|
||||
pub items: Option<Vec<Result>>,
|
||||
/// Unique identifier for the type of current object. For this API, it is customsearch#search.
|
||||
|
||||
pub kind: Option<String>,
|
||||
/// The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query.
|
||||
|
||||
pub promotions: Option<Vec<Promotion>>,
|
||||
/// Query metadata for the previous, current, and next pages of results.
|
||||
|
||||
pub queries: Option<SearchQueries>,
|
||||
/// Metadata about a search operation.
|
||||
#[serde(rename="searchInformation")]
|
||||
|
||||
pub search_information: Option<SearchSearchInformation>,
|
||||
/// Spell correction information for a query.
|
||||
|
||||
pub spelling: Option<SearchSpelling>,
|
||||
/// OpenSearch template and URL.
|
||||
|
||||
pub url: Option<SearchUrl>,
|
||||
}
|
||||
|
||||
impl client::ResponseResult for Search {}
|
||||
|
||||
|
||||
/// Block object belonging to a promotion.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct PromotionBodyLines {
|
||||
/// The block object's text in HTML, if it has text.
|
||||
#[serde(rename="htmlTitle")]
|
||||
|
||||
pub html_title: Option<String>,
|
||||
/// The anchor text of the block object's link, if it has a link.
|
||||
|
||||
pub link: Option<String>,
|
||||
/// The block object's text, if it has text.
|
||||
|
||||
pub title: Option<String>,
|
||||
/// The URL of the block object's link, if it has one.
|
||||
|
||||
pub url: Option<String>,
|
||||
}
|
||||
|
||||
impl client::NestedType for PromotionBodyLines {}
|
||||
impl client::Part for PromotionBodyLines {}
|
||||
|
||||
|
||||
/// Image belonging to a promotion.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct PromotionImage {
|
||||
/// Image height in pixels.
|
||||
|
||||
pub height: Option<i32>,
|
||||
/// URL of the image for this promotion link.
|
||||
|
||||
pub source: Option<String>,
|
||||
/// Image width in pixels.
|
||||
|
||||
pub width: Option<i32>,
|
||||
}
|
||||
|
||||
impl client::NestedType for PromotionImage {}
|
||||
impl client::Part for PromotionImage {}
|
||||
|
||||
|
||||
/// Image belonging to a custom search result.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct ResultImage {
|
||||
/// The size of the image, in pixels.
|
||||
#[serde(rename="byteSize")]
|
||||
|
||||
pub byte_size: Option<i32>,
|
||||
/// A URL pointing to the webpage hosting the image.
|
||||
#[serde(rename="contextLink")]
|
||||
|
||||
pub context_link: Option<String>,
|
||||
/// The height of the image, in pixels.
|
||||
|
||||
pub height: Option<i32>,
|
||||
/// The height of the thumbnail image, in pixels.
|
||||
#[serde(rename="thumbnailHeight")]
|
||||
|
||||
pub thumbnail_height: Option<i32>,
|
||||
/// A URL to the thumbnail image.
|
||||
#[serde(rename="thumbnailLink")]
|
||||
|
||||
pub thumbnail_link: Option<String>,
|
||||
/// The width of the thumbnail image, in pixels.
|
||||
#[serde(rename="thumbnailWidth")]
|
||||
|
||||
pub thumbnail_width: Option<i32>,
|
||||
/// The width of the image, in pixels.
|
||||
|
||||
pub width: Option<i32>,
|
||||
}
|
||||
|
||||
impl client::NestedType for ResultImage {}
|
||||
impl client::Part for ResultImage {}
|
||||
|
||||
|
||||
/// Refinement label associated with a custom search result.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct ResultLabels {
|
||||
/// The display name of a refinement label. This is the name you should display in your user interface.
|
||||
#[serde(rename="displayName")]
|
||||
|
||||
pub display_name: Option<String>,
|
||||
/// Refinement label and the associated refinement operation.
|
||||
|
||||
pub label_with_op: Option<String>,
|
||||
/// The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.
|
||||
|
||||
pub name: Option<String>,
|
||||
}
|
||||
|
||||
impl client::NestedType for ResultLabels {}
|
||||
impl client::Part for ResultLabels {}
|
||||
|
||||
|
||||
/// Query metadata for the previous, current, and next pages of results.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchQueries {
|
||||
/// Metadata representing the next page of results, if applicable.
|
||||
#[serde(rename="nextPage")]
|
||||
|
||||
pub next_page: Option<Vec<SearchQueriesNextPage>>,
|
||||
/// Metadata representing the previous page of results, if applicable.
|
||||
#[serde(rename="previousPage")]
|
||||
|
||||
pub previous_page: Option<Vec<SearchQueriesPreviousPage>>,
|
||||
/// Metadata representing the current request.
|
||||
|
||||
pub request: Option<Vec<SearchQueriesRequest>>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchQueries {}
|
||||
impl client::Part for SearchQueries {}
|
||||
|
||||
|
||||
/// Custom search request metadata.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchQueriesNextPage {
|
||||
/// Number of search results returned in this set.
|
||||
|
||||
pub count: Option<i32>,
|
||||
/// Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter.
|
||||
|
||||
pub cr: Option<String>,
|
||||
/// The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.
|
||||
|
||||
pub cx: Option<String>,
|
||||
/// Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
|
||||
#[serde(rename="dateRestrict")]
|
||||
|
||||
pub date_restrict: Option<String>,
|
||||
/// Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled
|
||||
#[serde(rename="disableCnTwTranslation")]
|
||||
|
||||
pub disable_cn_tw_translation: Option<String>,
|
||||
/// Identifies a phrase that all documents in the search results must contain.
|
||||
#[serde(rename="exactTerms")]
|
||||
|
||||
pub exact_terms: Option<String>,
|
||||
/// Identifies a word or phrase that should not appear in any documents in the search results.
|
||||
#[serde(rename="excludeTerms")]
|
||||
|
||||
pub exclude_terms: Option<String>,
|
||||
/// Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).
|
||||
#[serde(rename="fileType")]
|
||||
|
||||
pub file_type: Option<String>,
|
||||
/// Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.
|
||||
|
||||
pub filter: Option<String>,
|
||||
/// Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.
|
||||
|
||||
pub gl: Option<String>,
|
||||
/// Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.
|
||||
#[serde(rename="googleHost")]
|
||||
|
||||
pub google_host: Option<String>,
|
||||
/// Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.
|
||||
#[serde(rename="highRange")]
|
||||
|
||||
pub high_range: Option<String>,
|
||||
/// Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
|
||||
|
||||
pub hl: Option<String>,
|
||||
/// Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.
|
||||
|
||||
pub hq: Option<String>,
|
||||
/// Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)
|
||||
#[serde(rename="imgColorType")]
|
||||
|
||||
pub img_color_type: Option<String>,
|
||||
/// Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`
|
||||
#[serde(rename="imgDominantColor")]
|
||||
|
||||
pub img_dominant_color: Option<String>,
|
||||
/// Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)
|
||||
#[serde(rename="imgSize")]
|
||||
|
||||
pub img_size: Option<String>,
|
||||
/// Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)
|
||||
#[serde(rename="imgType")]
|
||||
|
||||
pub img_type: Option<String>,
|
||||
/// The character encoding supported for search requests.
|
||||
#[serde(rename="inputEncoding")]
|
||||
|
||||
pub input_encoding: Option<String>,
|
||||
/// The language of the search results.
|
||||
|
||||
pub language: Option<String>,
|
||||
/// Specifies that all results should contain a link to a specific URL.
|
||||
#[serde(rename="linkSite")]
|
||||
|
||||
pub link_site: Option<String>,
|
||||
/// Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.
|
||||
#[serde(rename="lowRange")]
|
||||
|
||||
pub low_range: Option<String>,
|
||||
/// Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.
|
||||
#[serde(rename="orTerms")]
|
||||
|
||||
pub or_terms: Option<String>,
|
||||
/// The character encoding supported for search results.
|
||||
#[serde(rename="outputEncoding")]
|
||||
|
||||
pub output_encoding: Option<String>,
|
||||
/// Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.
|
||||
#[serde(rename="relatedSite")]
|
||||
|
||||
pub related_site: Option<String>,
|
||||
/// Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`
|
||||
|
||||
pub rights: Option<String>,
|
||||
/// Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch
|
||||
|
||||
pub safe: Option<String>,
|
||||
/// The search terms entered by the user.
|
||||
#[serde(rename="searchTerms")]
|
||||
|
||||
pub search_terms: Option<String>,
|
||||
/// Allowed values are `web` or `image`. If unspecified, results are limited to webpages.
|
||||
#[serde(rename="searchType")]
|
||||
|
||||
pub search_type: Option<String>,
|
||||
/// Restricts results to URLs from a specified site.
|
||||
#[serde(rename="siteSearch")]
|
||||
|
||||
pub site_search: Option<String>,
|
||||
/// Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site
|
||||
#[serde(rename="siteSearchFilter")]
|
||||
|
||||
pub site_search_filter: Option<String>,
|
||||
/// Specifies that results should be sorted according to the specified expression. For example, sort by date.
|
||||
|
||||
pub sort: Option<String>,
|
||||
/// The index of the current set of search results into the total set of results, where the index of the first result is 1.
|
||||
#[serde(rename="startIndex")]
|
||||
|
||||
pub start_index: Option<i32>,
|
||||
/// The page number of this set of results, where the page length is set by the `count` property.
|
||||
#[serde(rename="startPage")]
|
||||
|
||||
pub start_page: Option<i32>,
|
||||
/// A description of the query.
|
||||
|
||||
pub title: Option<String>,
|
||||
/// Estimated number of total search results. May not be accurate.
|
||||
#[serde(rename="totalResults")]
|
||||
|
||||
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
|
||||
pub total_results: Option<i64>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchQueriesNextPage {}
|
||||
impl client::Part for SearchQueriesNextPage {}
|
||||
|
||||
|
||||
/// Custom search request metadata.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchQueriesPreviousPage {
|
||||
/// Number of search results returned in this set.
|
||||
|
||||
pub count: Option<i32>,
|
||||
/// Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter.
|
||||
|
||||
pub cr: Option<String>,
|
||||
/// The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.
|
||||
|
||||
pub cx: Option<String>,
|
||||
/// Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
|
||||
#[serde(rename="dateRestrict")]
|
||||
|
||||
pub date_restrict: Option<String>,
|
||||
/// Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled
|
||||
#[serde(rename="disableCnTwTranslation")]
|
||||
|
||||
pub disable_cn_tw_translation: Option<String>,
|
||||
/// Identifies a phrase that all documents in the search results must contain.
|
||||
#[serde(rename="exactTerms")]
|
||||
|
||||
pub exact_terms: Option<String>,
|
||||
/// Identifies a word or phrase that should not appear in any documents in the search results.
|
||||
#[serde(rename="excludeTerms")]
|
||||
|
||||
pub exclude_terms: Option<String>,
|
||||
/// Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).
|
||||
#[serde(rename="fileType")]
|
||||
|
||||
pub file_type: Option<String>,
|
||||
/// Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.
|
||||
|
||||
pub filter: Option<String>,
|
||||
/// Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.
|
||||
|
||||
pub gl: Option<String>,
|
||||
/// Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.
|
||||
#[serde(rename="googleHost")]
|
||||
|
||||
pub google_host: Option<String>,
|
||||
/// Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.
|
||||
#[serde(rename="highRange")]
|
||||
|
||||
pub high_range: Option<String>,
|
||||
/// Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
|
||||
|
||||
pub hl: Option<String>,
|
||||
/// Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.
|
||||
|
||||
pub hq: Option<String>,
|
||||
/// Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)
|
||||
#[serde(rename="imgColorType")]
|
||||
|
||||
pub img_color_type: Option<String>,
|
||||
/// Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`
|
||||
#[serde(rename="imgDominantColor")]
|
||||
|
||||
pub img_dominant_color: Option<String>,
|
||||
/// Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)
|
||||
#[serde(rename="imgSize")]
|
||||
|
||||
pub img_size: Option<String>,
|
||||
/// Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)
|
||||
#[serde(rename="imgType")]
|
||||
|
||||
pub img_type: Option<String>,
|
||||
/// The character encoding supported for search requests.
|
||||
#[serde(rename="inputEncoding")]
|
||||
|
||||
pub input_encoding: Option<String>,
|
||||
/// The language of the search results.
|
||||
|
||||
pub language: Option<String>,
|
||||
/// Specifies that all results should contain a link to a specific URL.
|
||||
#[serde(rename="linkSite")]
|
||||
|
||||
pub link_site: Option<String>,
|
||||
/// Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.
|
||||
#[serde(rename="lowRange")]
|
||||
|
||||
pub low_range: Option<String>,
|
||||
/// Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.
|
||||
#[serde(rename="orTerms")]
|
||||
|
||||
pub or_terms: Option<String>,
|
||||
/// The character encoding supported for search results.
|
||||
#[serde(rename="outputEncoding")]
|
||||
|
||||
pub output_encoding: Option<String>,
|
||||
/// Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.
|
||||
#[serde(rename="relatedSite")]
|
||||
|
||||
pub related_site: Option<String>,
|
||||
/// Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`
|
||||
|
||||
pub rights: Option<String>,
|
||||
/// Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch
|
||||
|
||||
pub safe: Option<String>,
|
||||
/// The search terms entered by the user.
|
||||
#[serde(rename="searchTerms")]
|
||||
|
||||
pub search_terms: Option<String>,
|
||||
/// Allowed values are `web` or `image`. If unspecified, results are limited to webpages.
|
||||
#[serde(rename="searchType")]
|
||||
|
||||
pub search_type: Option<String>,
|
||||
/// Restricts results to URLs from a specified site.
|
||||
#[serde(rename="siteSearch")]
|
||||
|
||||
pub site_search: Option<String>,
|
||||
/// Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site
|
||||
#[serde(rename="siteSearchFilter")]
|
||||
|
||||
pub site_search_filter: Option<String>,
|
||||
/// Specifies that results should be sorted according to the specified expression. For example, sort by date.
|
||||
|
||||
pub sort: Option<String>,
|
||||
/// The index of the current set of search results into the total set of results, where the index of the first result is 1.
|
||||
#[serde(rename="startIndex")]
|
||||
|
||||
pub start_index: Option<i32>,
|
||||
/// The page number of this set of results, where the page length is set by the `count` property.
|
||||
#[serde(rename="startPage")]
|
||||
|
||||
pub start_page: Option<i32>,
|
||||
/// A description of the query.
|
||||
|
||||
pub title: Option<String>,
|
||||
/// Estimated number of total search results. May not be accurate.
|
||||
#[serde(rename="totalResults")]
|
||||
|
||||
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
|
||||
pub total_results: Option<i64>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchQueriesPreviousPage {}
|
||||
impl client::Part for SearchQueriesPreviousPage {}
|
||||
|
||||
|
||||
/// Custom search request metadata.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchQueriesRequest {
|
||||
/// Number of search results returned in this set.
|
||||
|
||||
pub count: Option<i32>,
|
||||
/// Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter.
|
||||
|
||||
pub cr: Option<String>,
|
||||
/// The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.
|
||||
|
||||
pub cx: Option<String>,
|
||||
/// Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
|
||||
#[serde(rename="dateRestrict")]
|
||||
|
||||
pub date_restrict: Option<String>,
|
||||
/// Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled
|
||||
#[serde(rename="disableCnTwTranslation")]
|
||||
|
||||
pub disable_cn_tw_translation: Option<String>,
|
||||
/// Identifies a phrase that all documents in the search results must contain.
|
||||
#[serde(rename="exactTerms")]
|
||||
|
||||
pub exact_terms: Option<String>,
|
||||
/// Identifies a word or phrase that should not appear in any documents in the search results.
|
||||
#[serde(rename="excludeTerms")]
|
||||
|
||||
pub exclude_terms: Option<String>,
|
||||
/// Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).
|
||||
#[serde(rename="fileType")]
|
||||
|
||||
pub file_type: Option<String>,
|
||||
/// Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.
|
||||
|
||||
pub filter: Option<String>,
|
||||
/// Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.
|
||||
|
||||
pub gl: Option<String>,
|
||||
/// Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.
|
||||
#[serde(rename="googleHost")]
|
||||
|
||||
pub google_host: Option<String>,
|
||||
/// Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.
|
||||
#[serde(rename="highRange")]
|
||||
|
||||
pub high_range: Option<String>,
|
||||
/// Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
|
||||
|
||||
pub hl: Option<String>,
|
||||
/// Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.
|
||||
|
||||
pub hq: Option<String>,
|
||||
/// Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)
|
||||
#[serde(rename="imgColorType")]
|
||||
|
||||
pub img_color_type: Option<String>,
|
||||
/// Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`
|
||||
#[serde(rename="imgDominantColor")]
|
||||
|
||||
pub img_dominant_color: Option<String>,
|
||||
/// Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)
|
||||
#[serde(rename="imgSize")]
|
||||
|
||||
pub img_size: Option<String>,
|
||||
/// Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)
|
||||
#[serde(rename="imgType")]
|
||||
|
||||
pub img_type: Option<String>,
|
||||
/// The character encoding supported for search requests.
|
||||
#[serde(rename="inputEncoding")]
|
||||
|
||||
pub input_encoding: Option<String>,
|
||||
/// The language of the search results.
|
||||
|
||||
pub language: Option<String>,
|
||||
/// Specifies that all results should contain a link to a specific URL.
|
||||
#[serde(rename="linkSite")]
|
||||
|
||||
pub link_site: Option<String>,
|
||||
/// Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.
|
||||
#[serde(rename="lowRange")]
|
||||
|
||||
pub low_range: Option<String>,
|
||||
/// Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.
|
||||
#[serde(rename="orTerms")]
|
||||
|
||||
pub or_terms: Option<String>,
|
||||
/// The character encoding supported for search results.
|
||||
#[serde(rename="outputEncoding")]
|
||||
|
||||
pub output_encoding: Option<String>,
|
||||
/// Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.
|
||||
#[serde(rename="relatedSite")]
|
||||
|
||||
pub related_site: Option<String>,
|
||||
/// Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`
|
||||
|
||||
pub rights: Option<String>,
|
||||
/// Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch
|
||||
|
||||
pub safe: Option<String>,
|
||||
/// The search terms entered by the user.
|
||||
#[serde(rename="searchTerms")]
|
||||
|
||||
pub search_terms: Option<String>,
|
||||
/// Allowed values are `web` or `image`. If unspecified, results are limited to webpages.
|
||||
#[serde(rename="searchType")]
|
||||
|
||||
pub search_type: Option<String>,
|
||||
/// Restricts results to URLs from a specified site.
|
||||
#[serde(rename="siteSearch")]
|
||||
|
||||
pub site_search: Option<String>,
|
||||
/// Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site
|
||||
#[serde(rename="siteSearchFilter")]
|
||||
|
||||
pub site_search_filter: Option<String>,
|
||||
/// Specifies that results should be sorted according to the specified expression. For example, sort by date.
|
||||
|
||||
pub sort: Option<String>,
|
||||
/// The index of the current set of search results into the total set of results, where the index of the first result is 1.
|
||||
#[serde(rename="startIndex")]
|
||||
|
||||
pub start_index: Option<i32>,
|
||||
/// The page number of this set of results, where the page length is set by the `count` property.
|
||||
#[serde(rename="startPage")]
|
||||
|
||||
pub start_page: Option<i32>,
|
||||
/// A description of the query.
|
||||
|
||||
pub title: Option<String>,
|
||||
/// Estimated number of total search results. May not be accurate.
|
||||
#[serde(rename="totalResults")]
|
||||
|
||||
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
|
||||
pub total_results: Option<i64>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchQueriesRequest {}
|
||||
impl client::Part for SearchQueriesRequest {}
|
||||
|
||||
|
||||
/// Metadata about a search operation.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchSearchInformation {
|
||||
/// The time taken for the server to return search results, formatted according to locale style.
|
||||
#[serde(rename="formattedSearchTime")]
|
||||
|
||||
pub formatted_search_time: Option<String>,
|
||||
/// The total number of search results, formatted according to locale style.
|
||||
#[serde(rename="formattedTotalResults")]
|
||||
|
||||
pub formatted_total_results: Option<String>,
|
||||
/// The time taken for the server to return search results.
|
||||
#[serde(rename="searchTime")]
|
||||
|
||||
pub search_time: Option<f64>,
|
||||
/// The total number of search results returned by the query.
|
||||
#[serde(rename="totalResults")]
|
||||
|
||||
pub total_results: Option<String>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchSearchInformation {}
|
||||
impl client::Part for SearchSearchInformation {}
|
||||
|
||||
|
||||
/// Spell correction information for a query.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchSpelling {
|
||||
/// The corrected query.
|
||||
#[serde(rename="correctedQuery")]
|
||||
|
||||
pub corrected_query: Option<String>,
|
||||
/// The corrected query, formatted in HTML.
|
||||
#[serde(rename="htmlCorrectedQuery")]
|
||||
|
||||
pub html_corrected_query: Option<String>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchSpelling {}
|
||||
impl client::Part for SearchSpelling {}
|
||||
|
||||
|
||||
/// OpenSearch template and URL.
|
||||
///
|
||||
/// This type is not used in any activity, and only used as *part* of another schema.
|
||||
///
|
||||
#[serde_with::serde_as(crate = "::client::serde_with")]
|
||||
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct SearchUrl {
|
||||
/// The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API.
|
||||
|
||||
pub template: Option<String>,
|
||||
/// The MIME type of the OpenSearch URL template for the Custom Search JSON API.
|
||||
#[serde(rename="type")]
|
||||
|
||||
pub type_: Option<String>,
|
||||
}
|
||||
|
||||
impl client::NestedType for SearchUrl {}
|
||||
impl client::Part for SearchUrl {}
|
||||
|
||||
|
||||
2
gen/customsearch1/src/api/utilities.rs
Normal file
2
gen/customsearch1/src/api/utilities.rs
Normal file
@@ -0,0 +1,2 @@
|
||||
use super::*;
|
||||
|
||||
Reference in New Issue
Block a user