الردّ على الحوادث باستخدام Google Chat وVertex AI وبرمجة التطبيقات

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

الحادثة هي حدث يتطلّب انتباه فريق من الأشخاص بشكل فوري لحلّها. تشمل أمثلة الحوادث ما يلي:

• يتم إنشاء حالة حساسة للوقت في إدارة العلاقات مع العملاء (CRM) وتتطلب من فريق خدمة التعاون في إيجاد حل لها.
• انقطاع اتصال النظام بالإنترنت لتنبيه مجموعة من مهندسي موثوقية المواقع الإلكترونية (SRE) لكي تتمكّنوا من العمل معًا لإعادة عرضها على الإنترنت.
• حدث زلزال شديد، ويحتاج عمال الطوارئ إلى تنسيق استجابتهم.

لأغراض هذا الدليل التوجيهي، يبدأ تنبيه الحادثة عندما يُبلغ أحد الأشخاص عن الحادثة من خلال النقر على زر من صفحة ويب. تحاكي صفحة الويب لحادث من خلال مطالبة المستخدمين بإدخال معلومات أساسية عن الحادثة: العنوان، ووصفها وعناوين بريدها الإلكتروني للمجيبين.

إليك طريقة استخدام تطبيق Chat لإدارة الحوادث:

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

في حال الحاجة إلى تفعيل أي من هذه المتطلبات الأساسية لمؤسستك، اطلب لتفعيلها، يمكن لمشرف Google Workspace:

• نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى Google Chat
• تفعيل ميزة الدليل (مشاركة جهات الاتصال) في Google Workspace يستخدم تطبيق إدارة الحوادث directory للبحث عن معلومات الاتصال بمُستجيبي الحوادث، مثل الاسم وعنوان البريد الإلكتروني. يجب أن يكون المجيبون على الحوادث من مستخدمي تطبيق Google Chat. في مؤسسة Google Workspace.

الأهداف

• إنشاء تطبيق في Chat للاستجابة للحوادث
• ساعِد المستخدمين على التعامل مع الحوادث من خلال اتّباع الخطوات التالية:
  • إنشاء مساحات للاستجابة للحوادث
  • نشر رسائل تلخّص الحوادث والردود
  • إتاحة التعاون من خلال ميزات تفاعلية في تطبيق Chat
• تلخيص المحادثات والحلول باستخدام Vertex AI

البنية

يوضّح المخطّط البياني التالي بنية Google Workspace و موارد Google Cloud المستخدَمة من قِبل تطبيق Google Chat في الاستجابة للأحداث.

توضح البنية كيفية الاستجابة للحوادث يعالج تطبيق Google Chat إحدى الحوادث وحلولاً لها.

1. يبدأ أحد المستخدمين حادثة من موقع إلكتروني خارجي مستضاف على Apps Script.

2. يرسل الموقع الإلكتروني طلب HTTP غير متزامن إلى تطبيق Google Chat، مستضاف أيضًا على "برمجة التطبيقات".

3. يعالج تطبيق Google Chat للاستجابة للحوادث الطلب:

   1. تحصل خدمة SDK لمشرف "برمجة التطبيقات" على عضو في الفريق معلومات، مثل رقم تعريف المستخدم وعنوان البريد الإلكتروني.

   2. مع مجموعة من طلبات HTTP إلى Chat API باستخدام خدمة الدردشة المتقدّمة لبرمجة التطبيقات، الاستجابة للحادث واجه تطبيق Google Chat حادثة في Chat المساحة، وتعبئتها بأعضاء الفريق، وإرسال رسالة إلى المساحة.

4. يناقش أعضاء الفريق الحادث في "مساحة Chat".

5. يستدعي أحد أعضاء الفريق أمر الشرطة المائلة للإشارة إلى حل الحادث.

   1. طلب HTTP إلى Chat API باستخدام "برمجة تطبيقات Google" تسرد خدمة الدردشة المتقدمة جميع ميزات Chat رسائل المساحة.

   2. يتلقّى Vertex AI الرسائل المُدرجة وينشئ ملخّصًا.

   3. تنشئ خدمة "برمجة تطبيقات Google" DocumentApp إضافة ملخص Vertex AI إلى جلسة المراجعة.

   4. يُطلِق تطبيق Google Chat المخصّص للتعامل مع الحوادث واجهة برمجة التطبيقات Chat API لإرسال رسالة تتضمّن رابطًا يؤدي إلى الملخّص في مستند مستندات Google.

تحضير البيئة

يعرض هذا القسم كيفية إنشاء مشروع على Google Cloud وإعداده من أجل تطبيق Chat

إنشاء مشروع على Google Cloud

