如何从googleapis包中正确导入Schema$ListMessagesResponse接口

解决方案 #

你直接从googleapis根包导入Schema$ListMessagesResponse不生效的原因是：Gmail相关的接口定义没有作为根包的顶级导出成员暴露，全部挂载在Gmail服务的子命名空间下，可通过以下两种方式正确导入：

方案1：通过子命名空间引用（推荐）

直接导入gmail_v1命名空间，即可直接使用所有Gmail相关的接口定义：

import { google, gmail_v1 } from 'googleapis';

// 引入需要的接口
type ListMessagesResponse = gmail_v1.Schema$ListMessagesResponse;
type Message = gmail_v1.Schema$Message;

如果已经初始化了Gmail客户端实例，也可以直接从实例中提取类型：

const gmail = google.gmail('v1');
type ListMessagesResponse = typeof gmail.schema.$ListMessagesResponse;

方案2：子路径直接导入

如果仅需要导入类型不需要加载完整的googleapis包，可以直接从对应服务的子路径导入：

// 注意使用import type避免编译后生成无用的JS代码
import type { Schema$ListMessagesResponse, Schema$Message } from 'googleapis/build/src/apis/gmail/v1';

使用示例 #

调用接口时可以直接用该接口做类型校验：

async function fetchGmailMessageList(auth: any): Promise<Schema$ListMessagesResponse> {
  const gmail = google.gmail({ version: 'v1', auth });
  const response = await gmail.users.messages.list({ userId: 'me' });
  return response.data;
}

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