#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""This module contains Google Analytics 360 operators."""
from __future__ import annotations
import csv
from tempfile import NamedTemporaryFile
from typing import TYPE_CHECKING, Any, Sequence
from deprecated import deprecated
from airflow.exceptions import AirflowProviderDeprecationWarning
from airflow.models import BaseOperator
from airflow.providers.google.cloud.hooks.gcs import GCSHook
from airflow.providers.google.marketing_platform.hooks.analytics import GoogleAnalyticsHook
if TYPE_CHECKING:
from airflow.utils.context import Context
@deprecated(
reason=(
"The `GoogleAnalyticsListAccountsOperator` class is deprecated, please use "
"`GoogleAnalyticsAdminListAccountsOperator` instead."
),
category=AirflowProviderDeprecationWarning,
)
[docs]class GoogleAnalyticsListAccountsOperator(BaseOperator):
"""
Lists all accounts to which the user has access.
.. seealso::
This operator is deprecated, please use
:class:`~airflow.providers.google.marketing_platform.operators.analytics_admin.GoogleAnalyticsAdminListAccountsOperator`:
.. seealso::
Check official API docs:
https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/accounts/list
and for python client
http://googleapis.github.io/google-api-python-client/docs/dyn/analytics_v3.management.accounts.html#list
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:GoogleAnalyticsListAccountsOperator`
:param api_version: The version of the api that will be requested for example 'v3'.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
of the last account in the list, which will be impersonated in the request.
If set as a string, the account must grant the originating account
the Service Account Token Creator IAM role.
If set as a sequence, the identities from the list must grant
Service Account Token Creator IAM role to the directly preceding identity, with first
account from the list granting this role to the originating account (templated).
"""
[docs] template_fields: Sequence[str] = (
"api_version",
"gcp_conn_id",
"impersonation_chain",
)
def __init__(
self,
*,
api_version: str = "v3",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(**kwargs)
self.api_version = api_version
self.gcp_conn_id = gcp_conn_id
self.impersonation_chain = impersonation_chain
[docs] def execute(self, context: Context) -> list[dict[str, Any]]:
hook = GoogleAnalyticsHook(
api_version=self.api_version,
gcp_conn_id=self.gcp_conn_id,
impersonation_chain=self.impersonation_chain,
)
result = hook.list_accounts()
return result
@deprecated(
reason=(
"The `GoogleAnalyticsGetAdsLinkOperator` class is deprecated, please use "
"`GoogleAnalyticsAdminGetGoogleAdsLinkOperator` instead."
),
category=AirflowProviderDeprecationWarning,
)
[docs]class GoogleAnalyticsGetAdsLinkOperator(BaseOperator):
"""
Returns a web property-Google Ads link to which the user has access.
.. seealso::
This operator is deprecated, please use
:class:`~airflow.providers.google.marketing_platform.operators.analytics_admin.GoogleAnalyticsAdminGetGoogleAdsLinkOperator`:
.. seealso::
Check official API docs:
https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/webPropertyAdWordsLinks/get
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:GoogleAnalyticsGetAdsLinkOperator`
:param account_id: ID of the account which the given web property belongs to.
:param web_property_ad_words_link_id: Web property-Google Ads link ID.
:param web_property_id: Web property ID to retrieve the Google Ads link for.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
of the last account in the list, which will be impersonated in the request.
If set as a string, the account must grant the originating account
the Service Account Token Creator IAM role.
If set as a sequence, the identities from the list must grant
Service Account Token Creator IAM role to the directly preceding identity, with first
account from the list granting this role to the originating account (templated).
"""
[docs] template_fields: Sequence[str] = (
"api_version",
"gcp_conn_id",
"account_id",
"web_property_ad_words_link_id",
"web_property_id",
"impersonation_chain",
)
def __init__(
self,
*,
account_id: str,
web_property_ad_words_link_id: str,
web_property_id: str,
api_version: str = "v3",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
):
super().__init__(**kwargs)
self.account_id = account_id
self.web_property_ad_words_link_id = web_property_ad_words_link_id
self.web_property_id = web_property_id
self.api_version = api_version
self.gcp_conn_id = gcp_conn_id
self.impersonation_chain = impersonation_chain
[docs] def execute(self, context: Context) -> dict[str, Any]:
hook = GoogleAnalyticsHook(
api_version=self.api_version,
gcp_conn_id=self.gcp_conn_id,
impersonation_chain=self.impersonation_chain,
)
result = hook.get_ad_words_link(
account_id=self.account_id,
web_property_id=self.web_property_id,
web_property_ad_words_link_id=self.web_property_ad_words_link_id,
)
return result
@deprecated(
reason=(
"The `GoogleAnalyticsRetrieveAdsLinksListOperator` class is deprecated, please use "
"`GoogleAnalyticsAdminListGoogleAdsLinksOperator` instead."
),
category=AirflowProviderDeprecationWarning,
)
[docs]class GoogleAnalyticsRetrieveAdsLinksListOperator(BaseOperator):
"""
Lists webProperty-Google Ads links for a given web property.
.. seealso::
This operator is deprecated, please use
:class:`~airflow.providers.google.marketing_platform.operators.analytics_admin.GoogleAnalyticsAdminListGoogleAdsLinksOperator`:
.. seealso::
Check official API docs:
https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/webPropertyAdWordsLinks/list#http-request
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:GoogleAnalyticsRetrieveAdsLinksListOperator`
:param account_id: ID of the account which the given web property belongs to.
:param web_property_id: Web property UA-string to retrieve the Google Ads links for.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
of the last account in the list, which will be impersonated in the request.
If set as a string, the account must grant the originating account
the Service Account Token Creator IAM role.
If set as a sequence, the identities from the list must grant
Service Account Token Creator IAM role to the directly preceding identity, with first
account from the list granting this role to the originating account (templated).
"""
[docs] template_fields: Sequence[str] = (
"api_version",
"gcp_conn_id",
"account_id",
"web_property_id",
"impersonation_chain",
)
def __init__(
self,
*,
account_id: str,
web_property_id: str,
api_version: str = "v3",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(**kwargs)
self.account_id = account_id
self.web_property_id = web_property_id
self.api_version = api_version
self.gcp_conn_id = gcp_conn_id
self.impersonation_chain = impersonation_chain
[docs] def execute(self, context: Context) -> list[dict[str, Any]]:
hook = GoogleAnalyticsHook(
api_version=self.api_version,
gcp_conn_id=self.gcp_conn_id,
impersonation_chain=self.impersonation_chain,
)
result = hook.list_ad_words_links(
account_id=self.account_id,
web_property_id=self.web_property_id,
)
return result
@deprecated(
reason=(
"The `GoogleAnalyticsDataImportUploadOperator` class is deprecated, please use "
"`GoogleAnalyticsAdminCreateDataStreamOperator` instead."
),
category=AirflowProviderDeprecationWarning,
)
[docs]class GoogleAnalyticsDataImportUploadOperator(BaseOperator):
"""
Take a file from Cloud Storage and uploads it to GA via data import API.
.. seealso::
This operator is deprecated, please use
:class:`~airflow.providers.google.marketing_platform.operators.analytics_admin.GoogleAnalyticsAdminCreateDataStreamOperator`:
:param storage_bucket: The Google cloud storage bucket where the file is stored.
:param storage_name_object: The name of the object in the desired Google cloud
storage bucket. (templated) If the destination points to an existing
folder, the file will be taken from the specified folder.
:param account_id: The GA account Id (long) to which the data upload belongs.
:param web_property_id: The web property UA-string associated with the upload.
:param custom_data_source_id: The id to which the data import belongs
:param resumable_upload: flag to upload the file in a resumable fashion, using a
series of at least two requests.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param delegate_to: The account to impersonate using domain-wide delegation of authority,
if any. For this to work, the service account making the request must have
domain-wide delegation enabled.
:param api_version: The version of the api that will be requested for example 'v3'.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
of the last account in the list, which will be impersonated in the request.
If set as a string, the account must grant the originating account
the Service Account Token Creator IAM role.
If set as a sequence, the identities from the list must grant
Service Account Token Creator IAM role to the directly preceding identity, with first
account from the list granting this role to the originating account (templated).
"""
[docs] template_fields: Sequence[str] = (
"storage_bucket",
"storage_name_object",
"impersonation_chain",
)
def __init__(
self,
*,
storage_bucket: str,
storage_name_object: str,
account_id: str,
web_property_id: str,
custom_data_source_id: str,
resumable_upload: bool = False,
gcp_conn_id: str = "google_cloud_default",
delegate_to: str | None = None,
api_version: str = "v3",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(**kwargs)
self.storage_bucket = storage_bucket
self.storage_name_object = storage_name_object
self.account_id = account_id
self.web_property_id = web_property_id
self.custom_data_source_id = custom_data_source_id
self.resumable_upload = resumable_upload
self.gcp_conn_id = gcp_conn_id
self.delegate_to = delegate_to
self.api_version = api_version
self.impersonation_chain = impersonation_chain
[docs] def execute(self, context: Context) -> None:
gcs_hook = GCSHook(
gcp_conn_id=self.gcp_conn_id,
delegate_to=self.delegate_to,
impersonation_chain=self.impersonation_chain,
)
ga_hook = GoogleAnalyticsHook(
gcp_conn_id=self.gcp_conn_id,
delegate_to=self.delegate_to,
api_version=self.api_version,
impersonation_chain=self.impersonation_chain,
)
with NamedTemporaryFile("w+") as tmp_file:
self.log.info(
"Downloading file from GCS: %s/%s ",
self.storage_bucket,
self.storage_name_object,
)
gcs_hook.download(
bucket_name=self.storage_bucket,
object_name=self.storage_name_object,
filename=tmp_file.name,
)
ga_hook.upload_data(
tmp_file.name,
self.account_id,
self.web_property_id,
self.custom_data_source_id,
self.resumable_upload,
)
@deprecated(
reason=(
"The `GoogleAnalyticsDeletePreviousDataUploadsOperator` class is deprecated, please use "
"`GoogleAnalyticsAdminDeleteDataStreamOperator` instead."
),
category=AirflowProviderDeprecationWarning,
)
[docs]class GoogleAnalyticsDeletePreviousDataUploadsOperator(BaseOperator):
"""
Deletes previous GA uploads to leave the latest file to control the size of the Data Set Quota.
.. seealso::
This operator is deprecated, please use
:class:`~airflow.providers.google.marketing_platform.operators.analytics_admin.GoogleAnalyticsAdminDeleteDataStreamOperator`:
:param account_id: The GA account Id (long) to which the data upload belongs.
:param web_property_id: The web property UA-string associated with the upload.
:param custom_data_source_id: The id to which the data import belongs.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param delegate_to: The account to impersonate using domain-wide delegation of authority,
if any. For this to work, the service account making the request must have
domain-wide delegation enabled.
:param api_version: The version of the api that will be requested for example 'v3'.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
of the last account in the list, which will be impersonated in the request.
If set as a string, the account must grant the originating account
the Service Account Token Creator IAM role.
If set as a sequence, the identities from the list must grant
Service Account Token Creator IAM role to the directly preceding identity, with first
account from the list granting this role to the originating account (templated).
"""
[docs] template_fields: Sequence[str] = ("impersonation_chain",)
def __init__(
self,
account_id: str,
web_property_id: str,
custom_data_source_id: str,
gcp_conn_id: str = "google_cloud_default",
delegate_to: str | None = None,
api_version: str = "v3",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(**kwargs)
self.account_id = account_id
self.web_property_id = web_property_id
self.custom_data_source_id = custom_data_source_id
self.gcp_conn_id = gcp_conn_id
self.delegate_to = delegate_to
self.api_version = api_version
self.impersonation_chain = impersonation_chain
[docs] def execute(self, context: Context) -> None:
ga_hook = GoogleAnalyticsHook(
gcp_conn_id=self.gcp_conn_id,
delegate_to=self.delegate_to,
api_version=self.api_version,
impersonation_chain=self.impersonation_chain,
)
uploads = ga_hook.list_uploads(
account_id=self.account_id,
web_property_id=self.web_property_id,
custom_data_source_id=self.custom_data_source_id,
)
cids = [upload["id"] for upload in uploads]
delete_request_body = {"customDataImportUids": cids}
ga_hook.delete_upload_data(
self.account_id,
self.web_property_id,
self.custom_data_source_id,
delete_request_body,
)