com.google.api.services.content.model

Class SearchRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.SearchRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Request message for the ReportService.Search method.

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 Content API for Shopping. 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
SearchRequest()

Method Summary

Modifier and Type	Method and Description
SearchRequest	clone()
Integer	getPageSize() Number of ReportRows to retrieve in a single page.
String	getPageToken() Token of the page to retrieve.
String	getQuery() Required.
SearchRequest	set(String fieldName, Object value)
SearchRequest	setPageSize(Integer pageSize) Number of ReportRows to retrieve in a single page.
SearchRequest	setPageToken(String pageToken) Token of the page to retrieve.
SearchRequest	setQuery(String query) Required.

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

SearchRequest

public SearchRequest()

Method Detail

getPageSize

public Integer getPageSize()

Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.

Returns:

value or null for none

setPageSize

public SearchRequest setPageSize(Integer pageSize)

Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.

Parameters:

pageSize - pageSize or null for none

getPageToken

public String getPageToken()

Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.

Returns:

value or null for none

setPageToken

public SearchRequest setPageToken(String pageToken)

Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.

Parameters:

pageToken - pageToken or null for none

getQuery

public String getQuery()

Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the [Query Language guide](https://developers.google.com/shopping-content/guides/reports/query- language/overview).

Returns:

value or null for none

setQuery

public SearchRequest setQuery(String query)

Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the [Query Language guide](https://developers.google.com/shopping-content/guides/reports/query- language/overview).

Parameters:

query - query or null for none

set

public SearchRequest set(String fieldName,
                         Object value)

Overrides:

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

clone

public SearchRequest clone()

Overrides:

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