إجراءات التقويم

تتيح لك عناصر Action إنشاء سلوك تفاعلي في إضافات Google Workspace. وتحدِّد هذه الإجراءات ما يحدث عندما يتفاعل المستخدِم مع تطبيق مصغّر (مثل زر) في واجهة مستخدم الإضافة.

يتم إرفاق إجراء بتطبيق مصغّر معيّن باستخدام دالة معالِج التطبيق المصغّر، التي تحدِّد أيضًا الشرط الذي يؤدي إلى تنفيذ الإجراء. عند بدء الإجراء، ينفذ الإجراء دالة ردّ اتصال محدّدة. يتمّ تمرير عنصر حدث يحمل معلومات عن تفاعلات المستخدِم من جهة العميل إلى الدالة المخصّصة للردّ. يجب تنفيذ دالة callback وجعلها تعرِض عنصر استجابة محدّدًا.

على سبيل المثال، لنفترض أنّك تريد زرًا ينشئ بطاقة جديدة ويعرضها عند النقر عليه. ولإجراء ذلك، عليك إنشاء تطبيق مصغّر جديد للزر واستخدام دالّة معالج تطبيق مصغّر الزر setOnClickAction(action) لضبط Action لإنشاء البطاقات. إنّ القيمة التي تحدّدها لسمة Action تحدّد دالة ردّ اتصال في Apps Script يتم تنفيذها عند النقر على الزر. في هذه الحالة، يمكنك تنفيذ دالة ردّ الاتصال لإنشاء البطاقة التي تريدها وعرض عنصر ActionResponse. يطلب عنصر الاستجابة من الإضافة عرض البطاقة التي أنشأتها دالة callback.

توضّح هذه الصفحة إجراءات التطبيقات المصغّرة الخاصة بتطبيق "تقويم Google" التي يمكنك تضمينها في إضافة.

التفاعلات مع التقويم

يمكن أن تتضمّن إضافات Google Workspace التي توفّر ميزات إضافية في "تقويم Google" بعض إجراءات التطبيقات المصغّرة الإضافية الخاصة بـ "تقويم Google". تتطلّب هذه الإجراءات دالة ردّ الاتصال الخاصة بالإجراء المرتبط بها لإرجاع عناصر استجابة متخصّصة:

الإجراء الذي تمّت محاولة تنفيذه	يجب أن تُرجع دالّة ردّ الاتصال
إضافة ضيوف	CalendarEventActionResponse
ضبط بيانات المؤتمر	CalendarEventActionResponse
إضافة مرفقات	CalendarEventActionResponse

للاستفادة من إجراءات التطبيقات المصغّرة وعناصر الاستجابة هذه، يجب أن يكون كل ما يلي صحيحًا:

• يتم بدء الإجراء عندما يكون لدى المستخدم حدث تقويم مفتوحًا.
• تم ضبط حقل بيان addOns.calendar.currentEventAccess الإضافة على WRITE أو READ_WRITE.
• تتضمّن الإضافة https://www.googleapis.com/auth/calendar.addons.current.event.write نطاق التقويم.

بالإضافة إلى ذلك، لا يتم حفظ أي تغييرات أجرتها وظيفة الاستدعاء للإجراءات إلى أن يحفظ المستخدم حدث "تقويم Google".

إضافة ضيوف باستخدام دالة طلب معاودة الاتصال

يوضّح المثال التالي كيفية إنشاء زر يضيف مدعوين معيّنين إلى حدث في "تقويم Google" يتم تعديله:

  /**
   * Build a simple card with a button that sends a notification.
   * This function is called as part of the eventOpenTrigger that builds
   * a UI when the user opens an event.
   *
   * @param e The event object passed to eventOpenTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onAddAttendeesButtonClicked');
    var button = CardService.newTextButton()
        .setText('Add new attendee')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can add
    // attendees and disable the button if not.
    if (!e.calendar.capabilities.canAddAttendees) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Adds attendees to the
   * Calendar event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onAddAttendeesButtonClicked (e) {
    return CardService.newCalendarEventActionResponseBuilder()
        .addAttendees(["[e-mail]", "[e-mail]"])
        .build();
  }

ضبط بيانات المكالمة الجماعية باستخدام دالة معاودة الاتصال

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

يوضّح المثال التالي كيفية إنشاء زرّ يضبط بيانات المؤتمر لحدث يتم تعديله:

  /**
   * Build a simple card with a button that sends a notification.
   * This function is called as part of the eventOpenTrigger that builds
   * a UI when the user opens a Calendar event.
   *
   * @param e The event object passed to eventOpenTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onSaveConferenceOptionsButtonClicked')
        .setParameters(
          {'phone': "1555123467", 'adminEmail': "[e-mail]"});
    var button = CardService.newTextButton()
        .setText('Add new attendee')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can set
    // conference data and disable the button if not.
    if (!e.calendar.capabilities.canSetConferenceData) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Sets conference data for the
   * Calendar event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onSaveConferenceOptionsButtonClicked(e) {
    var parameters = e.commonEventObject.parameters;

    // Create an entry point and a conference parameter.
    var phoneEntryPoint = ConferenceDataService.newEntryPoint()
      .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
      .setUri('tel:' + parameters['phone']);

    var adminEmailParameter = ConferenceDataService.newConferenceParameter()
        .setKey('adminEmail')
        .setValue(parameters['adminEmail']);

    // Create a conference data object to set to this Calendar event.
    var conferenceData = ConferenceDataService.newConferenceDataBuilder()
        .addEntryPoint(phoneEntryPoint)
        .addConferenceParameter(adminEmailParameter)
        .setConferenceSolutionId('myWebScheduledMeeting')
        .build();

    return CardService.newCalendarEventActionResponseBuilder()
        .setConferenceData(conferenceData)
        .build();
  }

إضافة مرفقات باستخدام دالة طلب معاودة الاتصال

يوضّح المثال التالي كيفية إنشاء زر يضيف مرفقًا إلى حدث تقويم Google الذي يتم تعديله:

  /**
   * Build a simple card with a button that creates a new attachment.
   * This function is called as part of the eventAttachmentTrigger that
   * builds a UI when the user goes through the add-attachments flow.
   *
   * @param e The event object passed to eventAttachmentTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onAddAttachmentButtonClicked');
    var button = CardService.newTextButton()
        .setText('Add a custom attachment')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can add
    // attachments and disable the button if not.
    if (!e.calendar.capabilities.canAddAttachments) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Adds attachments to the Calendar
   * event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onAddAttachmentButtonClicked(e) {
    return CardService.newCalendarEventActionResponseBuilder()
             .addAttachments([
               CardService.newAttachment()
                 .setResourceUrl("https://example.com/test")
                 .setTitle("Custom attachment")
                 .setMimeType("text/html")
                 .setIconUrl("https://example.com/test.png")
             ])
        .build();
  }

ضبط رمز المرفق

يجب أن تتم استضافة رمز المرفق على بنية Google الأساسية. اطّلِع على توفير نماذج نماذج رموزالمرفقات للحصول على التفاصيل.