SearchConsole.Searchanalytics.Query (Google Search Console API v1-rev20250714-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.searchconsole.v1.SearchConsoleRequest<SearchAnalyticsQueryResponse>
        
        com.google.api.services.searchconsole.v1.SearchConsole.Searchanalytics.Query

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: SearchConsole.Searchanalytics

public class SearchConsole.Searchanalytics.Query
extends SearchConsoleRequest<SearchAnalyticsQueryResponse>

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Query(String siteUrl, SearchAnalyticsQueryRequest content)
Query your data with filters and parameters that you define.

Constructors
Modifier	Constructor and Description
`protected`	`Query(String siteUrl, SearchAnalyticsQueryRequest content)` Query your data with filters and parameters that you define.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getSiteUrl()` The site's URL, including protocol.
`SearchConsole.Searchanalytics.Query`	`set(String parameterName, Object value)`
`SearchConsole.Searchanalytics.Query`	`set$Xgafv(String $Xgafv)` V1 error format.
`SearchConsole.Searchanalytics.Query`	`setAccessToken(String accessToken)` OAuth access token.
`SearchConsole.Searchanalytics.Query`	`setAlt(String alt)` Data format for response.
`SearchConsole.Searchanalytics.Query`	`setCallback(String callback)` JSONP
`SearchConsole.Searchanalytics.Query`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`SearchConsole.Searchanalytics.Query`	`setKey(String key)` API key.
`SearchConsole.Searchanalytics.Query`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`SearchConsole.Searchanalytics.Query`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`SearchConsole.Searchanalytics.Query`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`SearchConsole.Searchanalytics.Query`	`setSiteUrl(String siteUrl)` The site's URL, including protocol.
`SearchConsole.Searchanalytics.Query`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`SearchConsole.Searchanalytics.Query`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.searchconsole.v1.SearchConsoleRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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
  - Query
```
protected Query(String siteUrl,
                SearchAnalyticsQueryRequest content)
```
    Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned. Create a request for the method "searchanalytics.query". This request holds the parameters needed by the the searchconsole server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    SearchConsole.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    siteUrl - The site's URL, including protocol. For example: `http://www.example.com/`.
    
    content - the SearchAnalyticsQueryRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public SearchConsole.Searchanalytics.Query set$Xgafv(String $Xgafv)
```
    Description copied from class: SearchConsoleRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setAccessToken
```
public SearchConsole.Searchanalytics.Query setAccessToken(String accessToken)
```
    Description copied from class: SearchConsoleRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setAlt
```
public SearchConsole.Searchanalytics.Query setAlt(String alt)
```
    Description copied from class: SearchConsoleRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setCallback
```
public SearchConsole.Searchanalytics.Query setCallback(String callback)
```
    Description copied from class: SearchConsoleRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setFields
```
public SearchConsole.Searchanalytics.Query setFields(String fields)
```
    Description copied from class: SearchConsoleRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setKey
```
public SearchConsole.Searchanalytics.Query setKey(String key)
```
    Description copied from class: SearchConsoleRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setOauthToken
```
public SearchConsole.Searchanalytics.Query setOauthToken(String oauthToken)
```
    Description copied from class: SearchConsoleRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setPrettyPrint
```
public SearchConsole.Searchanalytics.Query setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SearchConsoleRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setQuotaUser
```
public SearchConsole.Searchanalytics.Query setQuotaUser(String quotaUser)
```
    Description copied from class: SearchConsoleRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setUploadType
```
public SearchConsole.Searchanalytics.Query setUploadType(String uploadType)
```
    Description copied from class: SearchConsoleRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - setUploadProtocol
```
public SearchConsole.Searchanalytics.Query setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SearchConsoleRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SearchConsoleRequest<SearchAnalyticsQueryResponse>
  - getSiteUrl
```
public String getSiteUrl()
```
    The site's URL, including protocol. For example: `http://www.example.com/`.
  - setSiteUrl
```
public SearchConsole.Searchanalytics.Query setSiteUrl(String siteUrl)
```
    The site's URL, including protocol. For example: `http://www.example.com/`.
  - set
```
public SearchConsole.Searchanalytics.Query set(String parameterName,
                                               Object value)
```
    Overrides:
    
    set in class SearchConsoleRequest<SearchAnalyticsQueryResponse>

Class SearchConsole.Searchanalytics.Query

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.searchconsole.v1.SearchConsoleRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Query

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSiteUrl

setSiteUrl

set