GA4 Admin API .Net库调用CustomDimensions.Patch抛出内部错误问题

触发原因 #

• 当前使用的GoogleAnalyticsAdminV1alpha版本API存在自定义维度接口校验缺陷：即使UpdateMask未指定要更新Scope字段，后端服务也会强制要求请求体中携带原自定义维度的Scope值，缺失该字段就会返回无明确提示的500内部错误。而自定义Metric的Patch逻辑没有这个额外校验要求，所以相同逻辑的自定义Metric更新可以正常运行。
• UpdateMask字段命名和.NET客户端库属性映射不兼容：部分alpha版本的客户端库要求UpdateMask使用驼峰命名displayName而非下划线命名display_name，命名规则不匹配会触发后端序列化异常返回500。

解决方案 #

方案1：补全Scope字段，调整UpdateMask命名 #

修改代码为以下格式即可运行：

var service = new GoogleAnalyticsAdminService(...); 

var request = service.Properties.CustomDimensions
    .Patch(new GoogleAnalyticsAdminV1alphaCustomDimension()
    {
        // 补全当前自定义维度对应的原有Scope值，可选值为 EVENT/USER/SESSION/ITEM，必须和创建时的Scope完全一致
        Scope = "EVENT",
        Description = "Same description",
        DisplayName = "New display name"
    }, "properties/1234567890/customDimensions/1234567890");

// 调整为驼峰命名的UpdateMask，和客户端库属性名保持一致
request.UpdateMask = "description,displayName";

await request.ExecuteAsync(cancellationToken); 

方案2：升级为稳定版API #

将GoogleAnalyticsAdminV1alpha替换为正式稳定版GoogleAnalyticsAdminV1，稳定版已经修复了Scope强制校验的问题，UpdateMask也同时兼容下划线和驼峰两种命名格式，不需要额外补全未修改的字段。

内容的提问来源于stack exchange，提问作者Tony McCreath