חומר עזר של לקוח JavaScript לכניסה באמצעות חשבון Google

בחומר עזר זה מתוארות השיטות והמאפיינים של לקוח JavaScript משמשים להטמעת כניסה באמצעות חשבון Google באפליקציות האינטרנט.

אם נתקלת בבעיה בשימוש בספרייה, יש לדווח עליה מאגר ה-GitHub.

הגדרת האימות

טוענים את הספרייה של פלטפורמת Google APIs כדי ליצור את האובייקט gapi:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

אחרי שספריית הפלטפורמה תיטען, טוענים את הספרייה auth2:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init(params)

מאתחל את האובייקט GoogleAuth. צריך להפעיל את השיטה הזו לפני קריאה לשיטות של gapi.auth2.GoogleAuth.

כשמאתחלים את האובייקט GoogleAuth, מגדירים את האובייקט עם מזהה הלקוח ב-OAuth 2.0 וכל אפשרות נוספת שרוצים לציין. לאחר מכן, אם המשתמש כבר נכנס לחשבון, האובייקט GoogleAuth ישחזר את מצב הכניסה של המשתמש מהסשן הקודם.

ארגומנטים
params אובייקט שמכיל צמדי מפתח/ערך של נתוני תצורה של לקוח. צפייה gapi.auth2.ClientConfig לאפשרויות השונות של המאפיינים שאפשר להגדיר. מוצרים לדוגמה: 
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
החזרות
gapi.auth2.GoogleAuth האובייקט gapi.auth2.GoogleAuth. משתמשים ב שיטת tens() כדי לקבל Promise שמתקבלת כאשר האובייקט gapi.auth2.GoogleAuth מסיים באתחול.

GoogleAuth.then(onInit, onError)

הפעלת הפונקציה onInit כשהאובייקט GoogleAuth מלא אותחל. אם מתעוררת שגיאה במהלך האתחול (זה יכול לקרות בדפדפנים ישנים שלא נתמכים), במקומה תתבצע קריאה לפונקציה onError.

ארגומנטים
onInit הפונקציה קראה לפונקציה עם האובייקט GoogleAuth כשהיא מוגדרת במלואה אותחל.
onError הפונקציה שנקראה עם אובייקט שמכיל מאפיין error, אם האתחול של GoogleAuth נכשל.
החזרות
Promise Promise שמבוצע כאשר onInit הושלם, או נדחה אם אירעה שגיאת אתחול. הוא משתנה עם שהחזיר ערך מהפונקציה onInit, אם יש כזה.

קודי שגיאה

idpiframe_initialization_failed
נכשל האתחול של iframe נדרש מ-Google. לדוגמה, עקב רכיב לא נתמך הסביבה. המאפיין details יספק מידע נוסף על השגיאה שהעלית.

gapi.auth2.ClientConfig

ממשק שמייצג את הפרמטרים השונים של התצורה gapi.auth2.init.

פרמטרים
client_id string חובה. מזהה הלקוח של האפליקציה, שנמצא ונוצר במסוף Google API.
cookie_policy string הדומיינים שעבורם יש ליצור קובצי cookie לכניסה. זהו URI, single_host_origin או none. ברירת המחדל היא single_host_origin אם לא צוין.
scope string ההיקפים שצריך לבקש, כמחרוזת מופרדת ברווחים. אופציונלי אם הערך של fetch_basic_profile לא מוגדר כ-False.
fetch_basic_profile boolean אחזור של משתמשים פרטי פרופיל בסיסיים כשהם נכנסים לחשבון. הוספה של 'פרופיל', 'אימייל' וגם 'openid' להיקפים המבוקשים. אם לא צוין True.
hosted_domain string הדומיין ב-G Suite שאליו המשתמשים צריכים להשתייך כדי להיכנס לחשבון. הזה עשוי להשתנות על ידי לקוחות, לכן חשוב לוודא נכס הדומיין המתארח של המשתמש שהוחזר. כדאי להשתמש GoogleUser.getHostedDomain() מופעל את הלקוח, ואת ההצהרה hd באסימון המזהה כדי לאמת שהדומיין הוא מה שציפיתם.
use_fedcm boolean אופציונלי. ברירת המחדל היא True. הפעלה או השבתה של השימוש ב- ממשקי API של FedCM לדפדפן במהלך הכניסה.
ux_mode string מצב חוויית המשתמש בתהליך הכניסה. כברירת מחדל, תהליך ההסכמה ייפתח בחלון קופץ. הערכים החוקיים הם popup ו-redirect.
redirect_uri string אם משתמשים ב-ux_mode='redirect', הפרמטר הזה מאפשר לבטל את ערך ברירת המחדל redirect_uri שישמש בסיום תהליך ההסכמה. ברירת המחדל redirect_uri הוא כתובת ה-URL הנוכחית ללא פרמטרים של שאילתה וגיבוב (hash) מקטע.
enable_granular_consent boolean זה שינוי אופציונלי. האם להפעיל מגורען הרשאות. אם המדיניות מוגדרת לערך false, הבדיקה של Google ברמת פירוט גבוהה יותר. ההרשאות בחשבון יושבתו עבור מזהי לקוח ב-OAuth שנוצרו לפני כן 2019. אין השפעה על מזהי לקוחות של OAuth שנוצרו במהלך 2019 או לאחר מכן, מאז הרשאות מפורטות יותר תמיד מופעלות עבורו.
plugin_name string זה שינוי אופציונלי. אם מוגדר הערך הזה, מזהי Client-ID חדשים נוצרו לפני יולי החל מ-29 בחודש 2022, ניתן להשתמש בספרייה הישנה יותר של מוצרי הפלטפורמה של Google. כברירת מחדל, אין עכשיו אפשרות להשתמש במזהי לקוח חדשים שנוצרו ספריית הפלטפורמה, ובמקום זאת צריך להשתמש בגרסה החדשה יותר של Google Identity ספריית השירותים. ניתן לבחור כל ערך, שם תיאורי כמו מומלץ להשתמש בשם של המוצר או הפלאגין לצורך זיהוי. לדוגמה: plugin_name: 'YOUR_STRING_HERE'

אימות

GoogleAuth היא מחלקה של SSO שמספקת שיטות שמאפשרות למשתמש להיכנס באמצעות חשבון Google, לקבל את סטטוס הכניסה הנוכחי של המשתמש, לקבל נתונים ספציפיים מפרופיל Google של המשתמש, לבקש היקפי הרשאות נוספים ולצאת מהחשבון הנוכחי.

gapi.auth2.getAuthInstance()

מחזירה את האובייקט GoogleAuth. לפני שמפעילים את השיטה הזו, צריך לאתחל את האובייקט GoogleAuth עם gapi.auth2.init().

החזרות
gapi.auth2.GoogleAuth האובייקט gapi.auth2.GoogleAuth. צריך להשתמש באובייקט הזה כדי להפעיל השיטות של gapi.auth2.GoogleAuth.

GoogleAuth.isSignedIn.get()

הפונקציה מחזירה אם המשתמש הנוכחי מחובר.

החזרות
בוליאני true אם המשתמש מחובר לחשבון, או false אם המשתמש לא מחובר לחשבון, או שהאובייקט GoogleAuth לא אותחל.

GoogleAuth.isSignedIn.listen(listener)

מקשיבים לשינויים במצב הכניסה של המשתמש הנוכחי.

ארגומנטים
listener פונקציה שמקבלת ערך בוליאני. listen() כרטיסים true לפונקציה הזו כשהמשתמש נכנס לחשבון, וגם false כשהמשתמש יוצא.

GoogleAuth.signIn()

המשתמש נכנס לחשבון באמצעות האפשרויות שצוינו בחשבון gapi.auth2.init().

החזרות
Promise Promise שמבוצע עם המכונה GoogleUser כאשר משתמש מאמת ומעניק את ההיקפים המבוקשים, או נדחה באמצעות אובייקט שמכיל מאפיין error אם מתרחשת שגיאה. לצפייה בקטע הבא כדי לראות את קודי השגיאה.

קודי שגיאה

GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

המשתמש ייכנס לחשבון באמצעות האפשרויות שצוינו.

ארגומנטים
options אחת משתי האפשרויות:
  • אובייקט gapi.auth2.SignInOptions שמכיל צמדי מפתח/ערך של פרמטרים של כניסה. לדוגמה: 
    {
  scope: 'profile email'
}
  • מופע של gapi.auth2.SigninOptionsBuilder. עבור דוגמה:
    options = new gapi.auth2.SigninOptionsBuilder();
options.setAppPackageName('com.example.app');
options.setFetchBasicProfile(True);
options.setPrompt('select_account');
options.setScope('profile').setScope('email');
החזרות
Promise Promise שמבוצע עם המכונה GoogleUser כאשר משתמש מאמת ומעניק את ההיקפים המבוקשים, או נדחה באמצעות אובייקט שמכיל מאפיין error אם מתרחשת שגיאה (קודי שגיאה מופיעים בהמשך).

קודי שגיאה

popup_closed_by_user
המשתמש סגר את החלון הקופץ לפני שסיים את תהליך הכניסה לחשבון.
access_denied
המשתמש דחה את ההרשאה להיקפי ההרשאות הנדרשים.
immediate_failed
לא ניתן היה לבחור אף משתמש באופן אוטומטי בלי להציג בקשה לתהליך ההסכמה. התעוררה שגיאה כאשר באמצעות signIn עם אפשרות prompt: 'none'. האפשרות הזו לא יכולה להיות נדרש לשימוש, כי gapi.auth2.init ייכנס לחשבון המשתמש באופן אוטומטי אם שנכנסו בעבר במהלך סשן קודם.

gapi.auth2.SignInOptions

ממשק שמייצג את הפרמטרים השונים של התצורה אמצעי תשלום אחד (GoogleAuth.signIn(options)).

פרמטרים
prompt string המערכת אוכפת מצב ספציפי בתהליך ההסכמה. זה שינוי אופציונלי.
הערכים האפשריים הם:
  • consent
    שרת ההרשאות מבקש מהמשתמש הסכמה לפני שחוזר מידע לאפליקציה.
  • select_account
    שרת ההרשאות מבקש מהמשתמש לבחור חשבון Google. הזה משתמש שיש לו כמה חשבונות יכול לבחור מבין כמה חשבונות שאולי יש להם סשנים נוכחיים.
  • none (לא מומלץ)
    שרת ההרשאות לא יציג אימות או הסכמת משתמשים מסכים; היא תחזיר שגיאה אם המשתמש עדיין לא מאומת לא הסכים בעבר להיקפי ההרשאות המבוקשים.
    gapi.auth2.init יבצע כניסה אוטומטית של משתמש אל אם נכנסתם בעבר לחשבון, תבצעו קריאה signIn({prompt: 'none'}) בדרך כלל נכשלים.
scope string ההיקפים שיש לבקש, כמחרוזת מופרדת ברווחים, מעל ההיקפים שמוגדרים gapi.auth2.init פרמטרים. אופציונלי אם הערך fetch_basic_profile לא מוגדר ל-FALSE.
ux_mode string מצב חוויית המשתמש בתהליך הכניסה. כברירת מחדל, תהליך ההסכמה ייפתח בחלון קופץ. הערכים החוקיים הם popup ו-redirect.
redirect_uri string אם משתמשים ב-ux_mode='redirect', הפרמטר הזה מאפשר לשנות ערך ברירת המחדל redirect_uri שישמש לאחר מתן ההסכמה . ברירת המחדל redirect_uri היא כתובת ה-URL הנוכחית שהשאילתה הוסרה פרמטרים וקטע hash.

GoogleAuth.signOut()

יציאה מהחשבון הנוכחי מהאפליקציה.

החזרות
Promise Promise שמבוצע לאחר חתימה של המשתמש החוצה.

GoogleAuth.disconnect()

ביטול כל היקפי ההרשאות שהמשתמש העניק.

GoogleAuth.grantOfflineAccess(options)

קבלת הרשאה מהמשתמש לגשת להיקפים שצוינו במצב אופליין.

ארגומנטים
options gapi.auth2.OfflineAccessOptions שמכיל צמדי מפתח/ערך של פרמטרים. לדוגמה: 
{
  scope: 'profile email'
}
החזרות
Promise Promise שמבוצע כשהמשתמש מעניק את ההרשאה היקפים מבוקשים, העברת אובייקט שמכיל את קוד ההרשאה ה-handler של Promise. לדוגמה: 
auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

קודי שגיאה

popup_closed_by_user
המשתמש סגר את החלון הקופץ לפני שסיים את תהליך ההסכמה.
access_denied
המשתמש דחה את ההרשאה להיקפי ההרשאות הנדרשים.
immediate_failed
לא ניתן היה לבחור אף משתמש באופן אוטומטי בלי להציג בקשה לתהליך ההסכמה. התעוררה שגיאה כאשר באמצעות signIn עם אפשרות prompt: 'none'. אין לבחור באפשרות הזו נדרש לשימוש, כי gapi.auth2.init תכניס את המשתמש לחשבון באופן אוטומטי אם שנכנסו בעבר במהלך סשן קודם.

gapi.auth2.OfflineAccessOptions

ממשק שמייצג את הפרמטרים השונים של התצורה GoogleAuth.grantOfflineAccess(options) .

פרמטרים
prompt string המערכת אוכפת מצב ספציפי בתהליך ההסכמה. זה שינוי אופציונלי.
הערכים האפשריים הם:
  • consent
    שרת ההרשאות מבקש מהמשתמש הסכמה לפני שחוזר מידע לאפליקציה.
  • select_account
    שרת ההרשאות מבקש מהמשתמש לבחור חשבון Google. הזה משתמש שיש לו כמה חשבונות יכול לבחור מבין כמה חשבונות שאולי יש להם סשנים נוכחיים.
scope string ההיקפים שיש לבקש, כמחרוזת מופרדת ברווחים, מעל ההיקפים שמוגדרים gapi.auth2.init פרמטרים. אופציונלי אם הערך fetch_basic_profile לא מוגדר ל-FALSE.

GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)

מצרף את תהליך הכניסה ל-handler של הקליקים של המאגר שצוין.

ארגומנטים
container המזהה של הרכיב div שאליו צריך להפנות, או הפניה אל הרכיב הזה מצרפים את מטפל הקליקים.
options אובייקט שמכיל צמדי מפתח/ערך של פרמטרים. צפייה GoogleAuth.signIn().
onsuccess הפונקציה שצריך להפעיל אחרי הכניסה לחשבון.
onfailure הפונקציה שצריך להפעיל אם הכניסה נכשלה.

משתמשים

אובייקט GoogleUser מייצג חשבון משתמש אחד. בדרך כלל, אובייקטים של GoogleUser מתקבלים GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

החזרת אובייקט GoogleUser שמייצג את המשתמש הנוכחי. שימו לב שבמודל שאתחול מחדש מופע GoogleAuth, המשתמש הנוכחי לא הוגדר. משתמשים ב השיטה currentUser.listen() או GoogleAuth.then() כדי לקבל מכונה GoogleAuth מאותחלת.

החזרות
GoogleUser המשתמש הנוכחי

GoogleAuth.currentUser.listen(listener)

האזנה לשינויים ב-currentUser.

ארגומנטים
listener פונקציה שמקבלת פרמטר GoogleUser. הפקודה listen מעבירה את הפונקציה GoogleUser מופע בכל שינוי שמשנה את currentUser.

GoogleUser.getId()

מאתרים את מחרוזת המזהה הייחודית של המשתמש.

החזרות
מחרוזת המזהה הייחודי של המשתמש

GoogleUser.isSignedIn()

הפונקציה מחזירה את הערך True אם המשתמש מחובר.

החזרות
בוליאני True אם המשתמש מחובר לחשבון

GoogleUser.getHostedDomain()

לקבל את דומיין G Suite של המשתמש אם המשתמש נכנס באמצעות חשבון G Suite.

החזרות
מחרוזת הדומיין של המשתמש ב-G Suite

GoogleUser.getGrantedScopes()

מקבלים את היקפי ההרשאות שהמשתמש העניק כמחרוזת מופרדת ברווחים.

החזרות
מחרוזת היקפי ההרשאות שהמשתמש העניק

GoogleUser.getBasicProfile()

לקבל את פרטי הפרופיל הבסיסיים של המשתמש.

החזרות
gapi.auth2.BasicProfile אפשר לאחזר את המאפיינים של gapi.auth2.BasicProfile באמצעות השיטות הבאות:
  • BasicProfile.getId()
  • BasicProfile.getName()
  • BasicProfile.getGivenName()
  • BasicProfile.getFamilyName()
  • BasicProfile.getImageUrl()
  • BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

מקבלים את אובייקט התשובה מסשן האימות של המשתמש.

ארגומנטים
includeAuthorizationData אופציונלי: ערך בוליאני שמציין אם להחזיר תמיד אסימון גישה להיקף גדול. כברירת מחדל, אסימון הגישה וההיקפים המבוקשים לא מוחזרים fetch_basic_profile הוא True (ערך ברירת המחדל) ואין היקפים נוספים נדרש.
החזרות
gapi.auth2.AuthResponse אובייקט gapi.auth2.AuthResponse.

GoogleUser.reloadAuthResponse()

מאלץ רענון של אסימון הגישה, ולאחר מכן מחזיר הבטחה עבור ה-AuthResponse החדש.

החזרות
Promise Promise שמתמלא לאחר טעינה מחדש gapi.auth2.AuthResponse בזמן טעינה מחדש של אסימון ה-OAuth הושלם.

gapi.auth2.AuthResponse

התשובה הוחזרה במהלך ההתקשרות GoogleUser.getAuthResponse(includeAuthorizationData) או GoogleUser.reloadAuthResponse() שיטות.

מאפיינים
access_token string אסימון הגישה הוענק.
id_token string האסימון המזהה מוענק.
scope string היקפי ההרשאות שהוענקו באסימון הגישה.
expires_in number מספר השניות עד שיפוג התוקף של אסימון הגישה.
first_issued_at number חותמת הזמן שבה המשתמש נתן בפעם הראשונה את היקפי ההרשאות המבוקשים.
expires_at number חותמת הזמן שבה יפוג תוקף אסימון הגישה.

GoogleUser.hasGrantedScopes(scopes)

הפונקציה מחזירה את הערך true אם המשתמש העניק את היקפי ההרשאות שצוינו.

ארגומנטים
scopes מחרוזת היקפים מופרדת ברווחים.
החזרות
בוליאני True אם ההיקפים הוענקו

GoogleUser.grant(options)

לבקש היקפי הרשאות נוספים למשתמש.

עבור GoogleAuth.signIn() לרשימה של ואת קוד השגיאה.

GoogleUser.grantOfflineAccess(options)

קבלת הרשאה מהמשתמש לגשת להיקפים שצוינו במצב אופליין.

ארגומנטים
options gapi.auth2.OfflineAccessOptions שמכיל צמדי מפתח/ערך של פרמטרים. לדוגמה: 
{
  scope: 'profile email'
}

GoogleUser.disconnect()

ביטול של כל היקפי ההרשאות שהמשתמש העניק לאפליקציה.

רכיבים בממשק המשתמש

gapi.signin2.render(id, options)

יוצר לחצן כניסה ברכיב עם המזהה הנתון, באמצעות ההגדרות שצוינו על ידי האובייקט options.

ארגומנטים
id מזהה הרכיב שבו צריך לעבד את לחצן הכניסה.
options אובייקט שמכיל את ההגדרות שמשמשות לעיבוד הלחצן. מוצרים לדוגמה: 
{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}
ניתן לציין את האפשרויות הבאות:
פרמטרים
היקף היקפי ההרשאות שצריך לבקש כשמשתמש נכנס (ברירת המחדל: profile).
רוחב רוחב הלחצן בפיקסלים (ברירת המחדל: 120).
גובה גובה הלחצן בפיקסלים (ברירת המחדל: 36).
כותרת ארוכה להציג תוויות ארוכות, כמו 'כניסה באמצעות חשבון Google'. במקום "כניסה" (ברירת מחדל: false). כשמשתמשים בשמות ארוכים, צריך להגדיל את רוחב הלחצן מברירת המחדל שלו.
עיצוב עיצוב הצבעים של הלחצן: light או dark (ברירת המחדל: light).
ללא הצלחה פונקציית הקריאה החוזרת (callback) להפעלה לאחר שמשתמש נכנס בהצלחה. הפונקציה חייבת להכיל ארגומנט אחד: מופע של gapi.auth2.GoogleUser (ברירת מחדל: ללא).
כשל פונקציית הקריאה החוזרת (callback) שתישלח כשהכניסה נכשלה. הפונקציה הזו לא מקבלת ארגומנטים (ברירת מחדל: ללא).

מסננים מתקדמים

gapi.auth2.הרשאה(params, callback)

מבצעת הרשאת OAuth 2.0 חד-פעמית. בהתאם לפרמטרים שבהם נעשה שימוש, תיפתח חלון קופץ לתהליך הכניסה ל-Google או לנסות לטעון את התשובה המבוקשת בשקט, בלי אינטראקציה של המשתמש.

הנה מספר תרחישים לדוגמה שבהם השיטה הזו שימושית:

  • האפליקציה צריכה לבקש נקודת קצה ב-Google API רק פעם אחת, לדוגמה כדי לטעון בסרטוני YouTube המועדפים על המשתמש בפעם הראשונה שהוא נכנס.
  • לאפליקציה יש תשתית משלה לניהול סשנים, וצריך רק אסימון המזהה פעם אחת לצורך זיהוי המשתמש בקצה העורפי.
  • באותו דף נעשה שימוש בכמה מזהי לקוח.
ארגומנטים
params אובייקט שמכיל צמדי מפתח/ערך של נתוני הגדרות אישיות. צפייה gapi.auth2.AuthorizeConfig ל- מאפיינים שונים שניתנים להגדרה. מוצרים לדוגמה: 
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}
callback פונקציה שנקראה עם רכיב אובייקט אחד (gapi.auth2.AuthorizeResponse) לאחר שהבקשה הושלמה (בהצלחה או נכשלת).

דוגמה

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

קודי שגיאה

idpiframe_initialization_failed
לא ניתן לאתחל iframe נדרש מ-Google, למשל עקב בעיה לא נתמכת הסביבה. המאפיין details יספק מידע נוסף על השגיאה שהעלית.
popup_closed_by_user
המשתמש סגר את החלון הקופץ לפני שסיים את תהליך הכניסה לחשבון.
access_denied
המשתמש דחה את ההרשאה להיקפי ההרשאות הנדרשים.
immediate_failed
לא ניתן היה לבחור אף משתמש באופן אוטומטי בלי להציג בקשה לתהליך ההסכמה. התעוררה שגיאה כאשר באמצעות signIn עם אפשרות prompt: 'none'.

gapi.auth2.AuthorizeConfig

ממשק שמייצג את הפרמטרים השונים של התצורה אמצעי תשלום אחד (gapi.auth2.authorize).

מאפיינים
client_id string נדרש. מזהה הלקוח של האפליקציה, שנמצא ונוצר במסוף Google API.
scope string נדרש. ההיקפים שצריך לבקש, כמחרוזת מופרדת ברווחים.
response_type string רשימה של סוגי תגובות שמופרדים ברווחים. ברירת המחדל היא 'permission'. האפשרות הם:
  • id_token, כדי לאחזר אסימון מזהה
  • permission (או token), כדי לאחזר אסימון גישה
  • code, כדי לאחזר קוד הרשאה
prompt string המערכת אוכפת מצב ספציפי בתהליך ההסכמה. הערכים האפשריים הם:
  • consent
    שרת ההרשאות מבקש מהמשתמש הסכמה לפני שחוזר מידע לאפליקציה.
  • select_account
    שרת ההרשאות מבקש מהמשתמש לבחור חשבון Google. הזה משתמש שיש לו כמה חשבונות יכול לבחור מבין כמה חשבונות שאולי יש להם סשנים נוכחיים.
  • none
    שרת ההרשאות לא יציג אימות או הסכמת משתמשים מסכים; היא תחזיר שגיאה אם המשתמש עדיין לא מאומת לא הסכים בעבר להיקפי ההרשאות המבוקשים.
    אם תתקבל בקשה של code כסוג התגובה, הקוד שיוחזר יהיה רק שניתן להחליף ב-access_token, ולא ב-refresh_token.
cookie_policy string הדומיינים שעבורם יש ליצור קובצי cookie לכניסה. זהו URI, single_host_origin או none. ברירת המחדל היא single_host_origin אם לא צוין.
hosted_domain string הדומיין ב-G Suite שאליו המשתמשים צריכים להשתייך כדי להיכנס לחשבון. המוצר הזה עלול להוביל לשינויים ולכן עליכם לאמת את נכס הדומיין המתארח של המשתמש שמוחזר.
login_hint string כתובת האימייל, או User ID, של משתמש לבחירה מראש בתהליך הכניסה. הוא עלול לחשוף שונה על ידי המשתמש, אלא אם נעשה שימוש ב-prompt: "none".
include_granted_scopes boolean האם לבקש אסימון גישה שכולל את כל היקפי ההרשאות שהמשתמש נתן בעבר לאפליקציה, או רק להיקפי ההרשאות שנדרשים בשיחה הנוכחית. ברירת המחדל היא true.
enable_granular_consent boolean זה שינוי אופציונלי. האם להפעיל מגורען הרשאות. אם המדיניות מוגדרת לערך false, הבדיקה של Google ברמת פירוט גבוהה יותר. ההרשאות בחשבון יושבתו עבור מזהי לקוח ב-OAuth שנוצרו לפני כן 2019. אין השפעה על מזהי לקוחות של OAuth שנוצרו במהלך 2019 או לאחר מכן, מאז הרשאות מפורטות יותר תמיד מופעלות עבורו.
plugin_name string זה שינוי אופציונלי. אם המדיניות מוגדרת, מזהי לקוח שנוצרו לפני 29 ביולי 2022 יכולים להשתמש ב ספריית הפלטפורמה של Google. כברירת מחדל, מזהי Client-ID חדשים שנוצרים חסומים להשתמש בספריית הפלטפורמה, ובמקום זאת להשתמש בגרסה החדשה יותר של Google ספריית שירותי הזהויות. ניתן לבחור כל ערך, שם תיאורי כגון שם המוצר או הפלאגין, כדי לזהות בקלות. לדוגמה: plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AuthorizeResponse

התשובה הוחזרה לקריאה חוזרת (callback) של אמצעי תשלום אחד (gapi.auth2.authorize).

מאפיינים
access_token string אסימון הגישה הוענק. מוצג רק אם permission או token היו שצוין בresponse_type.
id_token string האסימון המזהה מוענק. מוצג רק אם צוין id_token בשדה response_type.
code string קוד ההרשאה הוענק. מוצג רק אם צוין code בשדה response_type.
scope string היקפי ההרשאות שהוענקו באסימון הגישה. מוצג רק אם permission או השדה token צוין בresponse_type.
expires_in number מספר השניות עד שיפוג התוקף של אסימון הגישה. הצגה רק אם permission או token צוין בresponse_type.
first_issued_at number חותמת הזמן שבה המשתמש נתן בפעם הראשונה את היקפי ההרשאות המבוקשים. הצגה רק אם השדה permission או token צוין בresponse_type.
expires_at number חותמת הזמן שבה יפוג תוקף אסימון הגישה. הצגה רק אם permission או token צוין בresponse_type.
error string אם הבקשה נכשלה, היא מכילה את קוד שגיאה.
error_subtype string אם הבקשה נכשלה, הוא עשוי לכלול מידע נוסף על קוד השגיאה הוחזרו.