GoogleAdWordsLinkedService Class

Google AdWords service linked service.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

GoogleAdWordsLinkedService

Constructor

GoogleAdWordsLinkedService(*, client_customer_id: object, developer_token: SecretBase, authentication_type: str | GoogleAdWordsAuthenticationType, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None = None, refresh_token: SecretBase | None = None, client_id: object | None = None, client_secret: SecretBase | None = None, email: object | None = None, key_file_path: object | None = None, trusted_cert_path: object | None = None, use_system_trust_store: object | None = None, encrypted_credential: object | None = None, **kwargs)

Parameters

Name	Description
additional_properties Required	dict[str, object] Unmatched properties from the message are deserialized to this collection.
type Required	str Required. Type of linked service.Constant filled by server.
connect_via Required	IntegrationRuntimeReference The integration runtime reference.
description Required	str Linked service description.
parameters Required	dict[str, ParameterSpecification] Parameters for linked service.
annotations Required	list[object] List of tags that can be used for describing the linked service.
client_customer_id Required	object Required. The Client customer ID of the AdWords account that you want to fetch report data for.
developer_token Required	SecretBase Required. The developer token associated with the manager account that you use to grant access to the AdWords API.
authentication_type Required	str or GoogleAdWordsAuthenticationType Required. The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: "ServiceAuthentication", "UserAuthentication".
refresh_token Required	SecretBase The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
client_id Required	object The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
client_secret Required	SecretBase The client secret of the google application used to acquire the refresh token.
email Required	object The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
key_file_path Required	object 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.
trusted_cert_path Required	object 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.
use_system_trust_store Required	object Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
encrypted_credential Required	object The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword-Only Parameters

Name	Description
client_customer_id Required
developer_token Required
authentication_type Required
additional_properties Required
connect_via Required
description Required
parameters Required
annotations Required
refresh_token Required
client_id Required
client_secret Required
email Required
key_file_path Required
trusted_cert_path Required
use_system_trust_store Required
encrypted_credential Required

Methods

as_dict	Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.
validate	Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. default value: None
key_extractors	default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error