public final class SearchAnalyticsQueryRequest
extends com.google.api.client.json.GenericJson
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
com.google.api.client.util.GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
SearchAnalyticsQueryRequest() |
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.
|
getFactory, setFactory, toPrettyString, toString
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public String getAggregationType()
null
for nonepublic SearchAnalyticsQueryRequest setAggregationType(String aggregationType)
aggregationType
- aggregationType or null
for nonepublic String getDataState()
null
for nonepublic SearchAnalyticsQueryRequest setDataState(String dataState)
dataState
- dataState or null
for nonepublic List<ApiDimensionFilterGroup> getDimensionFilterGroups()
null
for nonepublic SearchAnalyticsQueryRequest setDimensionFilterGroups(List<ApiDimensionFilterGroup> dimensionFilterGroups)
dimensionFilterGroups
- dimensionFilterGroups or null
for nonepublic List<String> getDimensions()
null
for nonepublic SearchAnalyticsQueryRequest setDimensions(List<String> dimensions)
dimensions
- dimensions or null
for nonepublic String getEndDate()
null
for nonepublic SearchAnalyticsQueryRequest setEndDate(String endDate)
endDate
- endDate or null
for nonepublic Integer getRowLimit()
null
for nonepublic SearchAnalyticsQueryRequest setRowLimit(Integer rowLimit)
rowLimit
- rowLimit or null
for nonepublic String getSearchType()
null
for nonepublic SearchAnalyticsQueryRequest setSearchType(String searchType)
searchType
- searchType or null
for nonepublic String getStartDate()
null
for nonepublic SearchAnalyticsQueryRequest setStartDate(String startDate)
startDate
- startDate or null
for nonepublic Integer getStartRow()
null
for nonepublic SearchAnalyticsQueryRequest setStartRow(Integer startRow)
startRow
- startRow or null
for nonepublic String getType()
null
for nonepublic SearchAnalyticsQueryRequest setType(String type)
type
- type or null
for nonepublic SearchAnalyticsQueryRequest set(String fieldName, Object value)
set
in class com.google.api.client.json.GenericJson
public SearchAnalyticsQueryRequest clone()
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.