# 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.
"""
Example Airflow DAG that shows how to use Google Analytics (GA4) Admin Operators.
This DAG relies on the following OS environment variables
* GA_ACCOUNT_ID - Google Analytics account id.
* GA_GOOGLE_ADS_PROPERTY_ID - Google Analytics property's id associated with Google Ads Link.
In order to run this test, make sure you followed steps:
1. Login to https://analytics.google.com
2. In the settings section create an account and save its ID in the variable GA_ACCOUNT_ID.
3. In the settings section go to the Property access management page and add your service account email with
Editor permissions. This service account should be created on behalf of the account from the step 1.
4. Make sure Google Analytics Admin API is enabled in your GCP project.
5. Create Google Ads account and link it to your Google Analytics account in the GA admin panel.
6. Associate the Google Ads account with a property, and save this property's id in the variable
GA_GOOGLE_ADS_PROPERTY_ID.
"""
from __future__ import annotations
import json
import logging
import os
from datetime import datetime
from google.analytics import admin_v1beta as google_analytics
from airflow.decorators import task
from airflow.models import Connection
from airflow.models.dag import DAG
from airflow.operators.bash import BashOperator
from airflow.providers.google.marketing_platform.operators.analytics_admin import (
GoogleAnalyticsAdminCreateDataStreamOperator,
GoogleAnalyticsAdminCreatePropertyOperator,
GoogleAnalyticsAdminDeleteDataStreamOperator,
GoogleAnalyticsAdminDeletePropertyOperator,
GoogleAnalyticsAdminGetGoogleAdsLinkOperator,
GoogleAnalyticsAdminListAccountsOperator,
GoogleAnalyticsAdminListGoogleAdsLinksOperator,
)
from airflow.settings import Session
from airflow.utils.trigger_rule import TriggerRule
[docs]ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
[docs]DAG_ID = "example_google_analytics_admin"
[docs]CONNECTION_ID = f"connection_{DAG_ID}_{ENV_ID}"
[docs]ACCOUNT_ID = os.environ.get("GA_ACCOUNT_ID", "123456789")
[docs]PROPERTY_ID = "{{ task_instance.xcom_pull('create_property')['name'].split('/')[-1] }}"
[docs]DATA_STREAM_ID = "{{ task_instance.xcom_pull('create_data_stream')['name'].split('/')[-1] }}"
[docs]GA_GOOGLE_ADS_PROPERTY_ID = os.environ.get("GA_GOOGLE_ADS_PROPERTY_ID", "123456789")
[docs]GA_ADS_LINK_ID = "{{ task_instance.xcom_pull('list_google_ads_links')[0]['name'].split('/')[-1] }}"
[docs]log = logging.getLogger(__name__)
with DAG(
DAG_ID,
schedule="@once", # Override to match your needs,
start_date=datetime(2021, 1, 1),
catchup=False,
tags=["example", "analytics"],
) as dag:
@task
[docs] def setup_connection(**kwargs) -> None:
connection = Connection(
conn_id=CONNECTION_ID,
conn_type="google_cloud_platform",
)
conn_extra_json = json.dumps(
{
"scope": "https://www.googleapis.com/auth/analytics.edit,"
"https://www.googleapis.com/auth/analytics.readonly",
}
)
connection.set_extra(conn_extra_json)
session = Session()
if session.query(Connection).filter(Connection.conn_id == CONNECTION_ID).first():
log.warning("Connection %s already exists", CONNECTION_ID)
return None
session.add(connection)
session.commit()
setup_connection_task = setup_connection()
# [START howto_marketing_platform_list_accounts_operator]
list_accounts = GoogleAnalyticsAdminListAccountsOperator(
task_id="list_account",
gcp_conn_id=CONNECTION_ID,
show_deleted=True,
)
# [END howto_marketing_platform_list_accounts_operator]
# [START howto_marketing_platform_create_property_operator]
create_property = GoogleAnalyticsAdminCreatePropertyOperator(
task_id="create_property",
analytics_property={
"parent": f"accounts/{ACCOUNT_ID}",
"display_name": "Test display name",
"time_zone": "America/Los_Angeles",
},
gcp_conn_id=CONNECTION_ID,
)
# [END howto_marketing_platform_create_property_operator]
# [START howto_marketing_platform_create_data_stream_operator]
create_data_stream = GoogleAnalyticsAdminCreateDataStreamOperator(
task_id="create_data_stream",
property_id=PROPERTY_ID,
data_stream={
"display_name": "Test data stream",
"web_stream_data": {
"default_uri": "www.example.com",
},
"type_": google_analytics.DataStream.DataStreamType.WEB_DATA_STREAM,
},
gcp_conn_id=CONNECTION_ID,
)
# [END howto_marketing_platform_create_data_stream_operator]
# [START howto_marketing_platform_delete_data_stream_operator]
delete_data_stream = GoogleAnalyticsAdminDeleteDataStreamOperator(
task_id="delete_datastream",
property_id=PROPERTY_ID,
data_stream_id=DATA_STREAM_ID,
gcp_conn_id=CONNECTION_ID,
)
# [END howto_marketing_platform_delete_data_stream_operator]
# [START howto_marketing_platform_delete_property_operator]
delete_property = GoogleAnalyticsAdminDeletePropertyOperator(
task_id="delete_property",
property_id=PROPERTY_ID,
gcp_conn_id=CONNECTION_ID,
)
# [END howto_marketing_platform_delete_property_operator]
delete_property.trigger_rule = TriggerRule.ALL_DONE
# [START howto_marketing_platform_list_google_ads_links]
list_google_ads_links = GoogleAnalyticsAdminListGoogleAdsLinksOperator(
task_id="list_google_ads_links",
property_id=GA_GOOGLE_ADS_PROPERTY_ID,
gcp_conn_id=CONNECTION_ID,
)
# [END howto_marketing_platform_list_google_ads_links]
# [START howto_marketing_platform_get_google_ad_link]
get_ad_link = GoogleAnalyticsAdminGetGoogleAdsLinkOperator(
task_id="get_ad_link",
property_id=GA_GOOGLE_ADS_PROPERTY_ID,
google_ads_link_id=GA_ADS_LINK_ID,
gcp_conn_id=CONNECTION_ID,
)
# [END howto_marketing_platform_get_google_ad_link]
delete_connection = BashOperator(
task_id="delete_connection",
bash_command=f"airflow connections delete {CONNECTION_ID}",
trigger_rule=TriggerRule.ALL_DONE,
)
(
# TEST SETUP
setup_connection_task
# TEST BODY
>> list_accounts
>> create_property
>> create_data_stream
>> delete_data_stream
>> delete_property
>> list_google_ads_links
>> get_ad_link
# TEST TEARDOWN
>> delete_connection
)
from tests.system.utils.watcher import watcher
# This test needs watcher in order to properly mark success/failure
# when "tearDown" task with trigger rule is part of the DAG
list(dag.tasks) >> watcher()
from tests.system.utils import get_test_run # noqa: E402
# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
[docs]test_run = get_test_run(dag)