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

Quickstarts نحوه راه‌اندازی و اجرای برنامه‌ای را توضیح می‌دهد که Google Workspace API را فراخوانی می‌کند.

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

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

اهداف

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

پیش نیازها

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

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

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

اگر قبلاً باز نشده است، پروژه Cloud را که می‌خواهید برای این نمونه استفاده کنید باز کنید:

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

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

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

Chat API را روشن کنید

قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. می‌توانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.
  1. در کنسول Google Cloud، به منو > بروید > برندسازی

    به برندینگ بروید

  2. اگر قبلاً آن را پیکربندی کرده اید ، می توانید تنظیمات صفحه رضایت OAuth زیر را در نام تجاری ، مخاطب و دسترسی به داده پیکربندی کنید. اگر پیامی دیدید که می گوید هنوز پیکربندی نشده است ، روی شروع کلیک کنید:
    1. در قسمت اطلاعات برنامه ، در نام برنامه ، نامی برای برنامه وارد کنید.
    2. در ایمیل پشتیبانی کاربر ، آدرس ایمیل پشتیبانی را انتخاب کنید که در صورت داشتن رضایت، کاربران بتوانند با شما تماس بگیرند.
    3. روی Next کلیک کنید.
    4. در قسمت Audience ، Internal را انتخاب کنید.
    5. روی Next کلیک کنید.
    6. در قسمت اطلاعات تماس ، آدرس ایمیلی را وارد کنید که در آن می‌توانید از هرگونه تغییر در پروژه خود مطلع شوید.
    7. روی Next کلیک کنید.
    8. در قسمت پایان ، خط‌مشی داده‌های کاربر سرویس‌های API Google را مرور کنید و در صورت موافقت، من با خدمات Google API موافقم: خط‌مشی داده‌های کاربر را انتخاب کنید.
    9. روی Continue کلیک کنید.
    10. روی ایجاد کلیک کنید.
  3. در حال حاضر، می توانید از افزودن دامنه ها صرف نظر کنید. در آینده، وقتی برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، باید نوع کاربر را به خارجی تغییر دهید. سپس محدوده های مجوز مورد نیاز برنامه خود را اضافه کنید. برای کسب اطلاعات بیشتر، راهنمای کامل Configure OAuth رضایت را ببینید.

برنامه Google Chat را پیکربندی کنید

برای تماس با Google Chat API، باید یک برنامه Google Chat را پیکربندی کنید. برای هر درخواست نوشتن، Google Chat برنامه Google Chat را در رابط کاربری با استفاده از اطلاعات زیر نسبت می دهد.

  1. در کنسول Google Cloud، به صفحه پیکربندی Chat API بروید:

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

  2. در قسمت Application info اطلاعات زیر را وارد کنید:

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

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

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

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

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

chat/quickstart/Code.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. روی پروژه Untitled کلیک کنید، Quickstart را تایپ کنید و روی تغییر نام کلیک کنید.

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

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

  1. در کنسول Google Cloud، به منو > IAM & Admin > تنظیمات بروید.

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

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

Google Chat API را فعال کنید

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

chat/quickstart/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"
    }]
  }
}

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

در ویرایشگر Apps Script، روی Run کلیک کنید.

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

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

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

مراحل بعدی