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

Class AdWordsSession.Builder

java.lang.Object

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

All Implemented Interfaces:

Builder<AdWordsSession>

Enclosing class:

AdWordsSession

public static class AdWordsSession.Builder
extends Object
implements Builder<AdWordsSession>

Builder for AdWordsSession.

Implementation is not thread-safe.

Field Summary

Fields inherited from interface com.google.api.ads.common.lib.utils.Builder

DEFAULT_CONFIGURATION_FILENAME

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs an empty builder.

Method Summary

Modifier and Type	Method and Description
AdWordsSession	build() Builds the AdWordsSession.
AdWordsSession.ImmutableAdWordsSession	buildImmutable() Builds a thread-safe AdWordsSession.ImmutableAdWordsSession.
AdWordsSession.Builder	enablePartialFailure() Enables partial failure.
AdWordsSession.Builder	enableValidateOnly() Enables validate only.
AdWordsSession.Builder	from(org.apache.commons.configuration.Configuration config) Reads properties from the provided Configuration object. Known properties: api.adwords.clientCustomerId api.adwords.userAgent api.adwords.developerToken api.adwords.isPartialFailure api.adwords.endpoint api.adwords.reporting.skipHeader api.adwords.reporting.skipColumnHeader api.adwords.reporting.skipSummary
AdWordsSession.Builder	fromFile() Loads credentials from the "ads.properties" file in one of the following locations according to the following order: in the current directory, in the user home directory, in the classpath
AdWordsSession.Builder	fromFile(File path) Populates this builder from a properties file from a specified path.
AdWordsSession.Builder	fromFile(String path) Populates this builder from a properties file from a specified path.
AdWordsSession.Builder	fromFile(URL path) Populates this builder from a properties file from a specified path.
AdWordsSession.Builder	withClientCustomerId(String clientCustomerId) Includes a clientCustomerId.
AdWordsSession.Builder	withDeveloperToken(String developerToken) Includes a developer token.
AdWordsSession.Builder	withEndpoint(String endpoint) Override the endpoint server.
AdWordsSession.Builder	withOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential) Includes OAuth2 credential to be used for OAuth2 authentication.
AdWordsSession.Builder	withReportingConfiguration(ReportingConfiguration reportingConfiguration)
AdWordsSession.Builder	withUserAgent(String userAgent) Includes user agent.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs an empty builder. To construct a builder initialized to the settings of an existing AdWordsSession, use AdWordsSession.newBuilder() instead.

Method Detail

fromFile

public AdWordsSession.Builder fromFile()
                                throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Loads credentials from the "ads.properties" file in one of the following locations according to the following order: in the current directory, in the user home directory, in the classpath

Specified by:

fromFile in interface Builder<AdWordsSession>

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

fromFile

public AdWordsSession.Builder fromFile(String path)
                                throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Populates this builder from a properties file from a specified path. If not absolute, will look in user home directory, the current classpath and the system classpath.

Specified by:

fromFile in interface Builder<AdWordsSession>

Parameters:

path - the path to try first as a resource, then as a file

Returns:

Builder populated with properties.

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

fromFile

public AdWordsSession.Builder fromFile(File path)
                                throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Populates this builder from a properties file from a specified path.

Specified by:

fromFile in interface Builder<AdWordsSession>

Parameters:

path - the path to load properties from

Returns:

Builder populated with properties.

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

fromFile

public AdWordsSession.Builder fromFile(URL path)
                                throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Populates this builder from a properties file from a specified path. If not absolute, will look in user home directory, the current classpath and the system classpath.

Specified by:

fromFile in interface Builder<AdWordsSession>

Parameters:

path - the path to try first as a resource, then as a file

Returns:

Builder populated with properties.

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

from

@CanIgnoreReturnValue
public AdWordsSession.Builder from(org.apache.commons.configuration.Configuration config)

Reads properties from the provided Configuration object.

Known properties:

• api.adwords.clientCustomerId
• api.adwords.userAgent
• api.adwords.developerToken
• api.adwords.isPartialFailure
• api.adwords.endpoint
• api.adwords.reporting.skipHeader
• api.adwords.reporting.skipColumnHeader
• api.adwords.reporting.skipSummary

Specified by:

from in interface Builder<AdWordsSession>

Parameters:

config -

Returns:

Builder populated from the Configuration

withOAuth2Credential

@CanIgnoreReturnValue
public AdWordsSession.Builder withOAuth2Credential(com.google.api.client.auth.oauth2.Credential oAuth2Credential)

Includes OAuth2 credential to be used for OAuth2 authentication.

withReportingConfiguration

@CanIgnoreReturnValue
public AdWordsSession.Builder withReportingConfiguration(ReportingConfiguration reportingConfiguration)

withDeveloperToken

@CanIgnoreReturnValue
public AdWordsSession.Builder withDeveloperToken(String developerToken)

Includes a developer token. Required.

withUserAgent

@CanIgnoreReturnValue
public AdWordsSession.Builder withUserAgent(String userAgent)

Includes user agent.

withEndpoint

@CanIgnoreReturnValue
public AdWordsSession.Builder withEndpoint(String endpoint)

Override the endpoint server. Optional and defaults to https://adwords.google.com.

withClientCustomerId

@CanIgnoreReturnValue
public AdWordsSession.Builder withClientCustomerId(String clientCustomerId)

Includes a clientCustomerId.

enablePartialFailure

@CanIgnoreReturnValue
public AdWordsSession.Builder enablePartialFailure()

Enables partial failure. Default is disabled.

enableValidateOnly

@CanIgnoreReturnValue
public AdWordsSession.Builder enableValidateOnly()

Enables validate only. Default is disabled.

build

public AdWordsSession build()
                     throws ValidationException

Builds the AdWordsSession.

Specified by:

build in interface Builder<AdWordsSession>

Returns:

the built AdWordsSession

Throws:

ValidationException - if the attributes of this builder fail validation

buildImmutable

public AdWordsSession.ImmutableAdWordsSession buildImmutable()
                                                      throws ValidationException

Builds a thread-safe AdWordsSession.ImmutableAdWordsSession.

Returns:

the built ImmutableAdWordsSession

Throws:

ValidationException - if the attributes of this builder fail validation