دليل سريع للبدء في Google Apps Script

أنشئ برنامج Google Apps Script يرسل طلبات إلى Google Chat API.

توضّح أدلة التشغيل السريع كيفية إعداد تطبيق وتشغيله، وهو تطبيق يستدعي إحدى واجهات Google Workspace API. يستخدم دليل البدء السريع هذا أسلوبًا مبسطًا للمصادقة مناسبًا لبيئة الاختبار. بالنسبة إلى بيئة الإنتاج، ننصحك بالتعرّف على المصادقة والتفويض قبل اختيار بيانات اعتماد الوصول المناسبة لتطبيقك.

في "برمجة التطبيقات"، تستخدم أدوات البدء السريع في Google Workspace خدمات Google المتقدّمة لاستدعاء واجهات برمجة التطبيقات في Google Workspace والتعامل مع بعض تفاصيل عملية المصادقة والتفويض.

الأهداف

  • ضبط البيئة
  • إنشاء النص البرمجي وإعداده
  • شغِّل النص البرمجي.

المتطلبات الأساسية

إعداد مشروعك على Google Cloud

إذا كنت تستخدم مشروعًا جديدًا على Google Cloud لإكمال هذا التشغيل السريع، عليك إعداده وإضافة نفسك كمستخدم اختباري. إذا سبق لك إكمال هذه الخطوات لمشروعك على السحابة الإلكترونية، انتقِل إلى القسم التالي.

افتح مشروعك على السحابة الإلكترونية في Google Cloud Console

افتح مشروع Cloud الذي تريد استخدامه لهذا النموذج إذا لم يكن مفتوحًا من قبل:

  1. في وحدة تحكّم Google Cloud، انتقِل إلى صفحة اختيار مشروع.

    اختيار مشروع على السحابة الإلكترونية

  2. اختَر مشروع Google Cloud الذي تريد استخدامه. يمكنك أيضًا النقر على إنشاء مشروع واتّباع التعليمات الظاهرة على الشاشة. في حال إنشاء مشروع على Google Cloud، قد تحتاج إلى تفعيل الفوترة للمشروع.

تفعيل Chat API

قبل استخدام واجهات Google APIs، عليك تفعيلها في مشروع على Google Cloud. يمكنك تفعيل واجهة برمجة تطبيق واحدة أو أكثر في مشروع واحد على Google Cloud.
  1. في "وحدة تحكّم Google Cloud"، انتقِل إلى "القائمة" > > تحديد هوية العلامة التجارية.

    الانتقال إلى "الهوية البصرية للعلامة التجارية"

  2. إذا سبق لك ضبط ، يمكنك ضبط إعدادات "شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth" التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لك الرسالة لم يتم الإعداد بعد، انقر على البدء:
    1. ضمن معلومات التطبيق، في اسم التطبيق، أدخِل اسمًا للتطبيق.
    2. في البريد الإلكتروني لدعم المستخدمين، اختَر عنوان بريد إلكتروني للدعم يمكن للمستخدمين التواصل معك من خلاله إذا كانت لديهم أسئلة حول موافقتهم.
    3. انقر على التالي.
    4. ضمن الجمهور، اختَر داخلي.
    5. انقر على التالي.
    6. ضمن معلومات الاتصال، أدخِل عنوان بريد إلكتروني يمكنك تلقّي إشعارات فيه بشأن أي تغييرات تطرأ على مشروعك.
    7. انقر على التالي.
    8. ضمن إنهاء، راجِع سياسة بيانات المستخدمين في خدمات Google API، وإذا كنت توافق عليها، ضَع علامة في المربّع بجانب أوافق على سياسة بيانات المستخدمين في خدمات Google API.
    9. انقر على متابعة.
    10. انقر على إنشاء.
  3. يمكنك حاليًا تخطّي إضافة النطاقات. في المستقبل، عند إنشاء تطبيق لاستخدامه خارج مؤسسة Google Workspace، عليك تغيير نوع المستخدم إلى خارجي. بعد ذلك، أضِف نطاقات التفويض التي يتطلّبها تطبيقك. لمزيد من المعلومات، يُرجى الاطّلاع على الدليل الكامل حول ضبط موافقة OAuth.

ضبط إعدادات تطبيق Google Chat

لاستدعاء Google Chat API، عليك ضبط تطبيق Google Chat. بالنسبة إلى أي طلبات كتابة، ينسب Google Chat تطبيق Google Chat في واجهة المستخدم باستخدام المعلومات التالية.

  1. في وحدة تحكّم Google Cloud، انتقِل إلى صفحة الإعداد الخاصة بواجهة Chat API:

    الانتقال إلى صفحة "إعدادات واجهة برمجة تطبيقات Chat"

  2. ضمن معلومات التطبيق، أدخِل المعلومات التالية:

    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. ضمن الميزات التفاعلية، انقر على زر التبديل تفعيل الميزات التفاعلية لإيقاف الميزات التفاعلية في تطبيق Chat.

  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. انقر على مشروع بلا عنوان، ثم اكتب البدء السريع، وانقر على إعادة تسمية.

ضبط النص البرمجي

نسخ رقم مشروع Cloud

  1. في Google Cloud Console، انتقِل إلى "القائمة" > المشرف وإدارة الهوية وإمكانية الوصول > الإعدادات.

    الانتقال إلى إعدادات "إدارة الهوية وإمكانية الوصول" والمشرف

  2. في حقل رقم المشروع، انسخ القيمة.
  1. افتح مشروع Apps Script.
  2. انقر على إعدادات المشروع .
  3. ضمن مشروع Google Cloud Platform (GCP)، انقر على تغيير المشروع.
  4. في رقم مشروع Google Cloud Platform، ألصِق رقم مشروع Google Cloud.
  5. انقر على تحديد المشروع.

تفعيل Google Chat API

افتح مشروع Apps Script.

  1. انقر على إعدادات المشروع .
  2. ضمن الإعدادات العامة، فعِّل الخيار عرض ملف البيان "appsscript.json" في المحرر.
  3. انقر على أداة التعديل ، واختَر الملف 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، انقر على تنفيذ.

في المرة الأولى التي تشغّل فيها العيّنة، سيُطلب منك منح الإذن بالوصول:

  1. انقر على مراجعة الأذونات.
  2. اختر حسابًا.
  3. انقر على سماح.

يظهر سجل تنفيذ النص البرمجي في أسفل النافذة.

الخطوات التالية