target.apidocs.com.google.api.services.customsearch.v1.CustomSearchAPI.html Maven / Gradle / Ivy
The newest version!
CustomSearchAPI (Custom Search API v1-rev20240821-2.0.0)
com.google.api.services.customsearch.v1
Class CustomSearchAPI
- java.lang.Object
-
- com.google.api.client.googleapis.services.AbstractGoogleClient
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient
-
- com.google.api.services.customsearch.v1.CustomSearchAPI
-
public class CustomSearchAPI
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient
Service definition for CustomSearchAPI (v1).
Searches over a website or collection of websites
For more information about this service, see the
API Documentation
This service uses CustomSearchAPIRequestInitializer to initialize global parameters via its
CustomSearchAPI.Builder.
- Since:
- 1.3
- Author:
- Google, Inc.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
static class CustomSearchAPI.Builder
Builder for CustomSearchAPI.
class CustomSearchAPI.Cse
The "cse" collection of methods.
-
Field Summary
Fields
Modifier and Type
Field and Description
static StringDEFAULT_BASE_URL
The default encoded base URL of the service.
static StringDEFAULT_BATCH_PATH
The default encoded batch path of the service.
static StringDEFAULT_MTLS_ROOT_URL
The default encoded mTLS root URL of the service.
static StringDEFAULT_ROOT_URL
The default encoded root URL of the service.
static StringDEFAULT_SERVICE_PATH
The default encoded service path of the service.
-
Constructor Summary
Constructors
Constructor and Description
CustomSearchAPI(com.google.api.client.http.HttpTransport transport,
com.google.api.client.json.JsonFactory jsonFactory,
com.google.api.client.http.HttpRequestInitializer httpRequestInitializer)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
CustomSearchAPI.Csecse()
An accessor for creating requests from the Cse collection.
protected voidinitialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest<?> httpClientRequest)
-
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, getUniverseDomain, validateUniverseDomain
-
-
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
-
CustomSearchAPI
public CustomSearchAPI(com.google.api.client.http.HttpTransport transport,
com.google.api.client.json.JsonFactory jsonFactory,
com.google.api.client.http.HttpRequestInitializer httpRequestInitializer)
Constructor.
Use CustomSearchAPI.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:
com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()
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(com.google.api.client.googleapis.services.AbstractGoogleClientRequest<?> httpClientRequest)
throws IOException
- Overrides:
initialize in class com.google.api.client.googleapis.services.AbstractGoogleClient- Throws:
IOException
-
cse
public CustomSearchAPI.Cse cse()
An accessor for creating requests from the Cse collection.
The typical use is:
CustomSearchAPI customsearch = new CustomSearchAPI(...);
CustomSearchAPI.Cse.List request = customsearch.cse().list(parameters ...)
- Returns:
- the resource collection
Copyright © 2011–2024 Google. All rights reserved.