وحدة تحكُّم Google Cloud

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

   الانتقال إلى "إنشاء مشروع"

2. في حقل اسم المشروع، أدخِل اسمًا وصفيًا لمشروعك.

   اختياري: لتعديل رقم تعريف المشروع، انقر على تعديل. لا يمكن تغيير معرّف المشروع بعد إنشائه، لذا اختَر معرّفًا يلبي احتياجاتك طوال مدّة المشروع.

3. في حقل الموقع الجغرافي، انقر على تصفّح لعرض المواقع الجغرافية المحتمَلة. مشروعك. بعد ذلك، انقر على اختيار.
4. انقر على إنشاء. تنتقل وحدة تحكّم Google Cloud إلى صفحة "لوحة البيانات" ويتم إنشاء مشروعك في غضون بضع دقائق.

gcloud CLI

في إحدى بيئات التطوير التالية، يمكنك الوصول إلى Google Cloud CLI (gcloud):

• Cloud Shell: لاستخدام وحدة طرفية على الإنترنت تم إعداد واجهة سطر أوامر gcloud CLI عليها، فعِّل Cloud Shell.
  تفعيل Cloud Shell
• Local Shell: لاستخدام بيئة تطوير محلية، تثبيت الإعداد واجهة سطر الأوامر gcloud.
  لإنشاء مشروع على السحابة الإلكترونية، استخدِم الأمر gcloud projects create:

  gcloud projects create PROJECT_ID

  استبدِل PROJECT_ID بتحديد رقم تعريف المشروع الذي تريد إنشاؤه.

تفعيل الفوترة لمشروع Cloud

وحدة التحكّم في Google Cloud

1. في Google Cloud Console، انتقِل إلى الفوترة. (يُرجى النقر.) قائمة الطعام menu > الفوترة > مشاريعي.

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

2. في القسم اختيار مؤسسة، اختَر المؤسسة المرتبطة مشروعك على Google Cloud
3. في صف المشروع، افتح قائمة الإجراءات. (more_vert), انقر على تغيير الفوترة، واختر حساب فوترة Cloud.
4. انقر على ضبط الحساب.

واجهة سطر الأوامر gcloud

1. لعرض حسابات الفوترة المتاحة، يمكنك تنفيذ ما يلي:

   gcloud billing accounts list

2. ربط حساب فوترة بمشروع على Google Cloud:

   gcloud billing projects link PROJECT_ID --billing-account=BILLING_ACCOUNT_ID

   استبدِل ما يلي:

   • PROJECT_ID هو رقم تعريف المشروع المشروع على السحابة الإلكترونية الذي تريد تفعيل الفوترة له
   • BILLING_ACCOUNT_ID هو رقم تعريف حساب الفوترة المطلوب الربط به. لمشروع Google Cloud.

تفعيل واجهات برمجة التطبيقات

إعداد المصادقة والتفويض

تتيح المصادقة والترخيص لـ مراجع حول الوصول إلى تطبيقات Chat في Google Workspace Google Cloud لمعالجة أي حادثة.

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

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

   الانتقال إلى شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

2. ضمن نوع المستخدم، اختَر داخلي، ثم انقر على إنشاء.

3. في اسم التطبيق، اكتب Incident Management.

4. في عنوان البريد الإلكتروني لفريق دعم المستخدمين، اختَر عنوان بريدك الإلكتروني أو مجموعة مناسبة في Google.

5. ضمن معلومات الاتصال بالمطوِّر، أدخِل عنوان بريدك الإلكتروني.

6. انقر على حفظ ومتابعة.

7. انقر على إضافة نطاقات أو إزالتها. تظهر لوحة تحتوي على قائمة بالنطاقات لكل واجهة برمجة تطبيقات فعَّلتها في مشروعك على Google Cloud.

8. ضمن إضافة النطاقات يدويًا، الصِق النطاقات التالية:

   • https://www.googleapis.com/auth/chat.spaces.create
   • https://www.googleapis.com/auth/chat.memberships
   • https://www.googleapis.com/auth/chat.memberships.app
   • https://www.googleapis.com/auth/chat.messages
   • https://www.googleapis.com/auth/documents
   • https://www.googleapis.com/auth/admin.directory.user.readonly
   • https://www.googleapis.com/auth/script.external_request
   • https://www.googleapis.com/auth/userinfo.email
   • https://www.googleapis.com/auth/cloud-platform

9. انقر على الإضافة إلى الجدول.

10. انقر على تعديل.

11. انقر على حفظ ومتابعة.

12. راجِع ملخّص تسجيل التطبيق، ثم انقر على الرجوع إلى لوحة البيانات.

إنشاء تطبيق Chat ونشره

في القسم التالي، ستنسخ وتُعدِّل مشروعًا كاملاً من "برمجة تطبيقات Google" يحتوي على كل رمز التطبيق المطلوب لتطبيق Chat، لذا لن يكون عليك نسخ كل ملف ولصقه.

تتضمّن بعض الدوالّ شرطة سفلية في نهاية أسمائها، مثل processSlashCommand_() من ChatApp.gs. تخفي الشرطة السفلية الدالة من صفحة الويب الخاصة بتهيئة الحادث عندما تكون مفتوحة في متصفّح. لمزيد من المعلومات، المعلومات، راجع الوظائف الخاصة:

تتوافق خدمة Apps Script مع نوعَي ملفَين، وهما .gs النصوص البرمجية و.html الملفات. للالتزام بهذا الدعم، يتم تضمين JavaScript من جهة العميل للتطبيق. داخل علامات <script /> ويتم تضمين خدمة مقارنة الأسعار (CSS) الخاصة به داخل علامات <style /> ملف HTML.

يمكنك اختياريًا عرض المشروع بأكمله على GitHub.

عرض على GitHub

في ما يلي نظرة عامة على كل ملف:

Consts.gs

تحدِّد هذه السمة الثوابت التي تشير إليها ملفات الرموز البرمجية الأخرى، بما في ذلك معرّف مشروعك على Cloud ومعرّف الموقع الجغرافي في Vertex AI ومعرّف الأمر المزوّد بشرطة لغلق حادثة.

عرض رمز Consts.gs

apps-script/incident-response/Consts.gs

عرض على GitHub

const PROJECT_ID = 'replace-with-your-project-id';
const VERTEX_AI_LOCATION_ID = 'us-central1';
const CLOSE_INCIDENT_COMMAND_ID = 1;

ChatApp.gs

تعالج أحداث التفاعل في Chat، بما في ذلك الرسائل والنقرات على البطاقات وأوامر الشرطة المائلة والمحادثات. الاستجابة لأمر الشرطة المائلة /closeIncident من خلال فتح مربّع حوار لجمع تفاصيل حلّ الحادثة تقرأ الرسائل في المساحة من خلال استدعاء الأسلوب spaces.messages.list في Chat API. الحصول على أرقام تعريف المستخدمين باستخدام خدمة "دليل SDK للمشرف" في برمجة التطبيقات.

عرض رمز ChatApp.gs

apps-script/incident-response/ChatApp.gs

العرض على GitHub

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * This app only responds to a slash command with the ID 1 ("/closeIncident").
 * It will respond to any other message with a simple "Hello" text message.
 *
 * @param {Object} event the event object from Google Chat
 */
function onMessage(event) {
  if (event.message.slashCommand) {
    return processSlashCommand_(event);
  }
  return { "text": "Hello from Incident Response app!" };
}

/**
 * Responds to a CARD_CLICKED event in Google Chat.
 *
 * This app only responds to one kind of dialog (Close Incident).
 *
 * @param {Object} event the event object from Google Chat
 */
function onCardClick(event) {
  if (event.isDialogEvent) {
    if (event.dialogEventType == 'SUBMIT_DIALOG') {
      return processSubmitDialog_(event);
    }
    return {
      actionResponse: {
        type: "DIALOG",
        dialogAction: {
          actionStatus: "OK"
        }
      }
    };
  }
}

/**
 * Responds to a MESSAGE event with a Slash command in Google Chat.
 *
 * This app only responds to a slash command with the ID 1 ("/closeIncident")
 * by returning a Dialog.
 *
 * @param {Object} event the event object from Google Chat
 */
