Interface GoogleAdsOptions

All Superinterfaces:
HasDisplayData, PipelineOptions

public interface GoogleAdsOptions extends PipelineOptions
Options used to configure Google Ads API specific options.
  • Method Details

    • getGoogleAdsEndpoint

      @String("googleads.googleapis.com:443") String getGoogleAdsEndpoint()
      Host endpoint to use for connections to the Google Ads API.
    • setGoogleAdsEndpoint

      void setGoogleAdsEndpoint(String endpoint)
    • getGoogleAdsClientId

      String getGoogleAdsClientId()
      OAuth 2.0 Client ID identifying the application.
    • setGoogleAdsClientId

      void setGoogleAdsClientId(String clientId)
    • getGoogleAdsClientSecret

      String getGoogleAdsClientSecret()
      OAuth 2.0 Client Secret for the specified Client ID.
    • setGoogleAdsClientSecret

      void setGoogleAdsClientSecret(String clientSecret)
    • getGoogleAdsRefreshToken

      String getGoogleAdsRefreshToken()
      OAuth 2.0 Refresh Token for the user connecting to the Google Ads API.
    • setGoogleAdsRefreshToken

      void setGoogleAdsRefreshToken(String refreshToken)
    • getGoogleAdsDeveloperToken

      @Nullable String getGoogleAdsDeveloperToken()
      Google Ads developer token for the user connecting to the Google Ads API.
    • setGoogleAdsDeveloperToken

      void setGoogleAdsDeveloperToken(String developerToken)
    • 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

      void setGoogleAdsCredentialFactoryClass(Class<? extends CredentialFactory> credentialFactoryClass)
    • 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)