شروع سریع اسکریپت Google Apps

یک اسکریپت Google Apps ایجاد کنید که درخواست‌هایی را به Google Chat API ارسال کند.

آموزش‌های سریع، نحوه راه‌اندازی و اجرای برنامه‌ای که API گوگل ورک‌اسپیس را فراخوانی می‌کند، توضیح می‌دهند. این آموزش سریع از یک رویکرد احراز هویت ساده‌شده استفاده می‌کند که برای محیط آزمایشی مناسب است. برای محیط عملیاتی، توصیه می‌کنیم قبل از انتخاب اعتبارنامه‌های دسترسی مناسب برای برنامه خود، در مورد احراز هویت و مجوزدهی اطلاعات کسب کنید.

در Apps Script، پیش‌نمایش‌های Google Workspace از سرویس‌های پیشرفته گوگل برای فراخوانی APIهای Google Workspace و مدیریت برخی جزئیات جریان احراز هویت و مجوزدهی استفاده می‌کنند.

اهداف

  • محیط را پیکربندی کنید.
  • اسکریپت را ایجاد و پیکربندی کنید.
  • اسکریپت را اجرا کنید.

پیش‌نیازها

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

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

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

اگر هنوز باز نشده است، پروژه ابری که قصد دارید برای این نمونه استفاده کنید را باز کنید:

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

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

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

فعال کردن API چت

قبل از استفاده از APIهای گوگل، باید آنها را در یک پروژه گوگل کلود فعال کنید. می‌توانید یک یا چند API را در یک پروژه گوگل کلود فعال کنید.
  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > برندسازی .

    به بخش برندسازی بروید

  2. اگر قبلاً تنظیمات را انجام داده‌اید Google Auth platformمی‌توانید تنظیمات صفحه رضایت OAuth زیر را در Branding ، Audience و Data Access پیکربندی کنید. اگر پیامی با این مضمون مشاهده کردید Google Auth platform هنوز پیکربندی نشده است ، روی شروع کار کلیک کنید:
    1. در قسمت اطلاعات برنامه ، در قسمت نام برنامه ، نامی برای برنامه وارد کنید.
    2. در ایمیل پشتیبانی کاربر ، یک آدرس ایمیل پشتیبانی انتخاب کنید که کاربران در صورت داشتن هرگونه سوال در مورد رضایت خود بتوانند با شما تماس بگیرند.
    3. روی بعدی کلیک کنید.
    4. در قسمت مخاطبان ، داخلی (Internal) را انتخاب کنید.
    5. روی بعدی کلیک کنید.
    6. در قسمت اطلاعات تماس ، یک آدرس ایمیل وارد کنید که از طریق آن بتوانید از هرگونه تغییر در پروژه خود مطلع شوید.
    7. روی بعدی کلیک کنید.
    8. در قسمت Finish ، سیاست داده‌های کاربر سرویس‌های API گوگل را مرور کنید و در صورت موافقت، گزینه «من با سیاست‌های داده‌های کاربر سرویس‌های API گوگل موافقم» را انتخاب کنید.
    9. روی ادامه کلیک کنید.
    10. روی ایجاد کلیک کنید.
  3. فعلاً می‌توانید از اضافه کردن محدوده‌ها صرف نظر کنید. در آینده، وقتی برنامه‌ای برای استفاده در خارج از سازمان Google Workspace خود ایجاد می‌کنید، باید نوع کاربر (User type) را به خارجی (External) تغییر دهید. سپس محدوده‌های مجوز مورد نیاز برنامه خود را اضافه کنید. برای کسب اطلاعات بیشتر، به راهنمای کامل پیکربندی رضایت OAuth مراجعه کنید.

برنامه چت گوگل را پیکربندی کنید

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

  1. در کنسول گوگل کلود، به صفحه پیکربندی API چت بروید:

    به صفحه پیکربندی API چت بروید

  2. در قسمت اطلاعات برنامه ، اطلاعات زیر را وارد کنید:

    1. در فیلد نام برنامه ، Chat API quickstart app وارد کنید.
    2. در فیلد آدرس اینترنتی آواتار ، https://developers.google.com/chat/images/quickstart-app-avatar.png را وارد کنید.
    3. در فیلد توضیحات ، Quickstart for calling the Chat API وارد کنید.

  3. در بخش ویژگی‌های تعاملی ، روی گزینه‌ی فعال کردن ویژگی‌های تعاملی کلیک کنید تا به حالت خاموش درآید و ویژگی‌های تعاملی برنامه‌ی چت غیرفعال شود.

  4. روی ذخیره کلیک کنید.

اسکریپت را ایجاد کنید

  1. با رفتن به script.google.com/create ، یک اسکریپت جدید در ویرایشگر Apps Script ایجاد کنید.
  2. محتویات ویرایشگر اسکریپت را با کد زیر جایگزین کنید:

چت/شروع سریع/کد.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. روی ذخیره کلیک کنید .
  2. روی پروژه بدون عنوان کلیک کنید، عبارت Quickstart را تایپ کنید و روی تغییر نام کلیک کنید.

پیکربندی اسکریپت

شماره پروژه ابری را کپی کنید

  1. در کنسول گوگل کلود، به Menu > IAM & Admin > Settings بروید.

    به تنظیمات IAM و مدیریت بروید

  2. در فیلد شماره پروژه ، مقدار را کپی کنید.
  1. پروژه Apps Script را باز کنید.
  2. پروژه کلیک کنید.
  3. در زیر پروژه پلتفرم ابری گوگل (GCP) ، روی تغییر پروژه کلیک کنید.
  4. در قسمت شماره پروژه GCP ، شماره پروژه Google Cloud را وارد کنید.
  5. روی تنظیم پروژه کلیک کنید.

فعال کردن API چت گوگل

پروژه Apps Script را باز کنید.

  1. پروژه کلیک کنید.
  2. در قسمت تنظیمات عمومی ، گزینه‌ی «نمایش فایل مانیفست "appsscript.json" در ویرایشگر» را فعال کنید.
  3. روی ویرایشگر کلیک کنید، فایل appscript.json را انتخاب کنید و محتویات آن را با کد زیر جایگزین کنید:

چت/شروع سریع/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

نمونه را اجرا کنید

در ویرایشگر اسکریپت برنامه‌ها، روی اجرا (Run ) کلیک کنید.

اولین باری که نمونه را اجرا می‌کنید، از شما اجازه دسترسی می‌خواهد:

  1. روی بررسی مجوزها کلیک کنید.
  2. یک حساب کاربری انتخاب کنید.
  3. روی اجازه دادن کلیک کنید.

گزارش اجرای اسکریپت در پایین پنجره ظاهر می‌شود.

مراحل بعدی