在 NodeJS 中集成 Google Calendar API：活动创建和会议安排指南

php中文网 2024-12-05 18:06:19

google calendar api 是一个强大的工具，用于以编程方式管理事件和安排会议。本教程将引导您将 api 集成到 node.js 应用程序中，以处理 oauth 身份验证、检索访问令牌和创建事件。我们还将介绍前端应用程序中的重定向处理，以实现无缝的用户体验。

先决条件

node.js（版本 18 ）。
启用了日历 api 的 google cloud 项目。
来自 google cloud console 的凭据。请按照以下步骤进行设置：
1. 导航到 google cloud console。
2. 创建一个新项目或选择现有项目。
3. 为您的项目启用 google calendar api。
4. 转到 api 和服务 > 凭证 并创建 oauth 2.0 凭证。
5. 下载凭据 json 文件并将其另存为项目中的 cleint_secrets.json。
用于安全存储凭据（client_id、client_secret 等）的 .env 或 client_secrets.json 文件。
已安装 googleapis npm 软件包（npm install googleapis）。

设置 google oauth 身份验证

第一步是允许用户使用其 google 帐户进行身份验证并授予管理其日历的访问权限。这是使用 oauth2 协议实现的。

第 1 步：生成身份验证 url

以下是生成 google oauth2 身份验证 url 的方法：

async googleauthconsent() {
  try {
    // read credentials from a file
    const credentials = json.parse(
      await promisify(fs.readfile)('./client_secrets.json', 'utf-8'),
    );

    // change this with your redirect url
    const redirect_uri = "http://localhost:3000";

    const oauth2client = new google.auth.oauth2(
      credentials.web.client_id,
      credentials.web.client_secret,
      redirect_uri,
    );

    const scopes = ['https://www.googleapis.com/auth/calendar'];

    const authurl = oauth2client.generateauthurl({
      access_type: 'offline',
      scope: scopes,
    });

    return {
      message: 'auth url created successfully',
      url: authurl,
    };
  } catch (error) {
    throw new error(error.message || 'internal server error');
  }
}

要点：

范围： 指定访问级别。对于日历事件，范围是 https://www.googleapis.com/auth/calendar.
访问类型：将其设置为离线可确保返回刷新令牌。

第 2 步：处理访问令牌

用户通过生成的 url 进行身份验证后，将使用代码重定向到您的应用程序。此代码可兑换代币。

async generategoogleoauthtoken(
  data: { code: string; scope: string },
) {
  try {
    const { code } = data;

    const credentials = json.parse(
      await promisify(fs.readfile)('./client_secrets.json', 'utf-8'),
    );

    // change this with your redirect url
    const redirect_uri = "http://localhost:3000";

    const oauth2client = new google.auth.oauth2(
      credentials.web.client_id,
      credentials.web.client_secret,
      redirect_uri,
    );

    const { tokens } = await oauth2client.gettoken(code);

    // your logic for storing token i.g. database or file 

    return {
      message: 'user oauth token generated successfully',
      token,
    };
  } catch (error) {
    throw new error(error.message || 'internal server error');
  }
}

第 3 步：活动创建

安全存储令牌后，您现在可以使用 google calendar api 创建事件。以下是安排会议的通用方法，包括时间、与会者、提醒和可选的 google meet 链接等活动详细信息。

通用事件创建方法

此方法实现以下目的：

对用户进行身份验证：使用 oauth2 向 google 进行身份验证。
创建事件：将事件插入用户的主日历中。
包括附加功能：添加 google meet 链接、与会者和自定义提醒等选项。

 const event = {
   summary: 'Team Meeting',
   location: 'Virtual',
   description: 'Discuss project updates.',
    start: {
     dateTime: new Date(Date.now() + 3600 * 1000).toISOString(), // Start in 1 hour
    timeZone: 'Asia/Kolkata',
    },
    end: {
     dateTime: new Date(Date.now() + 7200 * 1000).toISOString(), // End in 2 hours
      timeZone: 'Asia/Kolkata',
    },
    conferenceData: {
      createRequest: {
        requestId: `meet-${Date.now()}`,
        conferenceSolutionKey: { type: 'hangoutsMeet' },
      },
    },
    attendees: [{ email: 'example@example.com' }],
    reminders: {
      useDefault: false,
      overrides: [
        { method: 'email', minutes: 60 }, // Reminder 1 hour before
        { method: 'popup', minutes: 10 }, // Reminder 10 minutes before
      ],
    },
  };

const createdEvent = await createGoogleCalendarEvent(event)

type Credentials = oauth2_v2.Schema$Tokeninfo;
type Resource = calendar_v3.Schema$Event;
interface InsertEvent extends calendar_v3.Params$Resource$Events$Insert {
  resource: Resource;
}

async createGoogleCalendarEvent(event: Resource) {
  try {

    const userToken = "your logic to retrive the users stored token"

    if (!userToken) {
      throw new Error('User is not authenticated');
    }

    // Read OAuth2 credentials from client secrets file
    const credentials = JSON.parse(
      await promisify(fs.readFile)('./client_secrets.json', 'utf-8'),
    );

     // change this with your redirect url
    const REDIRECT_URI = "http://localhost:3000";

    // Initialize OAuth2 client
    const oauth2Client = new google.auth.OAuth2(
      credentials.web.client_id,
      credentials.web.client_secret,
      REDIRECT_URI,
    );

    // Set OAuth2 token
    oauth2Client.setCredentials(userToken as Credentials);

    // Initialize Google Calendar API client
    const calendar = google.calendar({ version: 'v3', auth: oauth2Client });
    const calendarId = 'primary';

    // Prepare event parameters
    let eventInsertParams: InsertEvent = {
      calendarId,
      resource: event,
      sendUpdates: 'all',
    };

    // Include conferenceDataVersion if using Google Meet
    if (
      event.conferenceData?.createRequest?.conferenceSolutionKey?.type ===
      'hangoutsMeet'
    ) {
      eventInsertParams.conferenceDataVersion = 1;
    }

    // Create the event
    const eventCreated = await calendar.events.insert(eventInsertParams);

    // Return the event details
    return eventCreated.data;
  } catch (error) {
    let message = 'Internal Server Error';
    if (error instanceof Error) {
      message = error.message;
    }
    throw new Error(message);
  }
}