GoogleAdWordsLinkedService Class
Google AdWords service linked service.
All required parameters must be populated in order to send to server.
Constructor
GoogleAdWordsLinkedService(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_properties: MutableMapping[str, Any] | None = None, client_customer_id: MutableMapping[str, Any] | None = None, developer_token: _models.SecretBase | None = None, authentication_type: str | _models.GoogleAdWordsAuthenticationType | None = None, refresh_token: _models.SecretBase | None = None, client_id: MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase | None = None, email: MutableMapping[str, Any] | None = None, key_file_path: MutableMapping[str, Any] | None = None, trusted_cert_path: MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str, Any] | None = None, private_key: _models.SecretBase | None = None, login_customer_id: MutableMapping[str, Any] | None = None, google_ads_api_version: MutableMapping[str, Any] | None = None, support_legacy_data_types: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
version
|
Version of the linked service. Default value: None
|
|
connect_via
|
The integration runtime reference. Default value: None
|
|
description
|
Linked service description. Default value: None
|
|
parameters
|
Parameters for linked service. Default value: None
|
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. Default value: None
|
|
connection_properties
|
<xref:JSON>
(Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. Default value: None
|
|
client_customer_id
|
<xref:JSON>
The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string). Default value: None
|
|
developer_token
|
The developer token associated with the manager account that you use to grant access to the AdWords API. Default value: None
|
|
authentication_type
|
The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Known values are: "ServiceAuthentication" and "UserAuthentication". Default value: None
|
|
refresh_token
|
The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. Default value: None
|
|
client_id
|
<xref:JSON>
The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). Default value: None
|
|
client_secret
|
The client secret of the google application used to acquire the refresh token. Default value: None
|
|
email
|
<xref:JSON>
The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string). Default value: None
|
|
key_file_path
|
<xref:JSON>
(Deprecated) 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. Type: string (or Expression with resultType string). Default value: None
|
|
trusted_cert_path
|
<xref:JSON>
(Deprecated) 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. Type: string (or Expression with resultType string). Default value: None
|
|
use_system_trust_store
|
<xref:JSON>
(Deprecated) Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
private_key
|
The private key that is used to authenticate the service account email address and can only be used on self-hosted IR. Default value: None
|
|
login_customer_id
|
<xref:JSON>
The customer ID of the Google Ads Manager account through which you want to fetch report data of specific Customer. Type: string (or Expression with resultType string). Default value: None
|
|
google_ads_api_version
|
<xref:JSON>
The Google Ads API major version such as v14. The supported major versions could be found on https://developers.google.com/google-ads/api/docs/release-notes. Type: string (or Expression with resultType string). Default value: None
|
|
support_legacy_data_types
|
<xref:JSON>
Specifies whether to use the legacy data type mappings, which maps float, int32 and int64 from Google to string. Do not set this to true unless you want to keep backward compatibility with legacy driver's data type mappings. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of linked service. Required. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
Parameters for linked service. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
|
connection_properties
|
<xref:JSON>
(Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. |
|
client_customer_id
|
<xref:JSON>
The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string). |
|
developer_token
|
The developer token associated with the manager account that you use to grant access to the AdWords API. |
|
authentication_type
|
The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Known values are: "ServiceAuthentication" and "UserAuthentication". |
|
refresh_token
|
The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. |
|
client_id
|
<xref:JSON>
The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). |
|
client_secret
|
The client secret of the google application used to acquire the refresh token. |
|
email
|
<xref:JSON>
The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string). |
|
key_file_path
|
<xref:JSON>
(Deprecated) 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. Type: string (or Expression with resultType string). |
|
trusted_cert_path
|
<xref:JSON>
(Deprecated) 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. Type: string (or Expression with resultType string). |
|
use_system_trust_store
|
<xref:JSON>
(Deprecated) Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Type: boolean (or Expression with resultType boolean). |
|
private_key
|
The private key that is used to authenticate the service account email address and can only be used on self-hosted IR. |
|
login_customer_id
|
<xref:JSON>
The customer ID of the Google Ads Manager account through which you want to fetch report data of specific Customer. Type: string (or Expression with resultType string). |
|
google_ads_api_version
|
<xref:JSON>
The Google Ads API major version such as v14. The supported major versions could be found on https://developers.google.com/google-ads/api/docs/release-notes. Type: string (or Expression with resultType string). |
|
support_legacy_data_types
|
<xref:JSON>
Specifies whether to use the legacy data type mappings, which maps float, int32 and int64 from Google to string. Do not set this to true unless you want to keep backward compatibility with legacy driver's data type mappings. Type: boolean (or Expression with resultType boolean). |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
