org.apache.beam.sdk.io.googleads

Interface GoogleAdsOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

public interface GoogleAdsOptions
extends PipelineOptions

Options used to configure Google Ads API specific options.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GoogleAdsOptions.GoogleAdsCredentialsFactory Attempts to load the Google Ads credentials.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGoogleAdsClientId() OAuth 2.0 Client ID identifying the application.
java.lang.String	getGoogleAdsClientSecret() OAuth 2.0 Client Secret for the specified Client ID.
@Nullable com.google.auth.Credentials	getGoogleAdsCredential() The credential instance that should be used to authenticate against the Google Ads API.
java.lang.Class<? extends CredentialFactory>	getGoogleAdsCredentialFactoryClass() The class of the credential factory to create credentials if none have been explicitly set.
@Nullable java.lang.String	getGoogleAdsDeveloperToken() Google Ads developer token for the user connecting to the Google Ads API.
java.lang.String	getGoogleAdsEndpoint() Host endpoint to use for connections to the Google Ads API.
java.lang.String	getGoogleAdsRefreshToken() OAuth 2.0 Refresh Token for the user connecting to the Google Ads API.
void	setGoogleAdsClientId(java.lang.String clientId)
void	setGoogleAdsClientSecret(java.lang.String clientSecret)
void	setGoogleAdsCredential(com.google.auth.Credentials credential)
void	setGoogleAdsCredentialFactoryClass(java.lang.Class<? extends CredentialFactory> credentialFactoryClass)
void	setGoogleAdsDeveloperToken(java.lang.String developerToken)
void	setGoogleAdsEndpoint(java.lang.String endpoint)
void	setGoogleAdsRefreshToken(java.lang.String refreshToken)

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Method Detail

getGoogleAdsEndpoint

@Default.String(value="googleads.googleapis.com:443")
java.lang.String getGoogleAdsEndpoint()

Host endpoint to use for connections to the Google Ads API.

setGoogleAdsEndpoint

void setGoogleAdsEndpoint(java.lang.String endpoint)

getGoogleAdsClientId

java.lang.String getGoogleAdsClientId()

OAuth 2.0 Client ID identifying the application.

See Also:

https://developers.google.com/google-ads/api/docs/oauth/overview, https://developers.google.com/identity/protocols/oauth2

setGoogleAdsClientId

void setGoogleAdsClientId(java.lang.String clientId)

getGoogleAdsClientSecret

java.lang.String getGoogleAdsClientSecret()

OAuth 2.0 Client Secret for the specified Client ID.

See Also:

https://developers.google.com/google-ads/api/docs/oauth/overview, https://developers.google.com/identity/protocols/oauth2

setGoogleAdsClientSecret

void setGoogleAdsClientSecret(java.lang.String clientSecret)

getGoogleAdsRefreshToken

java.lang.String getGoogleAdsRefreshToken()

OAuth 2.0 Refresh Token for the user connecting to the Google Ads API.

See Also:

https://developers.google.com/google-ads/api/docs/oauth/overview, https://developers.google.com/identity/protocols/oauth2

setGoogleAdsRefreshToken

void setGoogleAdsRefreshToken(java.lang.String refreshToken)

getGoogleAdsDeveloperToken

@Nullable java.lang.String getGoogleAdsDeveloperToken()

Google Ads developer token for the user connecting to the Google Ads API.

setGoogleAdsDeveloperToken

void setGoogleAdsDeveloperToken(java.lang.String developerToken)

getGoogleAdsCredentialFactoryClass

@Default.Class(value=GoogleAdsUserCredentialFactory.class)
java.lang.Class<? extends CredentialFactory> getGoogleAdsCredentialFactoryClass()

The class of the credential factory to create credentials if none have been explicitly set.

See Also:

getGoogleAdsCredential()

setGoogleAdsCredentialFactoryClass

void setGoogleAdsCredentialFactoryClass(java.lang.Class<? extends CredentialFactory> credentialFactoryClass)

getGoogleAdsCredential

@Default.InstanceFactory(value=GoogleAdsOptions.GoogleAdsCredentialsFactory.class)
@Nullable com.google.auth.Credentials getGoogleAdsCredential()

The credential instance that should be used to authenticate against the Google Ads API. Defaults to a credential instance constructed by the credential factory.

See Also:

getGoogleAdsCredential(), https://github.com/googleapis/google-auth-library-java

setGoogleAdsCredential

void setGoogleAdsCredential(com.google.auth.Credentials credential)