OfflineCredentials.ForApiBuilder (Google Ads APIs Client Library for Java parent 3.12.0 API)

java.lang.Object
- com.google.api.ads.common.lib.auth.OfflineCredentials.ForApiBuilder

All Implemented Interfaces:

Builder<OfflineCredentials>

Enclosing class:

OfflineCredentials
```
public static class OfflineCredentials.ForApiBuilder
extends Object
implements Builder<OfflineCredentials>
```
Builder for OfflineCredentials.

Field Summary
- Fields inherited from interface com.google.api.ads.common.lib.utils.Builder
  DEFAULT_CONFIGURATION_FILENAME

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OfflineCredentials`	`build()` Constructs this object.
`OfflineCredentials.ForApiBuilder`	`from(org.apache.commons.configuration.Configuration config)` Reads properties from the provided `Configuration` object Understands the following properties suffixes: refreshToken clientId clientSecret jsonKeyFilePath For example, the AdWords OAuth2 refresh token can be read from: `api.adwords.refreshToken`
`OfflineCredentials.ForApiBuilder`	`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
`OfflineCredentials.ForApiBuilder`	`fromFile(File path)` Populates this builder from a properties file from a specified path.
`OfflineCredentials.ForApiBuilder`	`fromFile(String path)` Populates this builder from a properties file from a specified path.
`OfflineCredentials.ForApiBuilder`	`fromFile(URL path)` Populates this builder from a properties file from a specified path.
`OfflineCredentials.ForApiBuilder`	`withClientSecrets(String clientId, String clientSecret)` Sets the client ID & secret to create the OAuth2 Credential with.
`OfflineCredentials.ForApiBuilder`	`withHttpTransport(com.google.api.client.http.HttpTransport httpTransport)` Sets the `HttpTransport` to be used to make the request.
`OfflineCredentials.ForApiBuilder`	`withJsonKeyFilePath(String jsonKeyFilePath)` Sets the path to a JSON key file for authenticating with a service account.
`OfflineCredentials.ForApiBuilder`	`withRefreshToken(String refreshToken)` Sets the refresh token to create the OAuth2 Credential with.
`OfflineCredentials.ForApiBuilder`	`withScopes(List<String> scopes)` Optionally sets scopes for authenticating with a service account.
`OfflineCredentials.ForApiBuilder`	`withServiceAccountUser(String serviceAccountUser)` Sets the service account user to impersonate.
`OfflineCredentials.ForApiBuilder`	`withTokenUrlServer(String tokenServerUrl)` Sets the token server URL.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - fromFile
```
public OfflineCredentials.ForApiBuilder 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<OfflineCredentials>
    
    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 OfflineCredentials.ForApiBuilder 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<OfflineCredentials>
    
    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 OfflineCredentials.ForApiBuilder 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<OfflineCredentials>
    
    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 OfflineCredentials.ForApiBuilder 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<OfflineCredentials>
    
    Throws:
    
    com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.
  - from
```
public OfflineCredentials.ForApiBuilder from(org.apache.commons.configuration.Configuration config)
```
    Reads properties from the provided Configuration object
    
    Understands the following properties suffixes:
    - refreshToken
    - clientId
    - clientSecret
    - jsonKeyFilePath
    For example, the AdWords OAuth2 refresh token can be read from: api.adwords.refreshToken
    Specified by:
    
    from in interface Builder<OfflineCredentials>
    
    Parameters:
    
    config - the configuration
    
    Returns:
    
    Builder populated from the Configuration
  - withClientSecrets
```
public OfflineCredentials.ForApiBuilder withClientSecrets(String clientId,
                                                          String clientSecret)
```
    Sets the client ID & secret to create the OAuth2 Credential with. If you do not have a client ID or secret, please create one in the API console: https://console.developers.google.com/project
  - withRefreshToken
```
public OfflineCredentials.ForApiBuilder withRefreshToken(String refreshToken)
```
    Sets the refresh token to create the OAuth2 Credential with. If you need to create one, see the GetRefreshToken example.
  - withJsonKeyFilePath
```
public OfflineCredentials.ForApiBuilder withJsonKeyFilePath(String jsonKeyFilePath)
```
    Sets the path to a JSON key file for authenticating with a service account. If you do not have one, please create it in the API console: https://console.developers.google.com/apis/credentials
  - withServiceAccountUser
```
public OfflineCredentials.ForApiBuilder withServiceAccountUser(String serviceAccountUser)
```
    Sets the service account user to impersonate. This attribute is optional, and only applicable to the service account flow.
    See https://developers.google.com/adwords/api/docs/guides/authentication#granting_impersonation_abilities for details.
    
    Parameters:
    
    serviceAccountUser - the email address of the account to impersonate.
  - withScopes
```
public OfflineCredentials.ForApiBuilder withScopes(List<String> scopes)
```
    Optionally sets scopes for authenticating with a service account. By default, the scope will only be for the set OfflineCredentials.Api. If you are using a refresh token, the scope is set at the time the refresh token is generated, and this function is a no-op.
  - withHttpTransport
```
public OfflineCredentials.ForApiBuilder withHttpTransport(com.google.api.client.http.HttpTransport httpTransport)
```
    Sets the HttpTransport to be used to make the request. By default, NetHttpTransport will be used, but due to some environment restrictions, you may want to use a different transport, such as UrlFetchTransport for AppEngine.
  - withTokenUrlServer
```
public OfflineCredentials.ForApiBuilder withTokenUrlServer(String tokenServerUrl)
```
    Sets the token server URL. This is a no-op when using a service account key file. Set the token server URL in the key file instead. Not required and defaults to https://accounts.google.com/o/oauth2/token
  - build
```
public OfflineCredentials build()
                         throws ValidationException
```
    Description copied from interface: Builder
    
    Constructs this object.
    
    Specified by:
    
    build in interface Builder<OfflineCredentials>
    
    Throws:
    
    ValidationException - if the provided data is not valid.

Class OfflineCredentials.ForApiBuilder

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fromFile

fromFile

fromFile

fromFile

from

withClientSecrets

withRefreshToken

withJsonKeyFilePath

withServiceAccountUser

withScopes

withHttpTransport

withTokenUrlServer

build