.. _Embed Google Calendar:

##########################################
Embed a Google Calendar in Your Course
##########################################

.. tags:: educator, how-to

To embed a Google Calendar in your course, follow these steps.

.. contents::
   :local:
   :depth: 1

.. _Enable the Google Calendars Tool:

********************************
Enable the Google Calendars Tool
********************************

.. note::

    This tool is enabled by default in Teak. For earlier releases, follow the steps below to enable it manually.

Before you can add Google Calendars to your course, you must enable the Google
Calendars tool in Studio or OLX (open learning XML).

To enable the Google Calendars tool in Studio, you add the
``"google-calendar"`` key to the **Advanced Module List** on the **Advanced
Settings** page. (Be sure to include the quotation marks around the key
value.) For more information, see :ref:`Enable Additional Exercises and Tools`.

Alternatively, you can use OLX to enable the Google Calendars tool.

.. _Enable Google Calendars in OLX:

******************************
Enable Google Calendars in OLX
******************************

To enable Google Calendars in your course, you edit the XML file that defines
the course structure. You locate the ``course`` element's ``advanced-modules``
attribute, and add the string ``google-calendar`` to it.

For example, the following XML code enables Google Calendars in a course. It
also enables Google Drive files.

.. code-block:: xml

  <course advanced_modules="[&quot;google-document&quot;,
      &quot;google-calendar&quot;]" display_name="Sample Course"
      start="2014-01-01T00:00:00Z">
      ...
  </course>

For more information, see :ref:`OLX Course Building Blocks` in the
*EdX Open Learning XML Guide*.

.. _Make the Google Calendar Public and Obtain Its ID:

*************************************************
Make the Google Calendar Public and Obtain Its ID
*************************************************

Before you can add a Google Calendar to your course, you must make the Calendar
public and obtain its ID.

.. important::
 The tasks described in this section rely on the use of third-party software.
 Because the software is subject to change by its owner, the steps provided
 here are intended as guidelines and not as an exact procedure.

*******************************
Make the Google Calendar Public
*******************************

#. Open the Google Calendar.

   - Open your Google Calendar (e.g. https://calendar.google.com)

#. From the **Settings** menu, select **Settings**.
#. Select the **Calendars** tab.

   You might have multiple calendars on the **Calendars** tab. Find the
   calendar that you want to share in your course.

#. In the row for the calendar to share, in the **Sharing** column, select
   **Edit Settings**.
#. Select the **Share this Calendar** tab, and then select **Make this calendar
   public**.

  .. image:: /_images/educator_how_tos/google-calendar-settings.png
   :alt: Google Calendar settings.

#. Select **Save**.

   The **Calendar Settings** page closes, and you return to the **Calendars**
   tab. You continue by :ref:`obtaining the Google Calendar's ID<Obtain the
   Google Calendar ID>`.

.. _Obtain the Google Calendar ID:

******************************
Obtain the Google Calendar ID
******************************

#. On the **Calendars** tab, select the name of the calendar.
#. Select the **Calendar Details** tab.
#. Next to the **Calendar Address** label, look to the right of the three
   colored **XML**, **ICAL**, and **HTML** buttons. In parentheses, you can see
   the calendar ID.

   .. image:: /_images/educator_how_tos/google-calendar-address.png
     :width: 600
     :alt: Image of Calendar Address label with the calendar ID to the right.

   The calendar ID resembles the following text.

   ``abcdefghijklmnop1234567890@group.calendar.google.com``

   Select and copy the calendar ID. You use this value to configure the Google
   Calendar component in your course.

.. _Add a Google Calendar in the Course Body:

****************************************
Add a Google Calendar in the Course Body
****************************************

To add a Google calendar in the course body, you create an advanced component
in Studio or create a Google Calendar XBlock in OLX.

.. _Add a Google Calendar Component in Studio:

**************************************************
Add a Google Calendar Component in Open edX Studio
**************************************************

Make sure that you :ref:`enable Google Calendars<Enable the Google Calendars
Tool>` for your course before you add a Google Calendar component.

To add a Google Calendar component, follow these steps.

#. On the **Course Outline** page, open the unit where you want to add the
   Google Calendar component.

#. Under **Add New Component**, select **Advanced**, and then select **Google
   Calendar**.

   The new component is added to the unit.

#. In the new component, select **Edit**.

#. In the **Display Name** field, type the name for the component.

#. In the **Public Calendar ID** field, paste the calendar ID you copied in the
   :ref:`Obtain the Google Calendar ID` task.

#. For the **Default View** field, select **Month**, **Week**, or **Agenda**.

   This is the initial view that your learners have of the calendar. Each
   learner can change his or her view.

#. Select **Save**.

You can then :ref:`Preview Unpublished Content` to see how the unit with the
Google Calendar will appear to learners.

.. _Add a Google Calendar XBlock in OLX:

***********************************
Add a Google Calendar XBlock in OLX
***********************************

To add a Google Calendar XBlock in OLX, create the ``google-calendar`` element.
You can embed this element in the ``vertical`` element, or you can embed this
element in its own file that is referenced within the vertical. For more
information, see :ref:`OLX Course Building Blocks` in the *Open edX Open
Learning XML Guide*.

An example follows.

.. code-block:: xml

  <google-calendar url_name="4115e717366045eaae7764b2e1f25e4c"
    calendar_id="abcdefghijklmnop1234567890@group.calendar.google.com"
    default_view="1" display_name="Class Schedule"/>

The value of the ``calendar_id`` attribute is the calendar ID that you copied
in the :ref:`Obtain the Google Calendar ID` task.

.. note::
  The Learning Management System sets the height and width values for
  Google Calendars. If you add these attributes, the LMS overrides your
  changes.

.. seealso::
 

 :ref:`Google Calendar Tool` (reference)





**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
+--------------+-------------------------------+----------------+--------------------------------+
| 06/10/2025   | Leira (Curricu.me)            | Sumac          |                                |
+--------------+-------------------------------+----------------+--------------------------------+