Struct google_webmasters3::api::SearchAnalyticsQueryRequest

pub struct SearchAnalyticsQueryRequest {
    pub aggregation_type: Option<String>,
    pub data_state: Option<String>,
    pub dimension_filter_groups: Option<Vec<ApiDimensionFilterGroup>>,
    pub dimensions: Option<Vec<String>>,
    pub end_date: Option<String>,
    pub row_limit: Option<i32>,
    pub search_type: Option<String>,
    pub start_date: Option<String>,
    pub start_row: Option<i32>,
}

There is no detailed description.

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).

• query searchanalytics (request)

Fields

aggregation_type: Option<String>

[Optional; Default is “auto”] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page.

Note: If you group or filter by page, you cannot aggregate by property.

If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.

data_state: Option<String>

[Optional] If “all” (case-insensitive), data will include fresh data. If “final” (case-insensitive) or if this parameter is omitted, the returned data will include only finalized data.

dimension_filter_groups: Option<Vec<ApiDimensionFilterGroup>>

[Optional] Zero or more filters to apply to the dimension grouping values; for example, ‘query contains “buy”’ to see only data where the query string contains the substring “buy” (not case-sensitive). You can filter by a dimension without grouping by it.

dimensions: Option<Vec<String>>

[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.

end_date: Option<String>

[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.

row_limit: Option<i32>

[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).

search_type: Option<String>

[Optional; Default is “web”] The search type to filter for.

start_date: Option<String>

[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.

start_row: Option<i32>

[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.

Trait Implementations

impl Clone for SearchAnalyticsQueryRequest

fn clone(&self) -> SearchAnalyticsQueryRequest

Returns a copy of the value.

pub 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 RequestValue for SearchAnalyticsQueryRequest

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.