com.google.gdata.client.spreadsheet

Class SpreadsheetService

java.lang.Object

com.google.gdata.client.Service

com.google.gdata.client.GoogleService

com.google.gdata.client.spreadsheet.SpreadsheetService

All Implemented Interfaces:

AuthTokenFactory.TokenListener

public class SpreadsheetService
extends GoogleService

Extends the basic GoogleService abstraction to define a service that is preconfigured for access to the Google Spreadsheets data API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpreadsheetService.Versions GData versions supported by Google Spreadsheets Service.

Nested classes/interfaces inherited from class com.google.gdata.client.GoogleService

GoogleService.AccountDeletedException, GoogleService.AccountDisabledException, GoogleService.CaptchaRequiredException, GoogleService.InvalidCredentialsException, GoogleService.NotVerifiedException, GoogleService.ServiceUnavailableException, GoogleService.SessionExpiredException, GoogleService.TermsNotAgreedException

Nested classes/interfaces inherited from class com.google.gdata.client.Service

Service.ClientInputProperties, Service.ClientOutputProperties, Service.ClientStreamProperties, Service.GDataRequest, Service.GDataRequestFactory

Field Summary

Fields

Modifier and Type	Field and Description
static Version	DEFAULT_VERSION Default GData version used by the Google Spreadsheets service.
static String	SPREADSHEET_SERVICE The abbreviated name of Google Spreadsheets recognized by Google.
static String	SPREADSHEET_SERVICE_VERSION The version ID of the service.

Fields inherited from class com.google.gdata.client.Service

connectTimeout, extProfile, metadataRegistry, requestFactory

Constructor Summary

Constructors

Constructor and Description
SpreadsheetService(String applicationName) Constructs an instance connecting to the Google Spreadsheets service for an application with the name applicationName.
SpreadsheetService(String applicationName, Service.GDataRequestFactory requestFactory, AuthTokenFactory authTokenFactory) Constructs an instance connecting to the Google Spreadsheets service for an application with the name applicationName and the given GDataRequestFactory and AuthTokenFactory.
SpreadsheetService(String applicationName, String protocol, String domainName) Constructs an instance connecting to the Google Spreadsheets service with name serviceName for an application with the name applicationName.

Method Summary

Methods

Modifier and Type	Method and Description
String	getServiceVersion() Returns information about the service version.
static Version	getVersion() Returns the current GData version used by the Google Spreadsheets service.

Methods inherited from class com.google.gdata.client.GoogleService

addCookie, batch, createRequest, createRequest, delete, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getEntry, getFeed, getFeed, getFeed, getFeed, handleRedirectException, handlesCookies, handleSessionExpiredException, insert, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setOAuth2Credentials, setOAuthCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserToken, tokenChanged, update

Methods inherited from class com.google.gdata.client.Service

classOf, createBatchRequest, createDeleteRequest, createEntryRequest, createFeedRequest, createFeedRequest, createInsertRequest, createLinkQueryRequest, createPatchRequest, createUpdateRequest, delete, delete, endVersionScope, getAltRegistry, getContentType, getDefaultAltRegistry, getEntry, getExtensionProfile, getFeed, getFeed, getMetadataRegistry, getProtocolVersion, getRequestFactory, getSchema, getStreamFromLink, getStrictValidation, initServiceVersion, introspect, parseResponseData, parseResponseData, patch, patch, query, query, query, setAcceptLanguage, setAltRegistry, setConnectTimeout, setContentType, setExtensionProfile, setHeader, setOAuthProxyHeaders, setPrivateHeader, setProtocolVersion, setReadTimeout, setRequestFactory, setStrictValidation, setTimeouts, startVersionScope, update, useSsl, writeRequestData, writeRequestData

Methods inherited from class java.lang.Object

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

Field Detail

SPREADSHEET_SERVICE

public static final String SPREADSHEET_SERVICE

The abbreviated name of Google Spreadsheets recognized by Google. The service name is used when requesting an authentication token.

See Also:

Constant Field Values

SPREADSHEET_SERVICE_VERSION

public static final String SPREADSHEET_SERVICE_VERSION

The version ID of the service.

DEFAULT_VERSION

public static final Version DEFAULT_VERSION

Default GData version used by the Google Spreadsheets service.

Constructor Detail

SpreadsheetService

public SpreadsheetService(String applicationName)

Constructs an instance connecting to the Google Spreadsheets service for an application with the name applicationName.

Parameters:

applicationName - the name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.

SpreadsheetService

public SpreadsheetService(String applicationName,
                  Service.GDataRequestFactory requestFactory,
                  AuthTokenFactory authTokenFactory)

Constructs an instance connecting to the Google Spreadsheets service for an application with the name applicationName and the given GDataRequestFactory and AuthTokenFactory. Use this constructor to override the default factories.

Parameters:

applicationName - the name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.

requestFactory - the request factory that generates gdata request objects

authTokenFactory - the factory that creates auth tokens

SpreadsheetService

public SpreadsheetService(String applicationName,
                  String protocol,
                  String domainName)

Constructs an instance connecting to the Google Spreadsheets service with name serviceName for an application with the name applicationName. The service will authenticate at the provided domainName.

Parameters:

applicationName - the name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.

protocol - name of protocol to use for authentication ("http"/"https")

domainName - the name of the domain hosting the login handler

Method Detail

getServiceVersion

public String getServiceVersion()

Description copied from class: Service

Returns information about the service version.

Overrides:

getServiceVersion in class Service

getVersion

public static Version getVersion()

Returns the current GData version used by the Google Spreadsheets service.