ממשק API של JavaScript לתמיכה במסגרות ביניים

בדף העזר הזה מתואר ה-Intermediate Iframe Support JavaScript API, שמאפשר לטפל ב-iframe הביניים בחוויית המשתמש הבאה.

למידע נוסף על השימוש במסגרות iframe ביניים, קראו את המדריך בנושא שילוב הקשה אחת באמצעות Iframe.

בטבלה הבאה מפורטות כל השיטות הזמינות והתנהגויות שלהן.

שיטות
verifyParentOrigin	מבצע את אימות המקור של ההורה
notifyParentClose	מודיעה למסגרת ההורה על כך שהמערכת דילגה על תהליך חוויית המשתמש בהקשה אחת
notifyParentDone	מודיעה למסגרת ההורה על סיום תהליך חוויית המשתמש בהקשה אחת
notifyParentResize	מודיעה למסגרת ההורה לשנות את הגודל של iframe הביניים
notifyParentTapOutsideMode	מודיעה למסגרת ההורה אם לבטל את iframe הביניים כאשר המשתמש לוחץ מחוץ ל-iframe הביניים

טעינת ספריית JavaScript לתמיכה במסגרות ביניים

מציבים את קטע הקוד הבא בכל דפי 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 הביניים.

verificationFailedCallback (אימות נכשל)

השדה הזה הוא שיטת קריאה חוזרת של 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.notifyParentSize

השיטה google.accounts.id.intermediate.notifyParentResize שולחת למסגרת ההורה התראה על שינוי הגודל של iframe הביניים. דוגמת הקוד הבאה של השיטה:

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

הערה: לא ניתן לשנות את הרוחב של iframe הביניים.

גובה

הגובה החדש בפיקסלים. יש למלא שדה זה. הערך חייב להיות מספר לא שלילי.

אם פרמטר הגובה גדול מ-0, ה-iframe הביניים מוגדר לגובה החדש. אם פרמטר הגובה הוא 0, ה-iframe הביניים הופך לבלתי נראה. iframe מוסתר לא סגור. אפשר להציג אותו מאוחר יותר באמצעות קריאה אחרת של שיטת שינוי הגודל.

שיטה: google.accounts.id.intermediate.notifyParentTapOutsideMode

השיטה google.accounts.id.intermediate.notifyParentTapOutsideMode מודיעה למסגרת ההורה אם לבטל את iframe הביניים כשהמשתמש לוחץ מחוץ ל-iframe הביניים. הנה דוגמה לקוד של השיטה:

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

ביטול

הערך הבוליאני הנדרש מציין אם לבטל את ה-iframe הביניים, כשהמשתמש לוחץ מחוץ ל-iframe הביניים.