Package org.apache.beam.sdk.io.googleads
Interface GoogleAdsOptions
- All Superinterfaces:
HasDisplayData
,PipelineOptions
Options used to configure Google Ads API specific options.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
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 TypeMethodDescriptionOAuth 2.0 Client ID identifying the application.OAuth 2.0 Client Secret for the specified Client ID.@Nullable com.google.auth.Credentials
The credential instance that should be used to authenticate against the Google Ads API.Class
<? extends CredentialFactory> The class of the credential factory to create credentials if none have been explicitly set.Google Ads developer token for the user connecting to the Google Ads API.Host endpoint to use for connections to the Google Ads API.OAuth 2.0 Refresh Token for the user connecting to the Google Ads API.void
setGoogleAdsClientId
(String clientId) void
setGoogleAdsClientSecret
(String clientSecret) void
setGoogleAdsCredential
(com.google.auth.Credentials credential) void
setGoogleAdsCredentialFactoryClass
(Class<? extends CredentialFactory> credentialFactoryClass) void
setGoogleAdsDeveloperToken
(String developerToken) void
setGoogleAdsEndpoint
(String endpoint) void
setGoogleAdsRefreshToken
(String refreshToken) Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData
populateDisplayData
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
-
Method Details
-
getGoogleAdsEndpoint
Host endpoint to use for connections to the Google Ads API. -
setGoogleAdsEndpoint
-
getGoogleAdsClientId
String getGoogleAdsClientId()OAuth 2.0 Client ID identifying the application. -
setGoogleAdsClientId
-
getGoogleAdsClientSecret
String getGoogleAdsClientSecret()OAuth 2.0 Client Secret for the specified Client ID. -
setGoogleAdsClientSecret
-
getGoogleAdsRefreshToken
String getGoogleAdsRefreshToken()OAuth 2.0 Refresh Token for the user connecting to the Google Ads API. -
setGoogleAdsRefreshToken
-
getGoogleAdsDeveloperToken
Google Ads developer token for the user connecting to the Google Ads API. -
setGoogleAdsDeveloperToken
-
getGoogleAdsCredentialFactoryClass
@Class(GoogleAdsUserCredentialFactory.class) Class<? extends CredentialFactory> getGoogleAdsCredentialFactoryClass()The class of the credential factory to create credentials if none have been explicitly set.- See Also:
-
setGoogleAdsCredentialFactoryClass
-
getGoogleAdsCredential
@InstanceFactory(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:
-
setGoogleAdsCredential
void setGoogleAdsCredential(com.google.auth.Credentials credential)
-