واجهة برمجة تطبيقات JavaScript لدعم Iframe المتوسط

تصف هذه الصفحة المرجعية واجهة برمجة تطبيقات JavaScript لدعم Iframe المتوسط، والتي تتيح لك معالجة إطار iframe المتوسط في تجربة المستخدم اللاحقة.

يمكنك الاطّلاع على دليل دمج نقرة واحدة باستخدام إطار iframe لمعرفة كيفية استخدام إطارات iframe الوسيطة.

يسرد الجدول التالي جميع الطرق المتاحة وسلوكياتها.

الطُرق
verifyParentOrigin	التحقق من المصدر الرئيسي
notifyParentClose	يُعلم الإطار الرئيسي بتخطي تدفق تجربة المستخدم بنقرة واحدة
notifyParentDone	يُعلم الإطار الرئيسي باكتمال تدفق تجربة المستخدم بنقرة واحدة
notifyParentResize	يُعلم الإطار الرئيسي بتغيير حجم إطار iframe المتوسط
notifyParentTapOutsideMode	يُعلم الإطار الرئيسي بما إذا كان سيتم إلغاء إطار iframe المتوسط عندما ينقر المستخدم خارج إطار iframe المتوسط

تحميل مكتبة JavaScript لدعم إطار Iframe المتوسط

ضع مقتطف الرمز التالي في أي صفحات HTML تريد تحميل إطار iframe المتوسط فيها:

<script src="https://accounts.google.com/gsi/intermediatesupport"></script>

الطريقة: google.accounts.id.intermediate.verifyParentOrigin

تنفِّذ الطريقة google.accounts.id.intermediate.verifyParentOrigin التحقق من المصدر الرئيسي. اطّلِع على مثال الرمز التالي للطريقة:

google.accounts.id.intermediate.verifyParentOrigin(
    origins, verifiedCallback, verificationFailedCallback)

يوضّح مثال الرمز التالي كيفية عرض واجهة المستخدم فقط بعد إثبات ملكية المصدر الرئيسي:

<script>
  window.onload = () => {
    google.accounts.id.intermediate.verifyParentOrigin(
        "https://example.com", showUI, showError);
  };
</script>

يسرد الجدول التالي المَعلمات:

المَعلمة
origins	المصادر التي يُسمح لها بتضمين إطار iframe المتوسط.
verifiedCallback	يتم تفعيل طريقة معاودة الاتصال في JavaScript عندما يتم السماح للأصل الرئيسي الحالي بتضمين إطار iframe المتوسط.
verificationFailedCallback	يتم تفعيل طريقة معاودة الاتصال في JavaScript عندما لا يكون المصدر الرئيسي الحالي مسموحًا له بتضمين إطار iframe المتوسط.

الأصول

المصادر التي يُسمح لها بتضمين إطار iframe المتوسط. اطلع على الجدول التالي للحصول على مزيد من المعلومات:

النوع	حقل مطلوب	مثال
سلسلة أو مصفوفة سلسلة أو دالة	إجراء اختياري	allowed_parent_origin: "https://example.com"

يسرد الجدول التالي أنواع القيم المسموح بها وأوصافها.

أنواع القيم
string	معرّف موارد منتظم (URI) لنطاق واحد.	"https://example.com"
string array	مصفوفة من معرّفات الموارد المنتظمة (URI) للنطاق.	"https://news.example.com,https://local.example.com"

ملاحظة: السلسلة التي تتضمّن معرِّفات الموارد المنتظمة (URI) المفصولة بفواصل غير صالحة. استخدِم كائن مصفوفة JavaScript بدلاً من ذلك.

تم التحقق من صحة الاتصال

هذا الحقل هو طريقة استدعاء JavaScript يتم تشغيلها عندما يتم السماح للأصل الرئيسي الحالي بتضمين إطار iframe المتوسط.

تعذّر معاودة الاتصال

هذا الحقل هو طريقة استدعاء JavaScript يتم تشغيلها عندما يكون الأصل الرئيسي الحالي غير مسموح له بتضمين إطار iframe المتوسط.

تحذير: في حال عدم استجابة صفحة المحتوى لطلب إثبات ملكية النطاق، ستنتظر عملية إثبات الملكية إلى الأبد. في هذه الحالة، لا يتم استدعاء verifiedCallback أو verificationFailedCallback.

الطريقة: google.accounts.id.intermediate.notifyParentClose

ترسل الطريقة google.accounts.id.intermediate.notifyParentClose إشعارًا إلى الإطار الرئيسي بإغلاق إطار iframe المتوسط عند تخطي تدفق تجربة المستخدم بنقرة واحدة. اطّلِع على مثال الرمز التالي للطريقة:

google.accounts.id.intermediate.notifyParentClose()

الطريقة: google.accounts.id.intermediate.notifyParentDone

ترسل الطريقة google.accounts.id.intermediate.notifyParentClose إشعارًا إلى الإطار الرئيسي لإغلاق إطار iframe المتوسط وإعادة تحميل حالة تسجيل الدخول. اطّلع على مثال التعليمة البرمجية التالي للطريقة:

google.accounts.id.intermediate.notifyParentDone()

الطريقة: google.accounts.id.intermediate.notifyParentResize

ترسل الطريقة google.accounts.id.intermediate.notifyParentResize إشعارًا إلى الإطار الأصلي لتغيير حجم إطار iframe المتوسط. انظر مثال التعليمات البرمجية التالي للطريقة:

google.accounts.id.intermediate.notifyParentResize(height)

ملاحظة: لا يمكنك تغيير عرض إطار iframe المتوسط.

الطول

الارتفاع الجديد بالبكسل. هذا الحقل إلزامي. يجب أن تكون القيمة رقمًا غير سالب.

إذا كانت معلمة الارتفاع أكبر من 0، سيتم ضبط إطار iframe المتوسط على الارتفاع الجديد. إذا كانت معلمة الارتفاع تساوي 0، فإن إطار iframe المتوسط يصبح غير مرئي. لا يتم إغلاق إطار iframe المخفي. يمكن إظهاره لاحقًا من خلال استدعاء طريقة أخرى لتغيير الحجم.

الطريقة: google.accounts.id.intermediate.notifyParentTap خارجMode

تُعلم الطريقة google.accounts.id.intermediate.notifyParentTapOutsideMode الإطار الرئيسي بما إذا كان سيتم إلغاء إطار iframe المتوسط عندما ينقر المستخدم خارج إطار iframe المتوسط. اطّلِع على مثال الرمز التالي للطريقة:

google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)

إلغاء

تشير هذه القيمة المنطقية المطلوبة إلى ما إذا كان سيتم إلغاء إطار iframe المتوسط عندما ينقر المستخدم خارج إطار iframe المتوسط.