com.google.api.ads.dfp.lib.client

Class DfpSession

java.lang.Object

com.google.api.ads.dfp.lib.client.DfpSession

All Implemented Interfaces:

ClientLoginCompatible, OAuth2Compatible, OAuthCompatible, AdsSession

public class DfpSession
extends Object
implements AdsSession, OAuthCompatible, OAuth2Compatible, ClientLoginCompatible

A DfpSession represents a single session of DFP use.

Implementation is not thread-safe.

Author:

Adam Rogal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DfpSession.Builder Builder for DfpSession.
static class	DfpSession.Environment Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENDPOINT

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationName() Gets the application name.
String	getClientLoginToken() Gets the client login token.
String	getEndpoint() Gets the endpoint.
String	getNetworkCode() Gets the network code.
com.google.api.client.auth.oauth2.Credential	getOAuth2Credential() Gets the OAuth2 credentials.
com.google.api.client.auth.oauth.OAuthParameters	getOAuthParameters() Gets the OAuth parameters.
boolean	isEnvironment(Endpoint environment) Deprecated.
void	setClientLoginToken(String clientLoginToken) Sets the client login token.
void	setNetworkCode(String networkCode) Sets the network code.
void	setOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential) Sets the OAuth2 credential.
void	setOAuthParameters(com.google.api.client.auth.oauth.OAuthParameters oAuthParameters) Deprecated. It is encouraged that you switch to OAuth2 at your earliest convenience. Beginning in 1.9.0, the GoogleOAuth authorization flow will no longer be supported, making it substantially more difficult to create OAuth1.0a tokens.

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

getApplicationName

public String getApplicationName()

Gets the application name.

getOAuthParameters

public com.google.api.client.auth.oauth.OAuthParameters getOAuthParameters()

Gets the OAuth parameters.

Specified by:

getOAuthParameters in interface OAuthCompatible

setOAuthParameters

public void setOAuthParameters(com.google.api.client.auth.oauth.OAuthParameters oAuthParameters)

Deprecated. It is encouraged that you switch to OAuth2 at your earliest convenience. Beginning in 1.9.0, the GoogleOAuth authorization flow will no longer be supported, making it substantially more difficult to create OAuth1.0a tokens.

Sets the OAuth parameters. Any other authentication credentials on the session will be removed.

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.

getClientLoginToken

public String getClientLoginToken()

Gets the client login token.

Specified by:

getClientLoginToken in interface ClientLoginCompatible

setClientLoginToken

public void setClientLoginToken(String clientLoginToken)

Sets the client login token. Any other authentication credentials on the session will be removed.

getEndpoint

public String getEndpoint()

Gets the endpoint.

Specified by:

getEndpoint in interface AdsSession

isEnvironment

@Deprecated
public boolean isEnvironment(Endpoint environment)

Deprecated.

Determines if the session is for the supplied DfpSession.Environment.

Specified by:

isEnvironment in interface AdsSession

Parameters:

environment - the environment to check

getNetworkCode

public String getNetworkCode()

Gets the network code.

setNetworkCode

public void setNetworkCode(String networkCode)

Sets the network code.