digital-analytics-toolkit 0.1.0__py3-none-any.whl

digital_analytics_toolkit/ga4_admin_functions.py

@@ -0,0 +1,176 @@
+from google.analytics.admin import AnalyticsAdminServiceClient
+import pandas as pd
+
+def get_ga4_accounts_list(credentials):
+    """
+    Retrieves a list of Google Analytics 4 (GA4) account summaries available 
+    to the authenticated user.
+
+    Args:
+        credentials (google.oauth2.credentials.Credentials): The OAuth2 
+            credentials used to authenticate the Admin API client.
+
+    Returns:
+        pd.DataFrame: A DataFrame containing the account resource name, 
+            display name, and a list of property summaries for each account.
+    """
+    client = AnalyticsAdminServiceClient(credentials=credentials)
+
+    accounts = []
+    for account in client.list_account_summaries():
+        accounts.append({
+            "name": account.name,
+            "display_name": account.display_name,
+            "property_summaries": account.property_summaries
+        })
+
+    return pd.DataFrame(accounts)
+    
+def get_ga4_properties_list(credentials, account_id):
+    """
+    Retrieves detailed metadata for all GA4 properties under a specific account.
+
+    Args:
+        credentials (google.oauth2.credentials.Credentials): The OAuth2 
+            credentials used to authenticate the Admin API client.
+        account_id (str or int): The numeric ID of the GA4 account (e.g., '123456').
+
+    Returns:
+        pd.DataFrame: A DataFrame containing property details including name, 
+            display name, industry category, timezone, currency, and service level.
+    """
+    
+    client = AnalyticsAdminServiceClient(credentials=credentials)
+    request = 'parent:accounts/' + str(account_id)
+    properties_list = client.list_properties(request={'filter':request})
+    properties = {
+        'account' : [],
+        'property': [],
+        'display_name': [],
+        'industry_category' : [],
+        'time_zone' : [],
+        'currency_code' : [],
+        'service_level' : [],
+        'property_type' : [],
+    }
+    for property in properties_list:
+        properties['account'].append(property.account)
+        properties['property'].append(property.name)
+        properties['display_name'].append(property.display_name)
+        properties['industry_category'].append(property.industry_category)
+        properties['time_zone'].append(property.time_zone)
+        properties['currency_code'].append(property.currency_code)
+        properties['service_level'].append(property.service_level)
+        properties['property_type'].append(property.property_type)
+    properties_df = pd.DataFrame(properties)
+    return properties_df
+
+def get_ga4_property_keyEvents(credentials, property_id):
+    """
+    Retrieve key events configured for a Google Analytics 4 (GA4) property.
+
+    This function uses the Google Analytics Admin API to fetch all key events
+    associated with a specified GA4 property and returns the results as a
+    pandas DataFrame.
+
+    Args:
+        credentials: Authenticated Google API credentials object used to
+            initialize the AnalyticsAdminServiceClient.
+        property_id (str | int): The GA4 property ID for which key events
+            should be retrieved.
+
+    Returns:
+        pandas.DataFrame: A DataFrame containing the following columns:
+            - key_event_id (str): Full resource name of the key event.
+            - key_event_name (str): Name of the event marked as a key event.
+            - created_on (str): Timestamp when the key event was created,
+              formatted as '%Y-%m-%d %H:%M:%S'.
+            - custom_event (bool): Indicates whether the event is a custom event.
+
+    Raises:
+        google.api_core.exceptions.GoogleAPIError:
+            If the API request fails or authentication is invalid.
+
+    Example:
+        >>> df = get_ga4_property_keyEvents(credentials, "123456789")
+        >>> print(df.head())
+    """
+    client = AnalyticsAdminServiceClient(credentials=credentials)
+    request = 'properties/' + str(property_id)
+    key_events_list = client.list_key_events(parent=request)
+    key_events = {
+        'key_event_id': [],
+        'key_event_name': [],
+        'created_on' : [],
+        'custom_event' : []
+    }
+    for key_event in key_events_list:
+        key_events['key_event_id'].append(key_event.name)
+        key_events['key_event_name'].append(key_event.event_name)
+        key_events['created_on'].append(key_event.create_time.strftime("%Y-%m-%d %H:%M:%S"))
+        if key_event.custom:
+            key_events['custom_event'].append(True)
+        else:
+            key_events['custom_event'].append(False)
+    key_events_df = pd.DataFrame(key_events)
+    return key_events_df
+
+def get_ga4_property_bq_link(credentials, property_id):
+    """
+    Retrieve BigQuery link configuration details for a Google Analytics 4 (GA4) property.
+
+    This function uses the Google Analytics Admin API to fetch all BigQuery
+    links associated with the specified GA4 property and returns the results
+    as a pandas DataFrame.
+
+    Args:
+        credentials: Authenticated Google credentials object used to initialize
+            the Analytics Admin API client.
+        property_id (str | int): The GA4 property ID.
+
+    Returns:
+        pandas.DataFrame: A DataFrame containing BigQuery link metadata with
+        the following columns:
+            - name: Resource name of the BigQuery link.
+            - project: Linked Google Cloud project ID.
+            - create_time: Timestamp when the link was created.
+            - daily_export_enabled: Whether daily export is enabled.
+            - streaming_export_enabled: Whether streaming export is enabled.
+            - fresh_daily_export_enabled: Whether fresh daily export is enabled.
+            - include_advertising_id: Whether advertising identifiers are included.
+            - export_streams: List of data streams included in the export.
+
+    Raises:
+        google.api_core.exceptions.GoogleAPICallError:
+            If the Analytics Admin API request fails.
+        google.api_core.exceptions.PermissionDenied:
+            If the provided credentials do not have access to the property.
+
+    Example:
+        >>> df = get_ga4_property_bq_link(credentials, "123456789")
+        >>> print(df.head())
+    """
+    client = AnalyticsAdminServiceClient(credentials=credentials)
+    request = 'properties/' + str(property_id)
+    bq_links_list = client.list_big_query_links(parent=request)
+    bq_links = {
+        'name': [],
+        'project': [],
+        'create_time': [],
+        'daily_export_enabled': [],
+        'streaming_export_enabled': [],
+        'fresh_daily_export_enabled': [],
+        'include_advertising_id': [],
+        'export_streams': [],
+    }
+    for bq_link in bq_links_list:
+        bq_links['name'].append(bq_link.name)
+        bq_links['project'].append(bq_link.project)
+        bq_links['create_time'].append(bq_link.create_time.strftime("%Y-%m-%d %H:%M:%S"))
+        bq_links['daily_export_enabled'].append(bq_link.daily_export_enabled)
+        bq_links['streaming_export_enabled'].append(bq_link.streaming_export_enabled)
+        bq_links['fresh_daily_export_enabled'].append(bq_link.fresh_daily_export_enabled)
+        bq_links['include_advertising_id'].append(bq_link.include_advertising_id)
+        bq_links['export_streams'].append(bq_link.export_streams)
+    bq_links_df = pd.DataFrame(bq_links)
+    return bq_links_df