iFrame ve sorgu parametresi ayrıntıları

Classroom eklentileri, son kullanıcıya sorunsuz ve kullanışlı bir kullanıcı deneyimi sunmak için bir iFrame içinde yüklenir. Beş farklı iFrame türü vardır. Her iFrame'in amacına ve görünümüne genel bir bakış için Kullanıcı yolculukları dizininde iFrame sayfalarına bakın.

iframe güvenlik yönergeleri

Geliştiricilerin, iframe'larını güvence altına almak için sektördeki en iyi uygulamalara uyması beklenir. Ancak geçerli kimlik bilgilerine sahip olduğunuzdan ve kullanıcının kurstaki rolünü doğru şekilde tanımlayabildiğinizden emin olmak için kullanıcı akışınıza belirli API etkileşimlerini de dahil etmeniz gerekir.

Sunucu uygulaması yapılandırması

Iframe'i korumak için aşağıdaki sunucu yapılandırmalarını öneririz:

• HTTPS gereklidir. TLS 1.2 veya sonraki bir sürümü kullanmanızı ve HTTP Katı Taşıma Güvenliği'ni (HSTS) etkinleştirmenizi önemle tavsiye ederiz. Katı Taşıma Güvenliği hakkındaki bu ilgili MDN makalesine bakın.
• Katı İçerik Güvenliği Politikası'nı (Katı İGP) etkinleştirin. Bu OWASP makalesine ve ilgili İçerik Güvenliği Politikası MDN makalesine göz atın.
• Güvenli çerez özelliğini etkinleştirin. HttpOnly özelliğine ve bu konuyla ilgili Çerezler MDN makalesine bakın.

Sorgu parametreleri

Iframe'ler, kritik bilgileri sorgu parametreleri olarak eklentiye iletir. İki parametre kategorisi vardır: eklerle ilgili ve oturum açma ile ilgili parametreler.

Ekle ilgili parametreler

Ekle ilgili parametreler, eklentiye kurs, ödev, eklenti eki, öğrencinin gönderimi ve yetkilendirme jetonu hakkında bilgi sağlar.

Ders kimliği

courseId değeri, dersin tanımlayıcısıdır.

Tüm iframe'lere dahildir.

Öğe Kimliği

itemId değeri, Announcement için bir tanımlayıcıdır.

CourseWork veya bu ekin eklendiği CourseWorkMaterial.

Tüm iframe'lere dahildir.

Öğe Türü

itemType değeri, bu

ek eklenmiştir. İletilen dize değeri "announcements", "courseWork" veya "courseWorkMaterials" olmalıdır.

Tüm iframe'lere dahildir.

Ek kimliği

attachmentId değeri, ekin tanımlayıcısıdır.

teacherViewUri, studentViewUri ve studentWorkReviewUri iframe'lerine dahildir.

Gönderim kimliği

submissionId değeri, öğrencinin çalışmasının tanımlayıcısıdır ancak öğrencinin belirli bir ödevdeki çalışmasını tanımlamak için attachmentId ile birlikte kullanılmalıdır.

studentWorkReviewUri ile birlikte sunulur.

Eklenti jetonu

addOnToken değeri,

addOnAttachments.create çağrısı yapar.

Ek Keşfi iframe'ine ve Bağlantı Yükseltme iframe'ine dahildir.

Yükseltilecek URL

urlToUpgrade değerinin bulunması,

öğretmen, ödeve bağlantı eki ekledi ve bunu eklenti eki olarak yükseltmeyi kabul etti. Bu özelliği henüz yapılandırmadıysanız daha fazla bilgi için bağlantıları eklenti eklerine yükseltme konulu kılavuza bakın.

Bağlantı Yükseltme iframe'ine dahildir.

Oturum açmayla ilgili parametreler

login_hint sorgu parametresi, eklenti web sayfasını ziyaret eden Classroom kullanıcısı hakkında bilgi sağlar. Bu sorgu parametresi, iframe src URL'sinde sağlanır. Kullanıcı daha önce eklentinizi kullandığında, son kullanıcının oturum açma zorluğunu azaltmaya yardımcı olmak için gönderilir. Eklenti uygulamanızda bu sorgu parametresini kullanmanız gerekir.

Giriş ipucu

login_hint, kullanıcının Google

Hesap'a dokunun. Kullanıcı eklentinize ilk kez giriş yaptıktan sonra, aynı kullanıcı tarafından eklentinize yapılan her ziyarette login_hint parametresi iletilir.

login_hint parametresinin iki olası kullanımı vardır:

1. Oturum açma iletişim kutusu göründüğünde kullanıcının kimlik bilgilerini girmesine gerek kalmaması için kimlik doğrulama akışı sırasında login_hint değerini iletin. Kullanıcı otomatik olarak oturum açmaz.
2. Kullanıcı oturum açtıktan sonra, bu parametreyi kullanarak değeri eklentide oturum açmış olabileceğiniz kullanıcılarla karşılaştırın. Eşleşme bulursanız kullanıcının oturumunu açık bırakabilir ve oturum açma akışı göstermekten kaçınabilirsiniz. Parametre, oturum açmış kullanıcılarınızdan hiçbiriyle eşleşmezse kullanıcıdan Google markalı bir oturum açma düğmesiyle oturum açmasını isteyin.

Tüm iframe'lere dahildir.

Ek Keşfi iframe'i

Örnek ek bulma senaryosu

1. Bir Classroom eklentisi, https://example.com/addon ek keşif URI'si ile Google Workspace Marketplace'e kaydedilir.
2. Bir öğretmen bu eklentiyi yükler ve kurslarından birinde yeni bir duyuru, ödev veya materyal oluşturur. Örneğin, itemId=234, itemType=courseWork ve courseId=123.
3. Öğretmen, bu öğeyi yapılandırırken yeni yüklenen eklentiyi ek olarak seçer.
4. Classroom, src URL'si https://example.com/addon?courseId=123&itemId=234&itemType=courseWork&addOnToken=456 olarak ayarlanmış bir iframe oluşturur.
   1. Öğretmen, ek seçimi yapmak için iFrame içinde işlem yapar.
5. Eklenti, ek seçildiğinde iframe'i kapatmak için Classroom'a bir postMessage gönderir.

teacherViewUri ve studentViewUri iframe'leri

studentWorkReviewUri iframe'i

Bağlantıyı yeni sürüme geçirme iframe'i

Bağlantı yükseltme örneği senaryosu

1. Classroom eklentisi, https://example.com/upgrade bağlantı yükseltme URI'si ile kaydedilir. Classroom'un eklenti eki olarak yükseltmeye çalışması gereken bağlantı ekleri için aşağıdaki barındırıcı ve yol önek kalıplarını sağladınız:
   • Ana makine example.com ve yol ön eki /quiz'dur.
2. Bir öğretmen, kurslarından birinde yeni bir duyuru, ödev veya materyal oluşturur. Örneğin, itemId=234, itemType=courseWork ve courseId=123.
3. Bir öğretmen, Eki bağla iletişim kutusuna sağladığınız URL kalıbıyla eşleşen bir bağlantı (https://example.com/quiz/5678) yapıştırır. Ardından öğretmenden bağlantıyı eklenti eki olarak yükseltmesi istenir.

4. Classroom, URL'si https://example.com/upgrade?courseId=123&itemId=234&itemType=courseWork&addOnToken=456&urlToUpgrade=https%3A%2F%2Fexample.com%2Fquiz%2F5678 olarak ayarlanmış Bağlantı Yükseltme iFrame'sini başlatır.

5. Iframe'de iletilen sorgu parametrelerini değerlendirir ve CreateAddOnAttachment uç noktasını çağırırsınız. urlToUpgrade sorgu parametresinin, iframe'de iletilirken URI olarak kodlandığını unutmayın. Orijinal biçiminde almak için parametrenin kodunu çözmeniz gerekir. Örneğin, JavaScript'te decodeURIComponent() işlevi bulunur.

6. Bağlantıdan eklenti eki başarıyla oluşturulduğunda, iframe'i kapatmak için Classroom'a bir postMessage gönderirsiniz.

iFrame'i kapatma

{type: 'Classroom', action: 'closeIframe'} yükü içeren bir postMessage göndererek iframe, öğrenme aracından kapatılabilir. Classroom, bu postMessage değerini yalnızca açılan orijinal URI'ye karşılık gelen host_name+port parametresinden kabul eder.

<button id="close">Send message to close iframe</button>
<script>
  document.querySelector('#close')
    .addEventListener('click', () => {
        window.parent.postMessage({
            type: 'Classroom',
            action: 'closeIframe',
        }, '*');
    });
</script>

iFrame'i iframe'den kapatma

postMessage etkinliğini gönderen sayfanın alan adı ve bağlantı noktası, iframe'i başlatmak için kullanılan URI ile aynı alan adı ve bağlantı noktasına sahip olmalıdır. Aksi takdirde mesaj yoksayılır. Bu sorunun geçici çözümü, orijinal alan adındaki postMessage etkinliğini göndermekten başka bir şey yapmayan bir sayfaya geri yönlendirmektir.

Yeni sekmeden iFrame'i kapatma

Alanlar arası korumalar bunun çalışmasını engeller. Çözüm olarak, iframe ile yeni sekme arasındaki iletişimi kendiniz yönetebilir ve kapatma postMessage etkinliğini göndermekten iframe'in sorumlu olmasını sağlayabilirsiniz. Kullanıcıların yakın gelecekte bu şekilde sekme oluşturmaması için "İş Ortağı Adı'nda Aç" köprüsünü kaldırıyoruz.

Kısıtlamalar

Tüm iframe'ler aşağıdaki korumalı alan özellikleri ile açılır:

• allow-popups
• allow-popups-to-escape-sandbox
• allow-forms
• allow-scripts
• allow-storage-access-by-user-activation
• allow-same-origin

ve aşağıdaki özellik politikası

• allow="microphone *"

Üçüncü taraf çerezlerini engelleme

Üçüncü taraf çerezlerini engellemenin, bir iframe'de oturum açmayı zorlaştırdığını unutmayın. Farklı tarayıcılarda çerez engellemenin mevcut durumu için https://www.cookiestatus.com adresine bakın. Elbette bu sorun, Google Classroom eklentilerine özgü değildir ve üçüncü taraf iframe'ı kullanan tüm web sitelerini etkiler. İş ortaklarımızın çoğu bu sorunla daha önce karşılaşmıştır.

Bazı genel geçici çözümler şunlardır:

• Çerezi birinci taraf bağlamında oluşturmak için yeni bir sekme açın. Bazı tarayıcılar, üçüncü taraf bağlamındayken birinci taraf bağlamında oluşturulan çerezlere erişim izni verir.
• Kullanıcıdan üçüncü taraf çerezlerine izin vermesini isteyin. Bu işlem her zaman tüm kullanıcılar için mümkün olmayabilir.
• Çerezlere ihtiyaç duymayan tek sayfalık web uygulamaları tasarlayın.

Gelecekteki tarayıcı sürümlerinde daha fazla çerez kısıtlaması yapılması beklenmektedir. İş ortaklarının ihtiyaç duyduğu artışı nasıl azaltacağınız konusunda Google'a geri bildirim göndermek için özellik istekleri oluşturun.

URL normal ifadelerini kullanarak eklentilerin bulunabilirliğini etkinleştirme

Öğretmenler sık sık bağlantı eki içeren ödevler oluşturur. Eklentinizin kullanımını tanıtmak için eklentinizde erişilebilen kaynakların URL'leriyle eşleşen normal ifadeler belirtebilirsiniz. Normal ifadelerinizin biriyle eşleşen bir bağlantı ekleyen öğretmenler, eklentinizi denemeye teşvik eden kapatılabilir bir iletişim kutusu görür. Kullanıcılar, eklenti hesaplarında zaten yüklüyse iletişim kutusunu görür.

Bu davranışı öğretmenlere sunmak istiyorsanız Google kişilerinize uygun normal ifadeleri sağlayın. Sağladığınız normal ifadeler çok genişse veya başka bir eklentiyle çakışıyorsa daha kısıtlı veya farklı olacak şekilde değiştirilebilir.

Şekil 1. Öğretmen, yeni bir ödeve bağlantı eki seçiyor.

Şekil 2. Öğretmen, üçüncü taraf kaynağından bir bağlantı yapıştırıyor. Öğretmen, üçüncü taraf Classroom eklentisini zaten yüklemişse.

Şekil 3. Yapıştırılan bağlantı, üçüncü taraf geliştirici tarafından belirtilen normal ifadeyle eşleştiğinde öğretmene gösterilen etkileşimli iletişim kutusu.

Şekil 3'te gösterildiği gibi pop-up'ta "Şimdi dene"yi seçen öğretmenler, eklentinizin Ek Keşfi iframe'ine yönlendirilir.