如何使用Go语言在Google Sheets API批量更新时创建NamedRange

前置调整 #

• 首先替换授权范围，你当前使用的只读权限无法修改表格配置，需将权限调整为：https://www.googleapis.com/auth/spreadsheets

实现逻辑 #

创建NamedRange需要调用Sheets API的Spreadsheets.BatchUpdate接口，传入AddNamedRangeRequest类型的请求参数，支持新建工作表同步创建、已有工作表更新时创建两种场景。

完整示例代码 #

package main

import (
	"context"
	"fmt"
	"io/ioutil"
	"log"

	"google.golang.org/api/option"
	"google.golang.org/api/sheets/v4"
	"golang.org/x/oauth2/google"
)

// 原有getClient函数保留你自己之前的实现即可
// func getClient(config *oauth2.Config) *http.Client { ... }

func writeSSAndCreateNamedRange(ssid string, sheetName string, namedRangeName string, content [][]interface{}, dataRange string) error {
	ctx := context.Background()

	b, err := ioutil.ReadFile("./credentials/client_secret.json")
	if err != nil {
		log.Fatalf("无法读取客户端密钥文件: %v", err)
	}

	// 替换为读写权限
	config, err := google.ConfigFromJSON(b, "https://www.googleapis.com/auth/spreadsheets")
	if err != nil {
		log.Fatalf("无法解析客户端密钥文件: %v", err)
	}
	client := getClient(config)

	srv, err := sheets.NewService(ctx, option.WithHTTPClient(client))
	if err != nil {
		log.Fatalf("无法获取Sheets客户端: %v", err)
	}

	spreadsheetId := ssid
	// 写入数据逻辑和原有一致
	rangeData := fmt.Sprintf("%s!%s", sheetName, dataRange)
	rb := &sheets.BatchUpdateValuesRequest{
		ValueInputOption: "USER_ENTERED",
	}
	rb.Data = append(rb.Data, &sheets.ValueRange{
		Range:  rangeData,
		Values: content,
	})
	_, err = srv.Spreadsheets.Values.BatchUpdate(spreadsheetId, rb).Context(ctx).Do()
	if err != nil {
		return fmt.Errorf("写入数据失败: %v", err)
	}

	// 新增：创建NamedRange逻辑
	createNamedRangeReq := &sheets.Request{
		AddNamedRange: &sheets.AddNamedRangeRequest{
			NamedRange: &sheets.NamedRange{
				Name: namedRangeName,
				Range: &sheets.GridRange{
					SheetId:          getSheetIdByName(srv, spreadsheetId, sheetName),
					StartRowIndex:    0, // 行索引从0开始，对应工作表的第1行
					EndRowIndex:      6, // 范围左闭右开，0到6对应第1到第6行
					StartColumnIndex: 0, // 列索引从0开始，对应A列
					EndColumnIndex:   1, // 范围左闭右开，0到1对应A列
				},
			},
		},
	}

	batchUpdateReq := &sheets.BatchUpdateSpreadsheetRequest{
		Requests: []*sheets.Request{createNamedRangeReq},
	}
	_, err = srv.Spreadsheets.BatchUpdate(spreadsheetId, batchUpdateReq).Context(ctx).Do()
	if err != nil {
		return fmt.Errorf("创建NamedRange失败: %v", err)
	}

	fmt.Println("数据写入及NamedRange创建完成")
	return nil
}

// 辅助函数：根据工作表名称获取sheetId
func getSheetIdByName(srv *sheets.Service, spreadsheetId string, sheetName string) int64 {
	spreadsheet, err := srv.Spreadsheets.Get(spreadsheetId).Do()
	if err != nil {
		log.Fatalf("获取表格信息失败: %v", err)
	}
	for _, sheet := range spreadsheet.Sheets {
		if sheet.Properties.Title == sheetName {
			return sheet.Properties.SheetId
		}
	}
	log.Fatalf("未找到名为%s的工作表", sheetName)
	return 0
}

场景适配说明 #

• 新建工作表时创建NamedRange：可以在BatchUpdateSpreadsheetRequest的Requests数组里先加AddSheetRequest创建新工作表，再追加AddNamedRangeRequest，单次请求即可完成两个操作，无需多次调用接口
• 修改已有NamedRange：如果是更新现有NamedRange的范围，使用UpdateNamedRangeRequest即可，需要传入对应NamedRange的id

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