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

يمكنك إنشاء نص برمجي في "برمجة تطبيقات Google" يرسل طلبات إلى Google Chat API.

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

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

الأهداف

  • إعداد البيئة
  • إنشاء النص البرمجي وإعداده
  • تشغيل النص البرمجي

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

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

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

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

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

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

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

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

تفعيل Chat API

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

    الانتقال إلى العلامة التجارية

  2. إذا سبق لك إعداد منصة Google للمصادقة، يمكنك إعداد إعدادات شاشة موافقة OAuth التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لك رسالة لم يتم إعداد منصة Google للمصادقة بعد، انقر على البدء:
    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 API Console، انتقِل إلى صفحة الإعدادات في 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. أنشِئ نصًا برمجيًا جديدًا في أداة تعديل النصوص البرمجية في "برمجة تطبيقات Google" من خلال الانتقال إلى 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) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. انقر على "حفظ" .
  2. انقر على مشروع بلا عنوان، ثم اكتب دليل البدء السريع وانقر على إعادة التسمية.

إعداد النص البرمجي

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

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

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

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

تفعيل Google Chat API

افتح مشروع "برمجة تطبيقات Google".

  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"
      }
    ]
  }
}

تشغيل النموذج

في محرِّر "برمجة تطبيقات Google"، انقر على تشغيل.

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

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

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

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