npm 包 @sumaq-plugins/google-sheets 使用教程

阅读时长 5 分钟读完

简介

npm 包 @sumaq-plugins/google-sheets 是一个方便操作 Google Sheets 的工具,它提供了一系列的 API,可以快速实现对 Google Sheets 的读写等操作。本文将详细介绍如何使用该工具。

安装

首先需要在本地项目中安装 @sumaq-plugins/google-sheets 包,执行以下命令:

使用

1. 创建 Credentials

在使用之前,需要在 Google Cloud Platform 上创建一个 Project 并添加 Google Sheets API,以获取相应的 Credentials。可以参考官网文档进行操作。生成的 Credentials 是一个 JSON 文件,下载保存到本地项目中。具体操作如下:

  1. 打开 Google Cloud Platform 控制台,创建一个新项目。

  2. 选择左侧菜单中的“API 和服务 > 仪表盘”,点击“启用 API 和服务”。

  3. 搜索“Google Sheets API”,并启用此服务。

  4. 在左侧菜单中选择“API 和服务 > 凭据”,点击“创建凭据”。

  5. 在“凭据类型”下选择“服务帐号键”。

  6. 在“创建服务帐号”页面中填写如下信息:

    • 选择“新服务帐号”
    • 在“服务帐号名称”中输入一个名称
    • 在“角色”下选择“项目” > “编辑者”
    • 在“JSON 密钥”中选择“创建密钥”,并选择“JSON”,并下载 JSON 文件。将其重命名并保存到本地项目中。
  7. 授权 Service Account 在指定的 Google Sheets 中进行操作。在 Google Sheets 中创建或打开要处理的表,点击“共享”并输入 Service Account 的邮箱即可。

2. 开始操作

首先在 JavaScript 文件中引入 @sumaq-plugins/google-sheets:

接下来需要传入 Credentials 在 GoogleSheets 初始化一个实例:

3. 获取 Sheet

获取到 GoogleSheets 的 client 后,即可使用其方法链接 Google Sheets,首先需要获取到 Sheet:

4. 读取数据

读取数据比较简单,只需要调用 getValues 方法即可:

其中,<range> 表示数据的范围,例如 'A1:C3' 即表示 A1 到 C3 的单元格范围。

5. 写入数据

写入数据需要调用 updateValues 方法,以修改 A1 单元格为例:

6. 其他操作

在以上基础操作的基础上,@sumaq-plugins/google-sheets 还提供了其他一些操作,例如:

  • clearRange:删除指定范围内的数据
  • deleteSheet:删除指定的 Sheet
  • createSheet:创建新的 Sheet 等

可以参考官方文档进行学习。

示例代码

下面给出完整的示例代码:

-- -------------------- ---- -------
----- - ------------ - - ----------------------------------------

----- ----------- - ---------------- --- ---- ----------- ---- -------------
----- ------ - --- --------------------------

------ -- -- -
  ----- - ------ - - ----- -------------------
  ----- ----- - ------------------ -- --------------------- --- ------ ----- --------

  ----- ----- - -------------------------------
  ----- ------ - ------ ---------
  ----- -------------------------- --------

  ----- --- - ----- ---------------------------------------- -----------
  ------------------------
----
展开代码

结语

本文详细介绍了 @sumaq-plugins/google-sheets npm 包的使用教程。通过本文示例代码的演示,相信大家可以快速上手使用,方便处理 Google Sheets,提高工作效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600573c581e8991b448e9b9b

纠错
反馈

纠错反馈