com.google.api.services.webmasters

Class Webmasters

java.lang.Object

com.google.api.client.googleapis.services.AbstractGoogleClient

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

com.google.api.services.webmasters.Webmasters

public class Webmasters
extends AbstractGoogleJsonClient

Service definition for Webmasters (v3).

View Google Search Console data for your verified sites.

For more information about this service, see the API Documentation

This service uses WebmastersRequestInitializer to initialize global parameters via its Webmasters.Builder.

Since:

1.3

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Webmasters.Builder Builder for Webmasters.
class	Webmasters.Searchanalytics The "searchanalytics" collection of methods.
class	Webmasters.Sitemaps The "sitemaps" collection of methods.
class	Webmasters.Sites The "sites" collection of methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BASE_URL The default encoded base URL of the service.
static String	DEFAULT_BATCH_PATH The default encoded batch path of the service.
static String	DEFAULT_MTLS_ROOT_URL The default encoded mTLS root URL of the service.
static String	DEFAULT_ROOT_URL The default encoded root URL of the service.
static String	DEFAULT_SERVICE_PATH The default encoded service path of the service.

Constructor Summary

Constructors

Constructor and Description
Webmasters(HttpTransport transport, JsonFactory jsonFactory, HttpRequestInitializer httpRequestInitializer) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	initialize(AbstractGoogleClientRequest<?> httpClientRequest)
Webmasters.Searchanalytics	searchanalytics() An accessor for creating requests from the Searchanalytics collection.
Webmasters.Sitemaps	sitemaps() An accessor for creating requests from the Sitemaps collection.
Webmasters.Sites	sites() An accessor for creating requests from the Sites collection.

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

getJsonFactory, getObjectParser

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

batch, batch, getApplicationName, getBaseUrl, getGoogleClientRequestInitializer, getRequestFactory, getRootUrl, getServicePath, getSuppressPatternChecks, getSuppressRequiredParameterChecks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROOT_URL

public static final String DEFAULT_ROOT_URL

The default encoded root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_MTLS_ROOT_URL

public static final String DEFAULT_MTLS_ROOT_URL

The default encoded mTLS root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.31

See Also:

Constant Field Values

DEFAULT_SERVICE_PATH

public static final String DEFAULT_SERVICE_PATH

The default encoded service path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_BATCH_PATH

public static final String DEFAULT_BATCH_PATH

The default encoded batch path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.23

See Also:

Constant Field Values

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

The default encoded base URL of the service. This is determined when the library is generated and normally should not be changed.

See Also:

Constant Field Values

Constructor Detail

Webmasters

public Webmasters(HttpTransport transport,
                  JsonFactory jsonFactory,
                  HttpRequestInitializer httpRequestInitializer)

Constructor.

Use Webmasters.Builder if you need to specify any of the optional parameters.

Parameters:

transport - HTTP transport, which should normally be:

• Google App Engine: com.google.api.client.extensions.appengine.http.UrlFetchTransport
• Android: newCompatibleTransport from com.google.api.client.extensions.android.http.AndroidHttp
• Java: GoogleNetHttpTransport

jsonFactory - JSON factory, which may be:

• Jackson: com.google.api.client.json.jackson2.JacksonFactory
• Google GSON: com.google.api.client.json.gson.GsonFactory
• Android Honeycomb or higher: com.google.api.client.extensions.android.json.AndroidJsonFactory

httpRequestInitializer - HTTP request initializer or null for none

Since:

1.7

Method Detail

initialize

protected void initialize(AbstractGoogleClientRequest<?> httpClientRequest)
                   throws IOException

Overrides:

initialize in class AbstractGoogleClient

Throws:

IOException

searchanalytics

public Webmasters.Searchanalytics searchanalytics()

An accessor for creating requests from the Searchanalytics collection.

The typical use is:

    Webmasters webmasters = new Webmasters(...);
    Webmasters.Searchanalytics.List request = webmasters.searchanalytics().list(parameters ...)
 

Returns:

the resource collection

sitemaps

public Webmasters.Sitemaps sitemaps()

An accessor for creating requests from the Sitemaps collection.

The typical use is:

    Webmasters webmasters = new Webmasters(...);
    Webmasters.Sitemaps.List request = webmasters.sitemaps().list(parameters ...)
 

Returns:

the resource collection

sites

public Webmasters.Sites sites()

An accessor for creating requests from the Sites collection.

The typical use is:

    Webmasters webmasters = new Webmasters(...);
    Webmasters.Sites.List request = webmasters.sites().list(parameters ...)
 

Returns:

the resource collection