com.google.api.services.customsearch.v1

Class Customsearch

java.lang.Object

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

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

com.google.api.services.customsearch.v1.Customsearch

public class Customsearch
extends AbstractGoogleJsonClient

Service definition for Customsearch (v1).

Searches over a website or collection of websites

For more information about this service, see the API Documentation

This service uses CustomsearchRequestInitializer to initialize global parameters via its Customsearch.Builder.

Since:

1.3

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Customsearch.Builder Builder for Customsearch.
class	Customsearch.Cse The "cse" collection of methods.
class	Customsearch.Siterestrict The "siterestrict" 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_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
Customsearch(HttpTransport transport, JsonFactory jsonFactory, HttpRequestInitializer httpRequestInitializer) Constructor.

Method Summary

Modifier and Type	Method and Description
Customsearch.Cse	cse() An accessor for creating requests from the Cse collection.
protected void	initialize(AbstractGoogleClientRequest<?> httpClientRequest)
Customsearch.Siterestrict	siterestrict() An accessor for creating requests from the Siterestrict 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_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

Customsearch

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

Constructor.

Use Customsearch.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

cse

public Customsearch.Cse cse()

An accessor for creating requests from the Cse collection.

The typical use is:

    Customsearch customsearch = new Customsearch(...);
    Customsearch.Cse.List request = customsearch.cse().list(parameters ...)
 

Returns:

the resource collection

siterestrict

public Customsearch.Siterestrict siterestrict()

An accessor for creating requests from the Siterestrict collection.

The typical use is:

    Customsearch customsearch = new Customsearch(...);
    Customsearch.Siterestrict.List request = customsearch.siterestrict().list(parameters ...)
 

Returns:

the resource collection