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

توضّح عمليات البدء السريع كيفية إعداد تطبيق يستدعي واجهة برمجة التطبيقات Google Workspace API وتشغيله.

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

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

الأهداف

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

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

ضبط إعدادات مشروعك على Cloud

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

فتح مشروعك على Cloud في Google Cloud Console

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

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

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

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

تفعيل Chat API

قبل استخدام واجهات برمجة تطبيقات Google، عليك تفعيلها في مشروع على 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 API

  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

  1. افتح مشروع 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. انقر على سماح.

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

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