Struct SearchAnalyticsQueryRequest 

pub struct SearchAnalyticsQueryRequest {
    pub start_date: String,
    pub end_date: String,
    pub dimensions: Option<Vec<Dimension>>,
    pub search_type: Option<SearchType>,
    pub dimension_filter_groups: Option<Vec<DimensionFilterGroup>>,
    pub aggregation_type: Option<AggregationType>,
    pub row_limit: Option<usize>,
    pub start_row: Option<usize>,
    pub data_state: Option<DataState>,
}

Request parameters for the Search Analytics query API.

Use the builder pattern for easier construction:

Example

use google_search_console_api::search_analytics::query::SearchAnalyticsQueryRequest;
use google_search_console_api::types::Dimension;

let request = SearchAnalyticsQueryRequest::builder("2024-01-01", "2024-01-31")
    .dimensions(vec![Dimension::Query, Dimension::Page])
    .row_limit(1000)
    .build();

Fields

start_date: String

Start date of the query (YYYY-MM-DD format).

end_date: String

End date of the query (YYYY-MM-DD format).

dimensions: Option<Vec<Dimension>>

Dimensions to group results by.

search_type: Option<SearchType>

Type of search to filter by.

dimension_filter_groups: Option<Vec<DimensionFilterGroup>>

Filter groups to apply to the query.

aggregation_type: Option<AggregationType>

How to aggregate the results.

row_limit: Option<usize>

Maximum number of rows to return (1-25000).

start_row: Option<usize>

Zero-based index of the first row to return (for pagination).

data_state: Option<DataState>

Data freshness preference.

Implementations

impl SearchAnalyticsQueryRequest

pub fn builder( start_date: &str, end_date: &str, ) -> SearchAnalyticsQueryRequestBuilder

Create a new builder for SearchAnalyticsQueryRequest.

Arguments

• start_date - Start date in YYYY-MM-DD format
• end_date - End date in YYYY-MM-DD format

Example

use google_search_console_api::search_analytics::query::SearchAnalyticsQueryRequest;

let request = SearchAnalyticsQueryRequest::builder("2024-01-01", "2024-01-31")
    .row_limit(100)
    .build();

Trait Implementations

impl Clone for SearchAnalyticsQueryRequest

fn clone(&self) -> SearchAnalyticsQueryRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchAnalyticsQueryRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchAnalyticsQueryRequest

fn default() -> SearchAnalyticsQueryRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchAnalyticsQueryRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchAnalyticsQueryRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.