با Node.js یک افزونه Google Workspace بسازید

با استفاده از زمان اجرا Node.js یک افزونه Google Workspace در Cloud Functions ایجاد کنید.

اهداف

  • محیط خود را تنظیم کنید.
  • ایجاد و استقرار یک تابع ابری.
  • افزونه را ایجاد و اجرا کنید.
  • افزونه را نصب کنید.

پیش نیازها

محیط خود را تنظیم کنید

پروژه Cloud خود را در کنسول Google Cloud باز کنید

  1. در کنسول Google Cloud، به صفحه انتخاب پروژه بروید.

    یک پروژه Cloud را انتخاب کنید

  2. پروژه Google Cloud را که می خواهید استفاده کنید انتخاب کنید. یا روی ایجاد پروژه کلیک کنید و دستورالعمل های روی صفحه را دنبال کنید. اگر یک پروژه Google Cloud ایجاد می‌کنید، ممکن است لازم باشد صورت‌حساب پروژه را روشن کنید .

صفحه رضایت OAuth را پیکربندی کنید

افزونه‌های Google Workspace به پیکربندی صفحه رضایت نیاز دارند. پیکربندی صفحه رضایت OAuth افزونه شما، آنچه را که Google برای کاربران نمایش می‌دهد مشخص می‌کند.

  1. در کنسول Google Cloud، به منو > APIs & Services > صفحه رضایت OAuth بروید.

    به صفحه رضایت OAuth بروید

  2. برای نوع User Internal را انتخاب کنید، سپس روی Create کلیک کنید.
  3. فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.

  4. در حال حاضر، می‌توانید از افزودن دامنه‌ها صرفنظر کنید و روی ذخیره و ادامه کلیک کنید. در آینده، وقتی برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، باید نوع کاربر را به خارجی تغییر دهید و سپس محدوده‌های مجوز مورد نیاز برنامه خود را اضافه کنید.

  5. خلاصه ثبت برنامه خود را مرور کنید. برای ایجاد تغییرات، روی ویرایش کلیک کنید. اگر ثبت برنامه خوب به نظر می رسد، روی بازگشت به داشبورد کلیک کنید.

ایجاد و استقرار یک تابع ابری

  1. در ترمینال محلی، توابع Cloud، Cloud Build و API برافزای Google Workspace را روشن کنید:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com

  2. در یک پوشه خالی، فایل function.js را با کد نمونه زیر ایجاد کنید:

    /**
 * Cloud Function that loads the homepage for a
 * Google Workspace Add-on.
 *
 * @param {Object} req Request sent from Google
 * @param {Object} res Response to send back
 */
exports.loadHomePage = function addonsHomePage (req, res) {
  res.send(createAction());
};

/** Creates a card with two widgets. */
function createAction() {
  return {
    "action": {
      "navigations": [
        {
          "pushCard": {
            "header": {
              "title": "Cats!"
            },
            "sections": [
              {
                "widgets": [
                  {
                    "textParagraph": {
                      "text": "Your random cat:"
                    }
                  },
                  {
                    "image": {
                      "imageUrl": "https://cataas.com/cat"
                     }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  };
}

  3. استقرار تابع:

    gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http

    اگر از شما خواسته شد، مشخص کنید که فراخوانی های غیراصالتی تابع را مجاز نکنید. ممکن است چند دقیقه طول بکشد تا عملکرد اجرا شود.

یک استقرار افزونه ایجاد کنید

  1. ایمیل حساب سرویس برای افزونه را پیدا کنید:

    gcloud workspace-add-ons get-authorization

  2. به حساب سرویس نقش cloudfunctions.invoker اعطا کنید:

    gcloud functions add-iam-policy-binding loadHomePage \
    --role roles/cloudfunctions.invoker \
    --member serviceAccount:SERVICE_ACCOUNT_EMAIL

  3. URL تابع مستقر شده را دریافت کنید. برای دریافت URL، دستور زیر را اجرا کنید و قسمت url را در قسمت httpsTrigger جستجو کنید:

    gcloud functions describe loadHomePage

  4. فایل deployment.json را با کد نمونه زیر ایجاد کنید. URL تابع مستقر در مرحله قبل را جایگزین URL کنید.

    {
  "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"],
  "addOns": {
    "common": {
      "name": "My HTTP Add-on",
      "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png",
      "homepageTrigger": {
        "runFunction": "URL"
      }
    },
    "gmail": {},
    "drive": {},
    "calendar": {},
    "docs": {},
    "sheets": {},
    "slides": {}
  }
}

  5. ایجاد استقرار:

    gcloud workspace-add-ons deployments create quickstart \
    --deployment-file=deployment.json

افزونه را نصب کنید

  1. استقرار را در حالت توسعه نصب کنید:

    gcloud workspace-add-ons deployments install quickstart

  2. برای مشاهده افزونه، Gmail را باز یا بارگیری مجدد کنید. در نوار ابزار سمت راست، به دنبال نماد لیوان بگردید.

  3. روی نماد کلیک کنید تا افزونه باز شود. اگر از شما خواسته شد، افزونه را مجاز کنید.

اختیاری: تمیز کردن

برای جلوگیری از تحمیل هزینه به حساب خود، منابعی را که ایجاد کرده اید حذف کنید:

  1. افزونه را از حساب Google خود حذف نصب کنید: 

    gcloud workspace-add-ons deployments uninstall quickstart

  2. برای جلوگیری از تحمیل هزینه برای منابع استفاده شده در این شروع سریع، پروژه Cloud را حذف کنید: 

    gcloud projects delete PROJECT_ID

    شناسه پروژه Cloud را که برای شروع سریع استفاده کردید، جایگزین PROJECT_ID کنید. می‌توانید شناسه پروژه Cloud را در کنسول Google Cloud در صفحه داشبورد پیدا کنید.

مراحل بعدی

برای افزودن عملکرد بیشتر به افزونه Google Workspace خود، به راهنماهای زیر مراجعه کنید: