Bağlantı eklerini Classroom eklentisi eklerine yükseltin

Öğretmenlerin Classroom'a üçüncü taraf içeriği ekleme yöntemlerinden biri Ödev oluşturma sayfasında bir bağlantıyı Bağlantı eki olarak yapıştırarak. Bina oluşturmak için öğreticilere göre eklentinizi yapılandırabileceğiniz öğretmenlerin bir bağlantı ekini eklenti ekine yükseltmesine olanak tanır.

Genel Bakış

Eklentinizi bu özellikle yapılandırırsanız öğretmenlerden şunları yapması istenir: Bir Bağlantı ekini ödev oluşturma sayfası. Öğretmenlerden bunu yapmaları istenir. yüklü olduğundan emin olun.

Öğretmen, bağlantıyı eklenti ekine yükseltmeyi kabul ettiğinde Bağlantı Yükseltme iframe'i aşağıdaki sorgu parametreleriyle başlatılır:

  • courseId
  • itemId
  • itemType
  • addOnToken
  • urlToUpgrade
  • login_hint (yalnızca kullanıcı, uygulamanızı önceden yetkilendirdiyse)

İlk dört sorgu parametresi, Ek Discovery iframe'i. urlToUpgrade sorgu parametresi yenidir ve eklenti ekinin nasıl oluşturulması gerektiğini değerlendirmenize yardımcı olur. Daha sonra, kullanıcının oturum açıp açmadığını kontrol etmek ve CreateAddOnAttachment yöntemi: courseWork, courseWorkMaterials veya itemType değerine göre announcements. iframe'de şunları yapabilirsiniz: öğretmene eklenti ekinin yüklenmediğini belirten bir yükleme ekranı oluşturuluyor.

Eklenti eki oluşturulduktan sonra iframe kapatılır ve öğretmen ödevdeki eki normalde olduğu gibi görüntüleyebilir.

Teknik uygulama ayrıntıları

Bu bölümde, özellikle ilgili bazı önemli teknik ayrıntılar vurgulanmaktadır.

urlToUpgrade sorgu parametresini okuyun

urlToUpgrade sorgu parametresi, Link'ten iletildiğinde URI olarak kodlanır iframe'i yeni sürüme geçir. URL'yi orijinal biçiminde almak için URL'nin kodunu çözmeniz gerekir. Eğer JavaScript kullanıyorsanız, decodeURIComponent() işlevini kullanmanız gerekir.

Bu özellikte en iyi kullanıcı deneyimini sunmak için bir kez postMessage gönderin. eklenti eki başarıyla oluşturuldu. Bu, iframe'i kapatır. Görüntüleyin daha fazla ayrıntı için iframe uygulama ayrıntıları sayfasına bakın.

Yapılandırma ayrıntıları

Bu özelliğin cihazınıza entegre edilmesi için aşağıdaki yapılandırmalar gereklidir eklenti:

  • Link Upgrade iframe'inin URL'si: Bu, öğretmen yükseltmeyi kabul ettiğinde iframe.

  • Classroom'un algılaması ve denemesi gereken URL kalıpları yeni sürüme geçir: URL kalıpları, bir ana makine ve birden fazla yoldan oluşabilir. ön ekler.

    • Birden fazla URL kalıbı sağlayabilirsiniz.
    • Yol ön eki belirtmezseniz ana makineyle eşleşen tüm URL'ler yükseltilebilir.
    • Yalnızca https şemasına sahip URL'ler yeni sürüme geçirilebilir.
    • URL kalıplarında localhost bulunmamalıdır.
    • Yol önekleri, sorgu parametreleri veya URL parçaları içermemelidir.
    • Yol önekleri şu anda joker karakterleri destekleyebilir ancak ana makineler aşağıdaki işlemleri yapamaz:
      • example.com geçerli bir ana makine, ve /foo ile /bar/*/baz geçerli yol ön ekleridir.
      • example.*.host.com değil geçerli olmalıdır.
    • Yol öneki bileşenleri arasındaki joker karakter yalnızca tek bir öğeyle eşleşir bileşen, eğik çizgiyle ayrılmış birden fazla bileşenle eşleşmez. example.com ana makine ve yol ön ekine sahip bir URL kalıbı kullanın /bar/*/baz:
      • https://example.com/bar/123/baz, URL için geçerli bir eşleşmedir desen.
      • https://example.com/bar/123/baz/456/789, URL kalıbı.
      • https://example.com/bar/123/456/baz, için geçerli bir eşleşme değil Yol önekindeki joker karakter eşleşmediği için URL kalıbı /123/456/.
ziyaret edin.

Geliştirme süreci

Testiniz veya üretiminiz için Bağlantı Yükseltme iFrame URL'sini ve URL kalıplarını gönderin classroom-link-upgrade-external@google.com adresine e-posta gönderin.

Bir projeyi temsil eden tüm Google Cloud projeleri için Classroom eklentisi. Öncelikle gizli görünürlüğe sahip bir eklentinin yapılandırmaları ve yapılandırma ve canlı kullanıcıları etkilemeden bir demo alanında test edebilirsiniz.

Yapılandırmalar yapıldıktan sonra e-postanıza etkin. localhost kullanan URL kalıplarının bunun için desteklenmediğini unutmayın özelliğini kullanabilirsiniz.

E-postayı aşağıdaki gibi biçimlendirin:

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
-   Host:HOST_1
-   Path prefixes:
  -   PATH_PREFIX_1
  -   PATH_PREFIX_2

-   Host:HOST_2
-   Path prefixes:
  -   PATH_PREFIX_3
  -   PATH_PREFIX_4

// add more hosts and path prefixes as needed

Aşağıdakini değiştirin:

  • GCP_PROJECT_NUMBER: Google Cloud projesinin numarası ilişkili olduğu gösterilmektedir.
  • LINK_UPGRADE_IFRAME_URL: Şurada açılması gereken URL: Bağlantı Yükseltme iframe'i.
  • HOST_1: Classroom'un algılaması gereken bir ana makine. Yalnızca https şeması destekleniyor.
  • PATH_PREFIX_1 ve PATH_PREFIX_2: Yol Classroom'un algılaması ve denemesi gereken HOST_1 ile ilişkili ön ekler tıklayın.
  • HOST_2: Classroom'un algılaması gereken bir ana makine. Yalnızca https şeması destekleniyor.
  • PATH_PREFIX_3 ve PATH_PREFIX_4: Yol Classroom'un algılaması ve denemesi gereken HOST_2 ile ilişkili ön ekler tıklayın.

Aşağıda, bu özelliği uygularken göz önünde bulundurulması gereken öneriler verilmiştir.

Öğretmenlerin ek iş yükünden kaçınma

Oturum açmayı kolaylaştırmak için iframe'i kullanmanızı gerekir veya yükleme göstergesi görüntülenir. En iyi kullanıcı deneyimi için, öğretmenden ek bilgi istenmemesi, yapıştırılan bağlantıyı eklenti ekine yükseltmeyi kabul etti. Ancak bu mümkün değilse, bağlantı kurmak için Bağlantı Yükseltme iframe'ini ihtiyacınız olacak. iframe, Bağlantının yükseltilmesi mümkün değilse veya bir hata oluştuysa öğretmene bildirin.

Kullanıcı dostu erişimle ilgili hata mesajlarını dahil et

Öğretmenler, erişimleri olmayan bir bağlantıyı yapıştırır ve yükseltirse iFrame'de kullanıcı dostu bir hata mesajı yer alır. Böylece öğretmenler sorundan haberdar olur. iframe, öğretmene uygun kullanıcı tercihlerini sağlamak için de kullanılabilir. bu içeriklere erişmek için izin verebilirsiniz.