如何在gaapi4py库中使用Google Analytics API自定义维度？

问题场景 #

使用gaapi4py连接Google Analytics API时请求正常，但添加user_id自定义维度后报错：

"Unknown dimension(s): ga:ga_user_id"

原请求体代码：

request_body = {
    'view_id': '123456789',
    'start_date': '2022-09-11',
    'end_date': '2022-09-14',
    'dimensions': {
        'ga:date',
        'ga:Browser',
        'ga:city',
        'ga:ga_user_id'
    },
    'metrics': {
        'ga:sessions'
    }
}

解决方案 #

• 自定义维度的正确命名格式：Google Analytics中自定义维度的标识符不是ga:ga_user_id，而是ga:dimensionX，其中X是你在GA后台配置该自定义维度时分配的索引编号（比如1、2、3...）。
  登录Google Analytics后台，进入「管理」->「自定义定义」->「自定义维度」，找到绑定了user_id的那条自定义维度，查看它的索引值即可。
• 修改请求体中的维度值：将ga:ga_user_id替换为对应的ga:dimensionX。例如，如果user_id对应的是维度1，就改成ga:dimension1。
• 确认维度已启用：确保该自定义维度已经在view_id指定的视图中启用，未启用的维度会触发同样的报错。

修正后的请求体示例（假设user_id对应维度1）：

request_body = {
    'view_id': '123456789',
    'start_date': '2022-09-11',
    'end_date': '2022-09-14',
    'dimensions': {
        'ga:date',
        'ga:Browser',
        'ga:city',
        'ga:dimension1'
    },
    'metrics': {
        'ga:sessions'
    }
}

内容的提问来源于stack exchange，提问作者Daniel G