Class SearchAnalyticsQueryRequest

Inheritance
object
SearchAnalyticsQueryRequest
Implements
Inherited Members
Namespace: Google.Apis.SearchConsole.v1.Data
Assembly: Google.Apis.SearchConsole.v1.dll
Syntax
public class SearchAnalyticsQueryRequest : IDirectResponseSchema

Properties

AggregationType

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

Declaration
[JsonProperty("aggregationType")]
public virtual string AggregationType { get; set; }
Property Value
Type Description
string

DataState

The data state to be fetched, can be full or all, the latter including full and partial data.

Declaration
[JsonProperty("dataState")]
public virtual string DataState { get; set; }
Property Value
Type Description
string

DimensionFilterGroups

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

Declaration
[JsonProperty("dimensionFilterGroups")]
public virtual IList<ApiDimensionFilterGroup> DimensionFilterGroups { get; set; }
Property Value
Type Description
IList<ApiDimensionFilterGroup>

Dimensions

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

Declaration
[JsonProperty("dimensions")]
public virtual IList<string> Dimensions { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndDate

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

Declaration
[JsonProperty("endDate")]
public virtual string EndDate { get; set; }
Property Value
Type Description
string

RowLimit

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

Declaration
[JsonProperty("rowLimit")]
public virtual int? RowLimit { get; set; }
Property Value
Type Description
int?

SearchType

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

Declaration
[JsonProperty("searchType")]
public virtual string SearchType { get; set; }
Property Value
Type Description
string

StartDate

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

Declaration
[JsonProperty("startDate")]
public virtual string StartDate { get; set; }
Property Value
Type Description
string

StartRow

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

Declaration
[JsonProperty("startRow")]
public virtual int? StartRow { get; set; }
Property Value
Type Description
int?

Type

Optional. [Optional; Default is "web"] Type of report: search type, or either Discover or Gnews.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements