בדף ההפניה הזה מתואר JavaScript API לתמיכה ב-iframe ביניים, שמשמש את One Tap כדי לבצע מניפולציה ב-iframe הביניים בממשק המשתמש הבא.
במדריך שילוב של One Tap באמצעות iframe מוסבר איך להשתמש ב-iframes בינוניים.
בטבלה הבאה מפורטות כל השיטות הזמינות וההתנהגויות שלהן.
| Methods | |
|---|---|
verifyParentOrigin |
מבצע את אימות המקור של ההורה |
notifyParentClose |
הודעה על דילוג על תהליך חוויית המשתמש של One Tap נשלחת למסגרת ההורה |
notifyParentDone |
הפונקציה שולחת הודעה למסגרת ההורה על סיום תהליך חוויית המשתמש של One Tap |
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 ברמת ההורה מורשה להטמיע את רכיב ה-iframe של הביניים. |
verificationFailedCallback |
שיטת הקריאה החוזרת (callback) של 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" |
verifiedCallback
השדה הזה הוא שיטת קריאה חוזרת של JavaScript שמופעלת כשהמקור הנוכחי של רכיב ה-iframe ברמת ההורה מורשה להטמיע את רכיב ה-iframe של הביניים.
verificationFailedCallback
השדה הזה הוא שיטת קריאה חוזרת של JavaScript שמופעלת כשאין הרשאה למקור האב הנוכחי להטמיע את ה-iframe של הביניים.
Method: 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()
Method: google.accounts.id.intermediate.notifyParentResize
השיטה google.accounts.id.intermediate.notifyParentResize מודיעה למסגרת הראשית לשנות את הגודל של ה-iframe הביניים. דוגמה לקוד של השיטה:
google.accounts.id.intermediate.notifyParentResize(height)
גובה
הגובה החדש בפיקסלים. יש למלא שדה זה. הערך חייב להיות מספר לא שלילי.
אם פרמטר הגובה גדול מ-0, ה-iframe הביניים מוגדר לגובה החדש. אם פרמטר הגובה הוא 0, ה-iframe הביניים הופך לבלתי נראה. מסגרת iframe מוסתרת לא נסגרת. אפשר להציג אותו מאוחר יותר באמצעות קריאה אחרת לשיטה resize.
שיטה: google.accounts.id.intermediate.notifyParentTapOutsideMode
השיטה google.accounts.id.intermediate.notifyParentTapOutsideMode מודיעה למסגרת ההורה אם לבטל את ה-iframe הביניים כשהמשתמש לוחץ מחוץ ל-iframe הביניים. דוגמת קוד של השיטה:
google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)
ביטול
הערך הבוליאני הזה מציין אם לבטל את ה-iframe הביניים כשהמשתמש לוחץ מחוץ ל-iframe הביניים.