function processSlashCommand_(event) {
  if (event.message.slashCommand.commandId != CLOSE_INCIDENT_COMMAND_ID) {
    return {
      "text": "Command not recognized. Use the command `/closeIncident` to close the incident managed by this space."
    };
  }
  const sections = [
    {
      header: "Close Incident",
      widgets: [
        {
          textInput: {
            label: "Please describe the incident resolution",
            type: "MULTIPLE_LINE",
            name: "description"
          }
        },
        {
          buttonList: {
            buttons: [
              {
                text: "Close Incident",
                onClick: {
                  action: {
                    function: "closeIncident"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ];
  return {
    actionResponse: {
      type: "DIALOG",
      dialogAction: {
        dialog: {
          body: {
            sections,
          }
        }
      }
    }
  };
}

/**
 * Responds to a CARD_CLICKED event with a Dialog submission in Google Chat.
 *
 * This app only responds to one kind of dialog (Close Incident).
 * It creates a Doc with a summary of the incident information and posts a message
 * to the space with a link to the Doc.
 *
 * @param {Object} event the event object from Google Chat
 */
function processSubmitDialog_(event) {
  const resolution = event.common.formInputs.description[""].stringInputs.value[0];
  const chatHistory = concatenateAllSpaceMessages_(event.space.name);
  const chatSummary = summarizeChatHistory_(chatHistory);
  const docUrl = createDoc_(event.space.displayName, resolution, chatHistory, chatSummary);
  return {
    actionResponse: {
      type: "NEW_MESSAGE",
    },
    text: `Incident closed with the following resolution: ${resolution}\n\nHere is the automatically generated post-mortem:\n${docUrl}`
  };
}

/**
 * Lists all the messages in the Chat space, then concatenate all of them into
 * a single text containing the full Chat history.
 *
 * For simplicity for this demo, it only fetches the first 100 messages.
 *
 * Messages with slash commands are filtered out, so the returned history will
 * contain only the conversations between users and not app command invocations.
 *
 * @return {string} a text containing all the messages in the space in the format:
 *          Sender's name: Message
 */
function concatenateAllSpaceMessages_(spaceName) {
  // Call Chat API method spaces.messages.list
  const response = Chat.Spaces.Messages.list(spaceName, { 'pageSize': 100 });
  const messages = response.messages;
  // Fetch the display names of the message senders and returns a text
  // concatenating all the messages.
  let userMap = new Map();
  return messages
    .filter(message => message.slashCommand === undefined)
    .map(message => `${getUserDisplayName_(userMap, message.sender.name)}: ${message.text}`)
    .join('\n');
}

/**
 * Obtains the display name of a user by using the Admin Directory API.
 *
 * The fetched display name is cached in the provided map, so we only call the API
 * once per user.
 *
 * If the user does not have a display name, then the full name is used.
 *
 * @param {Map} userMap a map containing the display names previously fetched
 * @param {string} userName the resource name of the user
 * @return {string} the user's display name
 */
function getUserDisplayName_(userMap, userName) {
  if (userMap.has(userName)) {
    return userMap.get(userName);
  }
  let displayName = 'Unknown User';
  try {
    const user = AdminDirectory.Users.get(
      userName.replace("users/", ""),
      { projection: 'BASIC', viewType: 'domain_public' });
    displayName = user.name.displayName ? user.name.displayName : user.name.fullName;
  } catch (e) {
    // Ignore error if the API call fails (for example, because it's an
    // out-of-domain user or Chat app)) and just use 'Unknown User'.
  }
  userMap.set(userName, displayName);
  return displayName;
}

ChatSpaceCreator.gs

تلقي بيانات النموذج التي يدخلها المستخدمون حول الحادث صفحة الويب الخاصة بالتهيئة وتستخدمها لإعداد Chat من خلال إنشائها وملؤها، ثم نشر رسالة حول الحادث.

عرض رمز ChatSpaceCreator.gs

apps-script/incident-response/ChatSpaceCreator.gs

عرض على GitHub

/**
 * Creates a space in Google Chat with the provided title and members, and posts an
 * initial message to it.
 *
 * @param {Object} formData the data submitted by the user. It should contain the fields
 *                          title, description, and users.
 * @return {string} the resource name of the new space.
 */
function createChatSpace(formData) {
  const users = formData.users.trim().length > 0 ? formData.users.split(',') : [];
  const spaceName = setUpSpace_(formData.title, users);
  addAppToSpace_(spaceName);
  createMessage_(spaceName, formData.description);
  return spaceName;
}

/**
 * Creates a space in Google Chat with the provided display name and members.
 *
 * @return {string} the resource name of the new space.
 */
function setUpSpace_(displayName, users) {
  const memberships = users.map(email => ({
    member: {
      name: `users/${email}`,
      type: "HUMAN"
    }
  }));
  const request = {
    space: {
      displayName: displayName,
      spaceType: "SPACE",
      externalUserAllowed: true
    },
    memberships: memberships
  };
  // Call Chat API method spaces.setup
  const space = Chat.Spaces.setup(request);
  return space.name;
}

/**
 * Adds this Chat app to the space.
 *
 * @return {string} the resource name of the new membership.
 */
function addAppToSpace_(spaceName) {
  const request = {
    member: {
      name: "users/app",
      type: "BOT"
    }
  };
  // Call Chat API method spaces.members.create
  const membership = Chat.Spaces.Members.create(request, spaceName);
  return membership.name;
}

/**
 * Posts a text message to the space on behalf of the user.
 *
 * @return {string} the resource name of the new message.
 */
function createMessage_(spaceName, text) {
  const request = {
    text: text
  };
  // Call Chat API method spaces.messages.create
  const message = Chat.Spaces.Messages.create(request, spaceName);
  return message.name;
}

DocsApi.gs

تستدعي واجهة برمجة تطبيقات "مستندات Google" لإنشاء مستند "مستندات Google" في حساب VertexAiApi.gs على Google Drive، وتُسجِّل ملخّصًا لمعلومات الحادثة التي تم إنشاؤها في VertexAiApi.gs في المستند.

عرض رمز DocsApi.gs

apps-script/incident-response/DocsApi.gs

عرض على GitHub

/**
 * Creates a Doc in the user's Google Drive and writes a summary of the incident information to it.
 *
 * @param {string} title The title of the incident
 * @param {string} resolution Incident resolution described by the user
 * @param {string} chatHistory The whole Chat history be included in the document
 * @param {string} chatSummary A summary of the Chat conversation to be included in the document
 * @return {string} the URL of the created Doc
 */
function createDoc_(title, resolution, chatHistory, chatSummary) {
  let doc = DocumentApp.create(title);
  let body = doc.getBody();
  body.appendParagraph(`Post-Mortem: ${title}`).setHeading(DocumentApp.ParagraphHeading.TITLE);
  body.appendParagraph("Resolution").setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(resolution);
  body.appendParagraph("Summary of the conversation").setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(chatSummary);
  body.appendParagraph("Full Chat history").setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(chatHistory);
  return doc.getUrl();
}

VertexAiApi.gs

تلخيص المحادثة في مساحة Chat باستخدام Vertex AI تم نشر هذا الملخص في ملف تم إنشاؤه بشكل خاص مستند في DocsAPI.gs.

عرض رمز VertexAiApi.gs

apps-script/incident-response/VertexAiApi.gs

عرض على GitHub

/**
 * Summarizes a Chat conversation using the Vertex AI text prediction API.
 *
 * @param {string} chatHistory The Chat history that will be summarized.
 * @return {string} The content from the text prediction response.
 */
function summarizeChatHistory_(chatHistory) {
  const prompt =
    "Summarize the following conversation between Engineers resolving an incident"
      + " in a few sentences. Use only the information from the conversation.\n\n"
      + chatHistory;
  const request = {
    instances: [
      { prompt: prompt }
    ],
    parameters: {
      temperature: 0.2,
      maxOutputTokens: 256,
      topK: 40,
      topP: 0.95
    }
  }
  const fetchOptions = {
    method: 'POST',
    headers: { Authorization: 'Bearer ' + ScriptApp.getOAuthToken() },
    contentType: 'application/json',
    payload: JSON.stringify(request)
  }
  const response = UrlFetchApp.fetch(
    `https://${VERTEX_AI_LOCATION_ID}-aiplatform.googleapis.com/v1`
      + `/projects/${PROJECT_ID}/locations/${VERTEX_AI_LOCATION_ID}`
      + "/publishers/google/models/text-bison:predict",
    fetchOptions);
  const payload = JSON.parse(response.getContentText());
  return payload.predictions[0].content;
}

WebController.gs

يعرض الموقع الإلكتروني لبدء الحدث.

عرض رمز WebController.gs

apps-script/incident-response/WebController.gs

عرض على GitHub

/**
 * Serves the web page from Index.html.
 */
function doGet() {
  return HtmlService
    .createTemplateFromFile('Index')
    .evaluate();
}

/**
 * Serves the web content from the specified filename.
 */
function include(filename) {
  return HtmlService
    .createHtmlOutputFromFile(filename)
    .getContent();
}

/**
 * Returns the email address of the user running the script.
 */
function getUserEmail() {
  return Session.getActiveUser().getEmail();
}

Index.html

محتوى HTML الذي يتألف من الموقع الإلكتروني الخاص بتهيئة الحادثة

عرض رمز Index.html

apps-script/incident-response/Index.html

عرض على GitHub

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <link href='https://fonts.googleapis.com/css?family=Roboto' rel='stylesheet'>
    <?!= include('Stylesheet'); ?>
  </head>
  <body>
    <div class="container">
      <div class="content">
        <h1>Incident Manager</h1>
        <form id="incident-form" onsubmit="handleFormSubmit(this)">
          <div id="form">
            <p>
              <label for="title">Incident title</label><br/>
              <input type="text" name="title" id="title" />
            </p>
            <p>
              <label for="users">Incident responders</label><br/>
              <small>
                Please enter a comma-separated list of email addresses of the users
                that should be added to the space.
                Do not include <?= getUserEmail() ?> as it will be added automatically.
              </small><br/>
              <input type="text" name="users" id="users" />
            </p>
            <p>
              <label for="description">Initial message</label></br>
              <small>This message will be posted after the space is created.</small><br/>
              <textarea name="description" id="description"></textarea>
            </p>
            <p class="text-center">
              <input type="submit" value="CREATE CHAT SPACE" />
            </p>
          </div>
          <div id="output" class="hidden"></div>
          <div id="clear" class="hidden">
            <input type="reset" value="CREATE ANOTHER INCIDENT" onclick="onReset()" />
          </div>
        </form>
      </div>
    </div>
    <?!= include('JavaScript'); ?>
  </body>
</html>

JavaScript.html

تعالج سلوك النموذج، بما في ذلك عمليات الإرسال والأخطاء والمحو، لموقع الويب الذي يُجري عملية إعداد الحادثة. مضمَّن إلى Index.html بواسطة الدالة include المخصصة في WebController.gs.

عرض رمز JavaScript.html

apps-script/incident-response/JavaScript.html

عرض على GitHub

<script>
  var formDiv = document.getElementById('form');
  var outputDiv = document.getElementById('output');
  var clearDiv = document.getElementById('clear');

  function handleFormSubmit(formObject) {
    event.preventDefault();
    outputDiv.innerHTML = 'Please wait while we create the space...';
    hide(formDiv);
    show(outputDiv);
    google.script.run
      .withSuccessHandler(updateOutput)
      .withFailureHandler(onFailure)
      .createChatSpace(formObject);
  }

  function updateOutput(response) {
    var spaceId = response.replace('spaces/', '');
    outputDiv.innerHTML =
      '<p>Space created!</p><p><a href="https://mail.google.com/chat/#chat/space/'
        + spaceId
        + '" target="_blank">Open space</a></p>';
    show(outputDiv);
    show(clearDiv);
  }

  function onFailure(error) {
    outputDiv.innerHTML = 'ERROR: ' + error.message;
    outputDiv.classList.add('error');
    show(outputDiv);
    show(clearDiv);
  }

  function onReset() {
    outputDiv.innerHTML = '';
    outputDiv.classList.remove('error');
    show(formDiv);
    hide(outputDiv);
    hide(clearDiv);
  }

  function hide(element) {
    element.classList.add('hidden');
  }

  function show(element) {
    element.classList.remove('hidden');
  }
</script>

Stylesheet.html

خدمة CSS لموقع الويب الذي يُستخدَم لبدء الحادث من المهم تم تضمينه في Index.html من خلال الدالة include المخصصة في WebController.gs

عرض رمز Stylesheet.html

apps-script/incident-response/Stylesheet.html

العرض على GitHub

<style>
  * {
    box-sizing: border-box;
  }
  body {
    font-family: Roboto, Arial, Helvetica, sans-serif;
  }
  div.container {
    display: flex;
    justify-content: center;
    align-items: center;
    position: absolute;
    top: 0; bottom: 0; left: 0; right: 0;
  }
  div.content {
    width: 80%;
    max-width: 1000px;
    padding: 1rem;
    border: 1px solid #999;
    border-radius: 0.25rem;
    box-shadow: 0 2px 2px 0 rgba(66, 66, 66, 0.08), 0 2px 4px 2px rgba(66, 66, 66, 0.16);
  }
  h1 {
    text-align: center;
    padding-bottom: 1rem;
    margin: 0 -1rem 1rem -1rem;
    border-bottom: 1px solid #999;
  }
 #output {
    text-align: center;
    min-height: 250px;
  }
  div#clear {
    text-align: center;
    padding-top: 1rem;
    margin: 1rem -1rem 0 -1rem;
    border-top: 1px solid #999;
  }
  input[type=text], textarea {
    width: 100%;
    padding: 1rem 0.5rem;
    margin: 0.5rem 0;
    border: 0;
    border-bottom: 1px solid #999;
    background-color: #f0f0f0;
  }
  textarea {
    height: 5rem;
  }
  small {
    color: #999;
  }
  input[type=submit], input[type=reset] {
    padding: 1rem;
    border: none;
    background-color: #6200ee;
    color: #fff;
    border-radius: 0.25rem;
    width: 25%;
  }
  .hidden {
    display: none;
  }
  .text-center {
    text-align: center;
  }
  .error {
    color: red;
  }
</style>

العثور على رقم وتعريف مشروعك على Cloud

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

   الانتقال إلى وحدة التحكّم في Google Cloud

2. انقر على "الإعدادات والأدوات" more_vert > إعدادات المشروع.

3. دوِّن القيم في حقلَي رقم المشروع ورقم تعريف المشروع. ويمكنك استخدامها في الأقسام التالية.

إنشاء مشروع "برمجة تطبيقات Google"

لإنشاء مشروع على Apps Script وربطه بمشروعك على Cloud:

1. انقر على الزر التالي لفتح مشروع Apps Script الردّ على الحوادث باستخدام Google Chat.
   فتح المشروع
2. انقر على رمز info_outline نظرة عامة.
3. في صفحة النظرة العامة، انقر على إنشاء نسخة.

4. تسمية نسختك من مشروع برمجة التطبيقات:

   1. انقر على نسخة من الردّ على الحوادث باستخدام Google Chat.

   2. في عنوان المشروع، اكتب Incident Management Chat app.

   3. انقر على إعادة تسمية.

5. في نسختك من مشروع Apps Script، انتقِل إلى ملف Consts.gs واستبدِل YOUR_PROJECT_ID بمعرّف مشروعك على Cloud.

ضبط مشروع Cloud لمشروع "برمجة التطبيقات"

1. في مشروعك على Apps Script، انقر على إعدادات المشروع.
2. ضمن مشروع Google Cloud Platform (GCP)، انقر على تغيير المشروع.
3. في رقم مشروع Google Cloud Platform، الصِق رقم مشروعك على Cloud.
4. انقر على ضبط المشروع. تم ربط مشروع Cloud بمشروع Apps Script .

إنشاء عملية نشر "برمجة تطبيقات Google"

الآن وبعد أن أصبحت جميع الرموز في مكانها الصحيح، انشر النص البرمجي لـ Apps مشروعك. يمكنك استخدام معرّف النشر عند ضبط تطبيق Chat في Google Cloud.

1. في Apps Script، افتح مشروع تطبيق الاستجابة للطوارئ.

   الانتقال إلى Apps Script

2. انقر على نشر > عملية نشر جديدة:

3. إذا لم يتم اختيار إضافة وتطبيق ويب، انقر على رمز أنواع عمليات النشر بجانب اختيار النوع واختَر إضافة وتطبيق ويب.

4. في الوصف، أدخِل وصفًا لهذا الإصدار، مثل Complete version of incident management app

5. في تنفيذ باسم، اختَر مستخدم يصل إلى تطبيق الويب.

6. في القسم من لديه إذن الوصول، اختَر أي شخص داخل مؤسستك على Workspace، حيث تظهر عبارة "مؤسستك على Workspace" هو اسم Google Workspace.

7. انقر على نشر. تم بنجاح إعداد تقارير "برمجة تطبيقات Google" النشر وتوفير رقم تعريف نشر وعنوان URL للحادثة صفحة الويب الخاصة بالتهيئة.

8. دوِّن عنوان URL لتطبيق الويب للرجوع إليه لاحقًا عند بدء حادثة. انسخ رقم تعريف النشر. يتم استخدام هذا المعرّف أثناء ضبط تطبيق Chat في Google Cloud Console.

9. انقر على تم.

ضبط تطبيق Chat في وحدة تحكّم Google Cloud

يعرض هذا القسم كيفية ضبط Google Chat API في وحدة تحكّم Google Cloud. بمعلومات عن تطبيق Chat، بما في ذلك رقم تعريف عملية النشر التي أنشأتها للتو من "برمجة تطبيقات Google" مشروعك.

1. في وحدة تحكُّم Google Cloud، انقر على القائمة menu > مزيد من المنتجات > Google Workspace > مكتبة المنتجات > Google Chat API > إدارة > الإعداد.

   الانتقال إلى إعدادات Chat API

2. في اسم التطبيق، اكتب Incident Management.

3. في عنوان URL للصورة الرمزية، اكتب https://developers.google.com/chat/images/quickstart-app-avatar.png.

4. في الوصف، اكتب Responds to incidents..

5. انقر على مفتاح التبديل تفعيل الميزات التفاعلية لتفعيله.

6. ضمن الوظائف، اختَر تلقّي الرسائل بين شخصين، الانضمام إلى المساحات والمحادثات الجماعية.

7. ضمن إعدادات الاتصال، اختَر Apps Script.

8. في رقم تعريف النشر، الصِق رقم تعريف نشر برمجة التطبيقات الذي نسخته سابقًا من مشروع "برمجة التطبيقات" النشر.

9. سجِّل أمرًا شرطة مائلة تريد يستخدم تطبيق Chat الذي تم تنفيذه بالكامل ما يلي:

   1. ضمن أوامر الشرطة المائلة، انقر على إضافة أمر شرطة مائلة.

   2. في الاسم، اكتب /closeIncident.

   3. في رقم تعريف الطلب، اكتب 1.

   4. في الوصف، اكتب Closes the incident being discussed in the space.

   5. اختَر فتح مربّع حوار.

   6. انقر على تم. تم تسجيل أمر الشرطة المائلة وإدراجه.

10. ضمن مستوى الرؤية، اختَر إتاحة تطبيق Chat هذا لمستخدمين ومجموعات محدّدين في نطاق Workspace وأدخِل عنوان بريدك الإلكتروني.

11. ضمن السجلات، اختَر تسجيل الأخطاء في التسجيل.

12. انقر على حفظ. تظهر رسالة محفوظة للإعدادات، ما يعني أن التطبيق وجاهزة للاختبار.

اختبار تطبيق Chat

لاختبار تطبيق Chat لإدارة الحوادث، ابدأ حادثة من صفحة الويب وتأكَّد من أنّ تطبيق Chat يعمل على النحو المتوقّع:

1. انتقِل إلى عنوان URL لتطبيق الويب الذي تم تفعيل برمجة Apps Script فيه.

2. عندما تطلب منك أداة Apps Script الحصول على إذن بالوصول إلى بياناتك، انقر على مراجعة الأذونات وسجِّل الدخول باستخدام حساب Google مناسب في نطاق Google Workspace، ثم انقر على سماح.

3. يتم فتح صفحة الويب الخاصة بتهيئة الحادثة. أدخِل معلومات الاختبار:

   1. في عنوان المشكلة، اكتب The First Incident.
   2. اختياريًا، في المتعاملون مع الحوادث، أدخِل عناوين البريد الإلكتروني ل مساعديك في التعامل مع الحوادث. يجب أن يكونوا مستخدمين لديهم حساب على Google Chat في مؤسستك على Google Workspace، وإلا لن يتم إنشاء المساحة. لا تُدخِل عنوان بريدك الإلكتروني لأنّه يتم تضمينه تلقائيًا.
   3. في الرسالة الأولية، اكتب Testing the incident management Chat app..

4. انقر على إنشاء مساحة Chat. ستظهر رسالة creating space.

5. بعد إنشاء المساحة، تظهر رسالة Space created!. انقر على فتح المساحة، ما يؤدي إلى فتح المساحة في Chat في علامة تبويب جديدة.

6. يمكنك أنت والمستجيبون الآخرون للحادث إرسال رسائل في المساح. ويلخِّص التطبيق هذه الرسائل باستخدام Vertex AI ويشارك مستندًا يتضمّن نظرة على الماضي.

7. لإنهاء الاستجابة للحادثة وبدء عملية الحل، يُرجى كتابة /closeIncident في مساحة المحادثة. إدارة الحوادث يفتح مربع حوار

8. في إغلاق المشكلة، أدخِل وصفًا لحلّ المشكلة، مثل Test complete.

9. انقر على إغلاق المشكلة.

يُدرج تطبيق "إدارة الحوادث" الرسائل في المساحة ويلخّصها باستخدام Vertex AI، ثم يلصق الملخّص في مستند "مستندات Google" ويشاركه في المساحة.

تَنظيم

لتجنُّب تحمُّل رسوم على حسابك على Google Cloud مقابل موارد المستخدَمة في هذا الدليل التعليمي، ننصحك بحذف مشروع Cloud.

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

   الانتقال إلى "مدير الموارد"

2. في قائمة المشاريع، اختَر المشروع الذي تريد حذفه ثم انقر على حذف delete.
3. في مربّع الحوار، اكتب رقم تعريف المشروع ثم انقر على إيقاف التشغيل لحذفه. للمشروع.

مواضيع ذات صلة

• الإجابة عن الأسئلة استنادًا إلى محادثات Chat باستخدام تطبيق Gemini Chat المستنِد إلى الذكاء الاصطناعي
• إدارة المشاريع باستخدام Google Chat وVertex AI وFirestore
• يُجري تطبيق الاستجابة للطوارئ مصادقة باستخدام بيانات اعتماد المستخدم للاتصال بواجهات برمجة التطبيقات واستخدام خدمات Google Cloud، مثل Chat API وVertex AI API. وهذا يعني أنّ المستخدم الذي يُنشئ حادثة يجب أن يكون لديه إذن بالوصول إلى هذين الخدمات. لجعل التطبيق أكثر أمانًا، ننصحك باستخدام حساب الخدمة بدلاً من بيانات اعتماد المستخدم عند استدعاء واجهة برمجة التطبيقات Vertex AI API باستخدام /closeIncident. للحصول على مساعدة في إعداد حساب خدمة عن theVertex AI API، يُرجى الاطّلاع على استخدام حساب خدمة مخصّص