Class GoogleAdWordsLinkedService


  • public final class GoogleAdWordsLinkedService
    extends LinkedService
    Google AdWords service linked service.
    • Constructor Detail

      • GoogleAdWordsLinkedService

        public GoogleAdWordsLinkedService()
    • Method Detail

      • withDescription

        public GoogleAdWordsLinkedService withDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        withDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.
      • withAnnotations

        public GoogleAdWordsLinkedService withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        withAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.
      • connectionProperties

        public Object connectionProperties()
        Get the connectionProperties property: Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.
        Returns:
        the connectionProperties value.
      • withConnectionProperties

        public GoogleAdWordsLinkedService withConnectionProperties​(Object connectionProperties)
        Set the connectionProperties property: Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.
        Parameters:
        connectionProperties - the connectionProperties value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • clientCustomerId

        public Object clientCustomerId()
        Get the clientCustomerId property: The Client customer ID of the AdWords account that you want to fetch report data for.
        Returns:
        the clientCustomerId value.
      • withClientCustomerId

        public GoogleAdWordsLinkedService withClientCustomerId​(Object clientCustomerId)
        Set the clientCustomerId property: The Client customer ID of the AdWords account that you want to fetch report data for.
        Parameters:
        clientCustomerId - the clientCustomerId value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • developerToken

        public SecretBase developerToken()
        Get the developerToken property: The developer token associated with the manager account that you use to grant access to the AdWords API.
        Returns:
        the developerToken value.
      • withDeveloperToken

        public GoogleAdWordsLinkedService withDeveloperToken​(SecretBase developerToken)
        Set the developerToken property: The developer token associated with the manager account that you use to grant access to the AdWords API.
        Parameters:
        developerToken - the developerToken value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • authenticationType

        public GoogleAdWordsAuthenticationType authenticationType()
        Get the authenticationType property: The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
        Returns:
        the authenticationType value.
      • withAuthenticationType

        public GoogleAdWordsLinkedService withAuthenticationType​(GoogleAdWordsAuthenticationType authenticationType)
        Set the authenticationType property: The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • refreshToken

        public SecretBase refreshToken()
        Get the refreshToken property: The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
        Returns:
        the refreshToken value.
      • withRefreshToken

        public GoogleAdWordsLinkedService withRefreshToken​(SecretBase refreshToken)
        Set the refreshToken property: The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
        Parameters:
        refreshToken - the refreshToken value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • clientId

        public Object clientId()
        Get the clientId property: The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
        Returns:
        the clientId value.
      • withClientId

        public GoogleAdWordsLinkedService withClientId​(Object clientId)
        Set the clientId property: The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
        Parameters:
        clientId - the clientId value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • clientSecret

        public SecretBase clientSecret()
        Get the clientSecret property: The client secret of the google application used to acquire the refresh token.
        Returns:
        the clientSecret value.
      • withClientSecret

        public GoogleAdWordsLinkedService withClientSecret​(SecretBase clientSecret)
        Set the clientSecret property: The client secret of the google application used to acquire the refresh token.
        Parameters:
        clientSecret - the clientSecret value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • email

        public Object email()
        Get the email property: The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
        Returns:
        the email value.
      • withEmail

        public GoogleAdWordsLinkedService withEmail​(Object email)
        Set the email property: The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
        Parameters:
        email - the email value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • keyFilePath

        public Object keyFilePath()
        Get the keyFilePath property: The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.
        Returns:
        the keyFilePath value.
      • withKeyFilePath

        public GoogleAdWordsLinkedService withKeyFilePath​(Object keyFilePath)
        Set the keyFilePath property: The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.
        Parameters:
        keyFilePath - the keyFilePath value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • trustedCertPath

        public Object trustedCertPath()
        Get the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
        Returns:
        the trustedCertPath value.
      • withTrustedCertPath

        public GoogleAdWordsLinkedService withTrustedCertPath​(Object trustedCertPath)
        Set the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
        Parameters:
        trustedCertPath - the trustedCertPath value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • useSystemTrustStore

        public Object useSystemTrustStore()
        Get the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
        Returns:
        the useSystemTrustStore value.
      • withUseSystemTrustStore

        public GoogleAdWordsLinkedService withUseSystemTrustStore​(Object useSystemTrustStore)
        Set the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
        Parameters:
        useSystemTrustStore - the useSystemTrustStore value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.
      • encryptedCredential

        public Object encryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.
      • withEncryptedCredential

        public GoogleAdWordsLinkedService withEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.