com.google.api.ads.adwords.lib.client

Class AdWordsSession

java.lang.Object

com.google.api.ads.adwords.lib.client.AdWordsSession

All Implemented Interfaces:

OAuth2Compatible, AdsSession

Direct Known Subclasses:

AdWordsSession.ImmutableAdWordsSession

public class AdWordsSession
extends Object
implements AdsSession, OAuth2Compatible

A AdWordsSession represents a single session of AdWords use.

Implementation is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdWordsSession.Builder Builder for AdWordsSession.
static class	AdWordsSession.ImmutableAdWordsSession Immutable, thread-safe implementation of AdWordsSession.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENDPOINT

Method Summary

Modifier and Type	Method and Description
String	getClientCustomerId() Gets the client customer ID.
String	getDeveloperToken()
String	getEndpoint() Returns the server endpoint to make requests against.
com.google.api.client.auth.oauth2.Credential	getOAuth2Credential() Gets the OAuth2 credentials.
ReportingConfiguration	getReportingConfiguration() Gets the reporting configuration.
String	getUserAgent()
Boolean	isPartialFailure()
Boolean	isValidateOnly() Returns true if the session should only validate the request.
AdWordsSession.Builder	newBuilder() Returns a new AdWordsSession.Builder with all settings copied from this session.
void	setClientCustomerId(String clientCustomerId) Sets the client customer ID.
void	setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential) Sets the OAuth2 credential.
void	setPartialFailure(Boolean isPartialFailure) Sets whether this session should allow partial failure.
void	setReportingConfiguration(ReportingConfiguration reportingConfiguration) Sets the reporting configuration.
void	setValidateOnly(Boolean isValidateOnly) Sets whether this session should only validate the request.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENDPOINT

public static final String DEFAULT_ENDPOINT

See Also:

Constant Field Values

Method Detail

getClientCustomerId

public String getClientCustomerId()

Gets the client customer ID.

setClientCustomerId

public void setClientCustomerId(String clientCustomerId)

Sets the client customer ID.

isValidateOnly

@Nullable
public Boolean isValidateOnly()

Returns true if the session should only validate the request.

setValidateOnly

public void setValidateOnly(@Nullable
                            Boolean isValidateOnly)

Sets whether this session should only validate the request.

getUserAgent

public String getUserAgent()

Returns:

the userAgent

getDeveloperToken

public String getDeveloperToken()

Returns:

the developerToken

isPartialFailure

@Nullable
public Boolean isPartialFailure()

Returns:

the isPartialFailure

setPartialFailure

public void setPartialFailure(@Nullable
                              Boolean isPartialFailure)

Sets whether this session should allow partial failure.

getOAuth2Credential

public com.google.api.client.auth.oauth2.Credential getOAuth2Credential()

Gets the OAuth2 credentials.

Specified by:

getOAuth2Credential in interface OAuth2Compatible

setOAuth2Credential

public void setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)

Sets the OAuth2 credential. Any other authentication credentials on the session will be removed.

getReportingConfiguration

@Nullable
public ReportingConfiguration getReportingConfiguration()

Gets the reporting configuration.

setReportingConfiguration

public void setReportingConfiguration(@Nullable
                                      ReportingConfiguration reportingConfiguration)

Sets the reporting configuration.

getEndpoint

public String getEndpoint()

Description copied from interface: AdsSession

Returns the server endpoint to make requests against.

Specified by:

getEndpoint in interface AdsSession

Returns:

the endpoint

newBuilder

public AdWordsSession.Builder newBuilder()

Returns a new AdWordsSession.Builder with all settings copied from this session. This is not thread-safe unless this session is an AdWordsSession.ImmutableAdWordsSession.