从Google API响应对象高效创建Pandas DataFrame教程

import pandas as pd
import json
from google.analytics.admin import admin_v1beta # 确保已安装 google-analytics-admin 库

def get_custom_dimensions_as_dataframe(property_filter: str) -> pd.DataFrame:
    """
    从Google Analytics Admin API获取自定义维度列表，并将其转换为Pandas DataFrame。

    Args:
        property_filter: Google Analytics 属性的资源名称，例如 "properties/12345"。

    Returns:
        一个包含自定义维度数据的Pandas DataFrame。
    """
    client = admin_v1beta.AnalyticsAdminServiceClient()

    request = admin_v1beta.ListCustomDimensionsRequest(
        parent=property_filter
    )

    # API响应是一个ListCustomDimensionsPager对象
    full_response_pager = client.list_custom_dimensions(request=request)

    df_records = []

    # 迭代Pager对象中的每个自定义维度响应
    for response_item in full_response_pager:
        # 1. 获取响应项的内部字典表示
        # response_item本身是一个Google Protobuf消息对象，其__dict__包含了实际的数据
        step1 = response_item.__dict__

        # 2. 将字典转换为字符串，这是进行字符串替换的基础
        step2 = str(step1)

        # 3. 执行一系列字符串替换，将非标准的Python字典字符串转换为有效的JSON字符串
        # 目标是将 `key: value` 转换为 `"key": "value"` 或 `"key": value`
        # 确保键名和字符串值被双引号包围，布尔值和数字保持其JSON原生格式。
        step3 = step2.replace(': name:', ': "name" :')
        step4 = step3.replace('parameter_name:', ', "parameter_name" :')
        step5 = step4.replace('display_name:', ', "display_name" :')
        step6 = step5.replace('description:', ', "description" :')
        step7 = step6.replace('scope:', ', "scope" :')
        # 处理布尔值和枚举值，确保它们是有效的JSON值
        # 注意：JSON中布尔值 'true' 或 'false' 不需要引号
        step8 = step7.replace('disallow_ads_personalization: true', ', "disallow_ads_personalization" : true')
        step9 = step8.replace("'_pb': ", "") # 移除内部Protobuf对象的引用，通常不需要
        step10 = step9.replace(' : EVENT', ' : "EVENT"') # 枚举值转换为字符串，需要引号
        step11 = step10.replace(' : USER', ' : "USER"')   # 枚举值转换为字符串，需要引号

        # 4. 处理Unicode转义字符并确保编码正确
        # .encode('utf-8').decode('unicode_escape') 用于正确处理字符串中的特殊字符，
        # 例如 \uXXXX，将其转换为实际的Unicode字符，确保json.loads()能正确解析。
        step12 = step11.encode('utf-8').decode('unicode_escape')

        # 5. 将处理后的字符串加载为Python字典
        # 此时，字符串已经是一个有效的JSON格式
        try:
            step13 = json.loads(step12)
            df_records.append(step13)
        except json.JSONDecodeError as e:
            print(f"Error decoding JSON for item: {step12[:200]}... Error: {e}")
            # 在生产环境中，可能需要更健壮的错误处理机制

    # 6. 从字典列表创建Pandas DataFrame
    return pd.DataFrame(df_records)

# 替换为您的Google Analytics 4属性ID
# 例如，如果您的属性ID是 123456789，那么 property_resource_name 就是 "properties/123456789"
property_id = "YOUR_GA4_PROPERTY_ID" 
property_resource_name = f"properties/{property_id}"

# 调用函数获取DataFrame
custom_dimension_df = get_custom_dimensions_as_dataframe(property_resource_name)

# 打印DataFrame的头部信息
print("DataFrame头部信息:")
print(custom_dimension_df.head())

# 打印DataFrame的类型和形状
print(f"\nDataFrame类型: {type(custom_dimension_df)}")
print(f"DataFrame形状: {custom_dimension_df.shape}")