target.apidocs.com.google.api.services.webmasters.Webmasters.Searchanalytics.Query.html Maven / Gradle / Ivy

Go to download







Webmasters.Searchanalytics.Query (Search Console API v3-rev20190428-1.30.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.webmasters
Class Webmasters.Searchanalytics.Query



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.webmasters.WebmastersRequest<SearchAnalyticsQueryResponse>


com.google.api.services.webmasters.Webmasters.Searchanalytics.Query

















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


Enclosing class:
Webmasters.Searchanalytics




public class Webmasters.Searchanalytics.Query
extends WebmastersRequest<SearchAnalyticsQueryResponse>











Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
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
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.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
getSiteUrl()
The site's URL, including protocol.



Webmasters.Searchanalytics.Query
set(String parameterName,
   Object value) 


Webmasters.Searchanalytics.Query
setAlt(String alt)
Data format for the response.



Webmasters.Searchanalytics.Query
setFields(String fields)
Selector specifying which fields to include in a partial response.



Webmasters.Searchanalytics.Query
setKey(String key)
API key.



Webmasters.Searchanalytics.Query
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



Webmasters.Searchanalytics.Query
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Webmasters.Searchanalytics.Query
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.



Webmasters.Searchanalytics.Query
setSiteUrl(String siteUrl)
The site's URL, including protocol.



Webmasters.Searchanalytics.Query
setUserIp(String userIp)
Deprecated.







Methods inherited from class com.google.api.services.webmasters.WebmastersRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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 webmasters server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
  Webmasters.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





setAlt
public Webmasters.Searchanalytics.Query setAlt(String alt)
Description copied from class: WebmastersRequest
Data format for the response.

Overrides:
setAlt in class WebmastersRequest<SearchAnalyticsQueryResponse>








setFields
public Webmasters.Searchanalytics.Query setFields(String fields)
Description copied from class: WebmastersRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class WebmastersRequest<SearchAnalyticsQueryResponse>








setKey
public Webmasters.Searchanalytics.Query setKey(String key)
Description copied from class: WebmastersRequest
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 WebmastersRequest<SearchAnalyticsQueryResponse>








setOauthToken
public Webmasters.Searchanalytics.Query setOauthToken(String oauthToken)
Description copied from class: WebmastersRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class WebmastersRequest<SearchAnalyticsQueryResponse>








setPrettyPrint
public Webmasters.Searchanalytics.Query setPrettyPrint(Boolean prettyPrint)
Description copied from class: WebmastersRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class WebmastersRequest<SearchAnalyticsQueryResponse>








setQuotaUser
public Webmasters.Searchanalytics.Query setQuotaUser(String quotaUser)
Description copied from class: WebmastersRequest
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:
setQuotaUser in class WebmastersRequest<SearchAnalyticsQueryResponse>








setUserIp
public Webmasters.Searchanalytics.Query setUserIp(String userIp)
Description copied from class: WebmastersRequest
Deprecated. Please use quotaUser instead.

Overrides:
setUserIp in class WebmastersRequest<SearchAnalyticsQueryResponse>








getSiteUrl
public String getSiteUrl()
The site's URL, including protocol. For example: http://www.example.com/







setSiteUrl
public Webmasters.Searchanalytics.Query setSiteUrl(String siteUrl)
The site's URL, including protocol. For example: http://www.example.com/







set
public Webmasters.Searchanalytics.Query set(String parameterName,
                                            Object value)

Overrides:
set in class WebmastersRequest<SearchAnalyticsQueryResponse>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2019 Google. All rights reserved.

Modifier and Type	Method and Description
`String`	`getSiteUrl()` The site's URL, including protocol.
`Webmasters.Searchanalytics.Query`	`set(String parameterName, Object value)`
`Webmasters.Searchanalytics.Query`	`setAlt(String alt)` Data format for the response.
`Webmasters.Searchanalytics.Query`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Webmasters.Searchanalytics.Query`	`setKey(String key)` API key.
`Webmasters.Searchanalytics.Query`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Webmasters.Searchanalytics.Query`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Webmasters.Searchanalytics.Query`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Webmasters.Searchanalytics.Query`	`setSiteUrl(String siteUrl)` The site's URL, including protocol.
`Webmasters.Searchanalytics.Query`	`setUserIp(String userIp)` Deprecated.