此參考資料說明您將用來在網路應用程式中實作 Google 登入功能的 JavaScript 用戶端方法和屬性。
如果您在使用程式庫時發生任何問題,請回報至 GitHub 存放區。
驗證設定
載入 Google API 平台程式庫來建立 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 用戶端 ID 設定物件,以及要指定的任何其他選項。然後,如果使用者已登入,GoogleAuth
物件就會還原上一個工作階段的登入狀態。
引數 | |
---|---|
params |
包含用戶端設定資料鍵/值組合的物件。如要瞭解可設定的不同屬性,請參閱 gapi.auth2.ClientConfig 。例如: { client_id: 'CLIENT_ID.apps.googleusercontent.com' } |
傳回 | |
---|---|
gapi.auth2.GoogleAuth |
gapi.auth2.GoogleAuth 物件。使用 then() 方法,取得在 gapi.auth2.GoogleAuth 物件完成初始化時解析的 Promise。
|
GoogleAuth.then(onInit, onError)
在 GoogleAuth
物件完全初始化時呼叫 onInit 函式。如果在初始化時發生錯誤 (可能發生在舊版不支援的瀏覽器中),系統會改為呼叫 onError 函式。
引數 | |
---|---|
onInit |
完整初始化時,透過 GoogleAuth 物件呼叫的函式。 |
onError |
如果 GoogleAuth 無法初始化,包含 error 屬性的物件所呼叫的函式。 |
傳回 | |
---|---|
承諾 | Promise 會在 onInit 函式完成時完成的;如果初始化初始化錯誤,則會拒絕。它會使用 onInit 函式傳回的值解析 (如果有的話)。 |
錯誤代碼
idpiframe_initialization_failed
-
因為 Google 無法支援必要的 iframe,例如受到不支援的環境影響。
details
屬性會提供所回報錯誤的詳細資訊。
gapi.auth2.ClientConfig
這個介面代表 gapi.auth2.init
方法的不同設定參數。
參數 | ||
---|---|---|
client_id |
string |
必填。在 Google Developers Console 中找到及建立應用程式的用戶端 ID。 |
cookie_policy |
string |
要建立登入 Cookie 的網域。URI、single_host_origin 或 none 。若未指定,預設會使用 single_host_origin 。 |
scope |
string |
要要求的範圍 (以空格分隔的字串)。如果 fetch_basic_profile 未設為 false,則為選用欄位。 |
fetch_basic_profile |
boolean |
在使用者登入時擷取基本個人資料。將「profile」、「email」和「openid」新增至要求的範圍。如未指定,則傳回 True。 |
hosted_domain |
string |
使用者必須登入的 G Suite 網域。這可能會遭到用戶端修改,因此請務必驗證回傳使用者的代管網域屬性。在用戶端使用 GoogleUser.getHostedDomain() 和伺服器 ID 憑證中的 hd 憑證附加資訊,即可驗證您的網域是否符合您的預期。 |
ux_mode |
string |
登入流程使用的使用者體驗模式。根據預設,系統會在彈出式視窗中開啟同意聲明流程。有效值為 popup 和 redirect 。 |
redirect_uri |
string |
如果使用 ux_mode='redirect' ,這個參數可讓您覆寫將在同意聲明流程結束時使用的預設 redirect_uri 。預設的 redirect_uri 是去除查詢參數與雜湊片段的現有網址。 |
plugin_name |
string |
選填欄位,設定這個值之後,2022 年 7 月 29 日前建立的新用戶端 ID 都能使用舊版的 Google Platform 程式庫。根據預設,新建立的用戶端 ID 已遭封鎖,無法使用平台程式庫,請改用新版 Google Identity 服務程式庫。您可以選擇任何值,建議您以描述性的名稱 (例如產品或外掛程式名稱) 來識別。
範例:plugin_name: 'YOUR_STRING_HERE' |
驗證
GoogleAuth
是一個單例模式,可讓使用者透過 Google 帳戶登入、取得使用者的目前登入狀態、從使用者的 Google 個人資料取得特定資料、要求其他範圍,以及從目前的帳戶登出。
gapi.auth2.getAuthInstance()
傳回 GoogleAuth
物件。您必須先使用 gapi.auth2.init()
初始化 GoogleAuth
物件,才能呼叫這個方法。
傳回 | |
---|---|
gapi.auth2.GoogleAuth |
gapi.auth2.GoogleAuth 物件。請使用這個物件呼叫 gapi.auth2.GoogleAuth 的方法。 |
GoogleAuth.isSignedIn.get()
傳回目前的使用者目前是否登入。
傳回 | |
---|---|
布林值 |
true 表示使用者已登出;如使用者已登出或 GoogleAuth 物件未初始化,則為 false 。 |
GoogleAuth.isSignedIn.listen(listener)
注意目前登入使用者的狀態。
引數 | |
---|---|
listener |
使用布林值的函式。listen() 會在使用者登入時將 true 傳遞至這個函式,並在使用者登出時傳遞 false 。 |
GoogleAuth.signIn()
使用指定 gapi.auth2.init()
的選項登入使用者帳戶。
傳回 | |
---|---|
承諾 | 當使用者成功驗證並授予要求的範圍時,透過 GoogleUser 例項完成的 Promise ;如果發生錯誤,則拒絕包含包含 error 屬性的物件 (請參閱下方的錯誤代碼)。 |
錯誤代碼
查看《GoogleAuth.signIn(options)
》。
GoogleAuth.signIn(options)
使用指定選項登入使用者。
引數 | |
---|---|
options |
選擇下列任一做法:
|
傳回 | |
---|---|
承諾 | 當使用者成功驗證並授予要求的範圍時,透過 GoogleUser 例項完成的 Promise ;如果發生錯誤,則拒絕包含包含 error 屬性的物件 (請參閱下方的錯誤代碼)。 |
錯誤代碼
popup_closed_by_user
- 使用者在完成登入流程前就關閉彈出式視窗。
access_denied
- 使用者拒絕存取所需範圍的權限。
immediate_failed
-
在不顯示同意聲明流程的情況下,系統不會自動選取任何使用者。搭配
prompt: 'none'
選項使用signIn
時,發生錯誤。請勿使用此選項,因為gapi.auth2.init
會在使用者之前登入之前,自動登入。
gapi.auth2.SignInOptions
這個介面代表 GoogleAuth.signIn(options)
方法的不同設定參數。
參數 | ||
---|---|---|
prompt |
string |
針對同意聲明流程強制執行特定模式。選用。 可能的值包括:
|
scope |
string |
要要求的範圍 (以空格分隔的字串) 會顯示在 gapi.auth2.init 參數中定義的範圍之上。如果 fetch_basic_profile 未設為 false,則為選用欄位。
|
ux_mode |
string |
登入流程使用的使用者體驗模式。根據預設,系統會在彈出式視窗中開啟同意聲明流程。有效值為 popup 和 redirect 。 |
redirect_uri |
string |
如果使用 ux_mode='redirect' ,這個參數可讓您覆寫將在同意聲明流程結束時使用的預設 redirect_uri 。預設的 redirect_uri 是去除查詢參數與雜湊片段的目前網址。 |
GoogleAuth.signOut()
從應用程式登出目前的帳戶。
傳回 | |
---|---|
承諾 | 在使用者登出後完成的 Promise 。 |
GoogleAuth.disconnect()
撤銷使用者授予的所有範圍。
GoogleAuth.grantOfflineAccess(options)
必須取得使用者的許可,才能離線存取指定範圍。
引數 | |
---|---|
options |
包含參數值組合的 gapi.auth2.OfflineAccessOptions 物件。例如: { scope: 'profile email' } |
傳回 | |
---|---|
承諾 | 使用者授予要求範圍時完成的 Promise ,將包含授權碼的物件傳送至 Promise 的出貨處理常式。例如: auth2.grantOfflineAccess().then(function(resp) { var auth_code = resp.code; }); |
錯誤代碼
popup_closed_by_user
- 使用者在完成同意聲明流程前,就已經關閉彈出式視窗。
access_denied
- 使用者拒絕存取所需範圍的權限。
immediate_failed
-
在不顯示同意聲明流程的情況下,系統不會自動選取任何使用者。搭配
prompt: 'none'
選項使用signIn
時,發生錯誤。請勿使用此選項,因為gapi.auth2.init
會在使用者之前登入之前,自動登入。
gapi.auth2.OfflineAccessOptions
這個介面代表 GoogleAuth.grantOfflineAccess(options)
方法的不同設定參數。
參數 | ||
---|---|---|
prompt |
string |
針對同意聲明流程強制執行特定模式。選用。 可能的值包括:
|
scope |
string |
要要求的範圍 (以空格分隔的字串) 會顯示在 gapi.auth2.init 參數中定義的範圍之上。如果 fetch_basic_profile 未設為 false,則為選用欄位。
|
GoogleAuth.attachClickHandler(container、options、onsuccess、onfailure)
將登入流程附加至指定容器的點擊處理常式。
引數 | |
---|---|
container | 要附加點擊處理常式的 div 元素的 ID 或參照。 |
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 參數的函式。
每次修改 currentUser 時,listen 都會向這個函式傳遞 GoogleUser 例項。 |
GoogleUser.getId()
取得使用者的專屬 ID 字串。
傳回 | |
---|---|
字串 | 使用者的專屬 ID |
GoogleUser.isSignedIn()
若使用者登入,則傳回 True。
傳回 | |
---|---|
布林值 | 若使用者已登入,則傳回 True |
GoogleUser.getHostedDomain()
如果使用者的 G Suite 帳戶已登入,即可取得 G Suite 網域。
傳回 | |
---|---|
字串 | 使用者的 G Suite 網域 |
GoogleUser.getGrantedScopeScopes()
取得使用者以空格分隔字串授予的範圍。
傳回 | |
---|---|
字串 | 使用者授予的範圍 |
GoogleUser.getBasicProfile()
取得使用者的基本設定檔資訊。
傳回 | |
---|---|
gapi.auth2.BasicProfile |
您可以使用下列方法擷取 gapi.auth2.BasicProfile 的屬性:
|
GoogleUser.getAuthResponse(includeAuthorizationData)
從使用者的驗證工作階段取得回應物件。
引數 | |
---|---|
includeAuthorizationData | 選用:這個布林值會指定是否要一律傳回存取權杖和範圍。根據預設,當 fetch_basic_profile 為 true (預設值) 且未要求其他範圍時,系統不會傳回存取權杖和要求範圍。 |
傳回 | |
---|---|
gapi.auth2.AuthResponse |
gapi.auth2.AuthResponse 物件。 |
GoogleUser.reloadAuthResponse()
強制重新整理存取權杖,然後針對新的 AuthResponse 傳回 Promise。
傳回 | |
---|---|
Promise |
重新載入 OAuth 憑證後,透過重新載入的 gapi.auth2.AuthResponse 完成的 Promise 。 |
gapi.auth2.AuthResponse
呼叫 GoogleUser.getAuthResponse(includeAuthorizationData)
或 GoogleUser.reloadAuthResponse()
方法時傳回的回應。
屬性 | ||
---|---|---|
access_token |
string |
已授予存取憑證。 |
id_token |
string |
已授予的 ID 憑證。 |
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()
撤銷使用者授予應用程式的所有範圍。
UI 元素
gapi.signin2.render(id、options)
使用 options 物件指定的設定,在具有指定 ID 的元素轉譯登入按鈕。
引數 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | 顯示登入按鈕的元素 ID。 | ||||||||||||||||
options |
包含用來顯示按鈕的設定的物件。例如:
{ scope: 'email', width: 200, height: 50, longtitle: true, theme: 'dark', onsuccess: handleSuccess, onfailure: handleFailure }您可以指定下列選項:
|
進階
gapi.auth2.authorization(params, callback)
執行一次性 OAuth 2.0 授權。視使用的參數而定,這會開啟 Google 登入流程的彈出式視窗,或嘗試以無訊息方式載入要求的回應,使用者無需進行任何操作。
這個方法相當實用的情況包括:
- 應用程式只需要要求 Google API 端點一次,例如,第一次登入時就載入使用者最喜愛的 YouTube 影片。
- 您的應用程式有自己的工作階段管理基礎架構,而且只需要在 ID 中識別一次使用者,以便在後端識別使用者。
- 同一個網頁中使用了多個用戶端 ID。
引數 | |
---|---|
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
-
因為 Google 無法支援必要的 iframe,例如受到不支援的環境影響。
details
屬性會提供所回報錯誤的詳細資訊。 popup_closed_by_user
- 使用者在完成登入流程前就關閉彈出式視窗。
access_denied
- 使用者拒絕存取所需範圍的權限。
immediate_failed
-
在不顯示同意聲明流程的情況下,系統不會自動選取任何使用者。將
signIn
與prompt: 'none'
選項搭配使用時,發生錯誤。
gapi.auth2.AuthorizeConfig
這個介面代表 gapi.auth2.authorize
方法的不同設定參數。
屬性 | ||
---|---|---|
client_id |
string |
必備。在 Google Developers Console 中找到及建立應用程式的用戶端 ID。 |
scope |
string |
必備。要要求的範圍 (以空格分隔的字串)。 |
response_type |
string |
以空格分隔的回應類型清單。預設為 'permission' 。可能的值包括:
|
prompt |
string |
針對同意聲明流程強制執行特定模式。可能的值包括:
|
cookie_policy |
string |
要建立登入 Cookie 的網域。URI、single_host_origin 或 none 。若未指定,預設會使用 single_host_origin 。 |
hosted_domain |
string |
使用者必須登入的 G Suite 網域。用戶端容易修改,因此請務必驗證傳回使用者的代管網域資源。 |
login_hint |
string |
在登入流程中預先選取的使用者電子郵件地址 (或使用者 ID)。除非使用 prompt: "none" ,否則使用者容易修改。
|
include_granted_scopes |
boolean |
要求存取存取憑證,其中含有使用者先前授予應用程式的所有範圍,或僅包含目前呼叫中要求的範圍。這個變數預設為 true 。
|
plugin_name |
string |
選填欄位,如有設定,2022 年 7 月 29 日前建立的用戶端 ID 可以使用 Google 平台程式庫。根據預設,新建立的用戶端 ID 會禁止使用 Platform Library,而必須改用新版 Google Identity 服務程式庫。您可以選擇任何值,建議使用方便識別的名稱 (例如產品或外掛程式名稱)。範例:plugin_name: 'YOUR_STRING_HERE' |
gapi.auth2.AuthorizeResponse
傳回到 gapi.auth2.authorize
方法回呼的回應。
屬性 | ||
---|---|---|
access_token |
string |
已授予存取權杖。只有在 response_type 中指定了 permission 或 token 時,系統才會顯示這個選項。
|
id_token |
string |
已授予 ID 憑證。只有在 response_type 中指定 id_token 時才會顯示。 |
code |
string |
授權碼已授予。只有在 response_type 中指定 code 時才會顯示。 |
scope |
string |
存取權仗授予的範圍。只有在 response_type 中指定了 permission 或 token 時,系統才會顯示這個選項。
|
expires_in |
number |
存取權杖到期前的秒數。只有在 response_type 中指定了 permission 或 token 時,系統才會顯示這個選項。
|
first_issued_at |
number |
使用者首次授予要求範圍的時間戳記。只有在 response_type 中指定了 permission 或 token 時,系統才會顯示這個選項。
|
expires_at |
number |
存取權仗的時間戳記。只有在 response_type 中指定了 permission 或 token 時,系統才會顯示這個選項。
|
error |
string |
要求失敗時,包含錯誤代碼。 |
error_subtype |
string |
要求失敗時,也可能會包含傳回錯誤代碼的額外資訊。 |