com.google.api.services.searchconsole.v1.model

Class SearchAnalyticsQueryRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.searchconsole.v1.model.SearchAnalyticsQueryRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SearchAnalyticsQueryRequest
extends com.google.api.client.json.GenericJson

Model definition for SearchAnalyticsQueryRequest.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Search Console API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SearchAnalyticsQueryRequest()

Method Summary

Modifier and Type	Method and Description
SearchAnalyticsQueryRequest	clone()
String	getAggregationType() [Optional; Default is \"auto\"] How data is aggregated.
String	getDataState() The data state to be fetched, can be full or all, the latter including full and partial data.
List<ApiDimensionFilterGroup>	getDimensionFilterGroups() [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).
List<String>	getDimensions() [Optional] Zero or more dimensions to group results by.
String	getEndDate() [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00).
Integer	getRowLimit() [Optional; Default is 1000] The maximum number of rows to return.
String	getSearchType() [Optional; Default is \"web\"] The search type to filter for.
String	getStartDate() [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00).
Integer	getStartRow() [Optional; Default is 0] Zero-based index of the first row in the response.
String	getType() Optional.
SearchAnalyticsQueryRequest	set(String fieldName, Object value)
SearchAnalyticsQueryRequest	setAggregationType(String aggregationType) [Optional; Default is \"auto\"] How data is aggregated.
SearchAnalyticsQueryRequest	setDataState(String dataState) The data state to be fetched, can be full or all, the latter including full and partial data.
SearchAnalyticsQueryRequest	setDimensionFilterGroups(List<ApiDimensionFilterGroup> 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).
SearchAnalyticsQueryRequest	setDimensions(List<String> dimensions) [Optional] Zero or more dimensions to group results by.
SearchAnalyticsQueryRequest	setEndDate(String endDate) [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00).
SearchAnalyticsQueryRequest	setRowLimit(Integer rowLimit) [Optional; Default is 1000] The maximum number of rows to return.
SearchAnalyticsQueryRequest	setSearchType(String searchType) [Optional; Default is \"web\"] The search type to filter for.
SearchAnalyticsQueryRequest	setStartDate(String startDate) [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00).
SearchAnalyticsQueryRequest	setStartRow(Integer startRow) [Optional; Default is 0] Zero-based index of the first row in the response.
SearchAnalyticsQueryRequest	setType(String type) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SearchAnalyticsQueryRequest

public SearchAnalyticsQueryRequest()

Method Detail

getAggregationType

public String getAggregationType()

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

Returns:

value or null for none

setAggregationType

public SearchAnalyticsQueryRequest setAggregationType(String 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.

Parameters:

aggregationType - aggregationType or null for none

getDataState

public String getDataState()

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

Returns:

value or null for none

setDataState

public SearchAnalyticsQueryRequest setDataState(String dataState)

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

Parameters:

dataState - dataState or null for none

getDimensionFilterGroups

public List<ApiDimensionFilterGroup> getDimensionFilterGroups()

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

Returns:

value or null for none

setDimensionFilterGroups

public SearchAnalyticsQueryRequest setDimensionFilterGroups(List<ApiDimensionFilterGroup> 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.

Parameters:

dimensionFilterGroups - dimensionFilterGroups or null for none

getDimensions

public List<String> getDimensions()

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

Returns:

value or null for none

setDimensions

public SearchAnalyticsQueryRequest setDimensions(List<String> 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.

Parameters:

dimensions - dimensions or null for none

getEndDate

public String getEndDate()

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

Returns:

value or null for none

setEndDate

public SearchAnalyticsQueryRequest setEndDate(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.

Parameters:

endDate - endDate or null for none

getRowLimit

public Integer getRowLimit()

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

Returns:

value or null for none

setRowLimit

public SearchAnalyticsQueryRequest setRowLimit(Integer rowLimit)

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

Parameters:

rowLimit - rowLimit or null for none

getSearchType

public String getSearchType()

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

Returns:

value or null for none

setSearchType

public SearchAnalyticsQueryRequest setSearchType(String searchType)

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

Parameters:

searchType - searchType or null for none

getStartDate

public String getStartDate()

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

Returns:

value or null for none

setStartDate

public SearchAnalyticsQueryRequest setStartDate(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.

Parameters:

startDate - startDate or null for none

getStartRow

public Integer getStartRow()

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

Returns:

value or null for none

setStartRow

public SearchAnalyticsQueryRequest setStartRow(Integer startRow)

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

Parameters:

startRow - startRow or null for none

getType

public String getType()

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

Returns:

value or null for none

setType

public SearchAnalyticsQueryRequest setType(String type)

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

Parameters:

type - type or null for none

set

public SearchAnalyticsQueryRequest set(String fieldName,
                                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SearchAnalyticsQueryRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson