Trang này được dịch bởi Cloud Translation API.

Tài liệu tham khảo về ứng dụng JavaScript đăng nhập bằng Google

Tài liệu tham khảo này mô tả các thuộc tính và phương thức ứng dụng JavaScript mà bạn sẽ dùng để triển khai tính năng Đăng nhập bằng Google trong các ứng dụng web của mình.

Nếu bạn gặp vấn đề khi sử dụng thư viện, hãy báo cáo cho kho lưu trữ GitHub của chúng tôi.

Thiết lập tính năng xác thực

Tải thư viện nền tảng API Google để tạo đối tượng gapi:

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

Sau khi thư viện nền tảng tải, hãy tải thư viện auth2:

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

gapi.auth2.init(`params`)

Khởi động đối tượng GoogleAuth. Bạn phải gọi phương thức này trước khi gọi các phương thức của gapi.auth2.GoogleAuth.

Khi khởi động đối tượng GoogleAuth, bạn sẽ định cấu hình đối tượng bằng mã ứng dụng khách OAuth 2.0 và mọi lựa chọn khác mà bạn muốn chỉ định. Sau đó, nếu người dùng đã đăng nhập, đối tượng GoogleAuth sẽ khôi phục trạng thái đăng nhập của người dùng từ phiên trước đó.

Đối số
`params`	Đối tượng chứa các cặp khoá-giá trị của dữ liệu cấu hình ứng dụng. Hãy xem `gapi.auth2.ClientConfig` để biết các thuộc tính có thể định cấu hình. Ví dụ: { client_id: 'CLIENT_ID.apps.googleusercontent.com' }

Giá trị trả về
`gapi.auth2.GoogleAuth`	Đối tượng `gapi.auth2.GoogleAuth`. Sử dụng phương thức then() để nhận Promise được phân giải khi đối tượng `gapi.auth2.GoogleAuth` hoàn tất quá trình khởi chạy.

GoogleAuth.the(`onInit`; `onError`)

Gọi hàm onInit khi đối tượng GoogleAuth được khởi động đầy đủ. Nếu xảy ra lỗi trong khi khởi chạy (tình trạng này có thể xảy ra trong các trình duyệt cũ không được hỗ trợ), thì hàm onError sẽ được gọi.

Đối số
`onInit`	Hàm được gọi bằng đối tượng `GoogleAuth` khi đối tượng này được khởi động hoàn toàn.
`onError`	Hàm được gọi bằng một đối tượng chứa thuộc tính `error`, nếu `GoogleAuth` không khởi chạy được.

Giá trị trả về
Lời hứa	Một `Promise` được thực hiện khi hàm `onInit` hoàn tất hoặc bị từ chối nếu xảy ra lỗi khởi động. Thao tác này sẽ phân giải bằng giá trị được trả về từ hàm `onInit`, nếu có.

Cảnh báo: không gọi Promise.resolve() và tương tự bằng kết quả của gapi.auth2.init(). Vì đối tượng GoogleAuth được trả về sẽ triển khai phương thức then() tự phân giải với chính đối tượng này, nên đối tượng này sẽ tạo ra một đệ quy vô hạn.

Mã lỗi

idpiframe_initialization_failed: Không khởi chạy được iframe bắt buộc từ Google, ví dụ: do một môi trường không được hỗ trợ. Thuộc tính details sẽ cung cấp thêm thông tin về lỗi phát sinh.

gapi.auth2.ClientConfig

Giao diện đại diện cho các tham số cấu hình khác nhau của phương thức gapi.auth2.init.

Thông số
`client_id`	`string`	Bắt buộc. Mã ứng dụng khách của ứng dụng (được tìm thấy và tạo trong Google API Console).
`cookie_policy`	`string`	Các miền để tạo cookie đăng nhập. URI, `single_host_origin` hoặc `none`. Giá trị mặc định là `single_host_origin` nếu bạn không chỉ định.
`scope`	`string`	Các phạm vi cần yêu cầu, dưới dạng chuỗi được phân tách bằng dấu cách. Không bắt buộc nếu bạn không đặt `fetch_basic_profile` thành false.
`fetch_basic_profile`	`boolean`	Tìm nạp thông tin hồ sơ cơ bản của người dùng khi họ đăng nhập. Thêm "profile", "email" và "openid" vào phạm vi được yêu cầu. Đúng nếu bạn không chỉ định.
`hosted_domain`	`string`	Miền G Suite mà người dùng phải đăng nhập. Ứng dụng khách có thể sửa đổi tài sản này. Vì vậy, hãy nhớ xác minh tài sản miền được lưu trữ của người dùng được trả về. Sử dụng GoogleUser.getHostedDomain() trên máy khách và xác nhận quyền sở hữu `hd` trong Mã thông báo mã nhận dạng trên máy chủ để xác minh miền đúng như bạn mong đợi. Bạn phải yêu cầu phạm vi `'email'` khi sử dụng tham số này cùng với `fetch_basic_profile: false`.
`use_fedcm`	`boolean`	Không bắt buộc, giá trị mặc định là `True`. Bật hoặc tắt việc sử dụng API FedCM của trình duyệt trong quá trình đăng nhập.
`ux_mode`	`string`	Chế độ trải nghiệm người dùng sử dụng cho quy trình đăng nhập. Theo mặc định, thao tác này sẽ mở quy trình đồng ý trong cửa sổ bật lên. Các giá trị hợp lệ là `popup` và `redirect`.
`redirect_uri`	`string`	Nếu sử dụng `ux_mode='redirect'`, thông số này cho phép bạn ghi đè `redirect_uri` mặc định sẽ được sử dụng ở cuối quy trình đồng ý. `redirect_uri` mặc định là URL hiện tại đã loại bỏ các tham số truy vấn và mảnh băm.
`enable_granular_consent`	`boolean`	Không bắt buộc. Liệu có bật các quyền chi tiết hay không. Nếu bạn đặt thành `false`, các quyền đối với Tài khoản Google chi tiết hơn sẽ bị vô hiệu hoá đối với những mã ứng dụng khách OAuth được tạo trước năm 2019. Các mã ứng dụng OAuth được tạo trong hoặc sau năm 2019 sẽ không bị ảnh hưởng vì luôn bật các quyền chi tiết hơn cho các mã ứng dụng này.
`plugin_name`	`string`	Không bắt buộc. Nếu bạn đặt giá trị này, thì các mã ứng dụng khách mới tạo trước ngày 29 tháng 7 năm 2022 có thể sử dụng Thư viện Google Platform cũ. Theo mặc định, các mã ứng dụng khách mới tạo hiện sẽ bị chặn sử dụng Thư viện nền tảng và phải dùng thư viện Dịch vụ nhận dạng mới của Google. Bạn có thể chọn bất kỳ giá trị nào. Bạn nên sử dụng tên mô tả, chẳng hạn như tên sản phẩm hoặc trình bổ trợ để nhận dạng. Ví dụ: `plugin_name: 'YOUR_STRING_HERE'`

Xác thực

GoogleAuth là một lớp singleton cung cấp các phương thức để cho phép người dùng đăng nhập bằng Tài khoản Google, lấy trạng thái đăng nhập hiện tại của người dùng, nhận dữ liệu cụ thể từ hồ sơ trên Google của người dùng, yêu cầu phạm vi bổ sung và đăng xuất khỏi tài khoản hiện tại.

gapi.auth2.getAuthInstance()

Trả về đối tượng GoogleAuth. Bạn phải khởi tạo đối tượng GoogleAuth bằng gapi.auth2.init() trước khi gọi phương thức này.

Giá trị trả về
`gapi.auth2.GoogleAuth`	Đối tượng `gapi.auth2.GoogleAuth`. Hãy sử dụng đối tượng này để gọi các phương thức của `gapi.auth2.GoogleAuth`.

GoogleAuth.isSignedIn.get()

Trả về việc liệu người dùng hiện tại đã đăng nhập hay chưa.

Giá trị trả về
Boolean	`true` nếu người dùng đã đăng nhập hoặc `false` nếu người dùng đã đăng xuất hoặc đối tượng `GoogleAuth` chưa được khởi chạy.

GoogleAuth.isSignedIn.listen(listener)

Theo dõi những thay đổi trong trạng thái đăng nhập của người dùng hiện tại.

Đối số
`listener`	Một hàm nhận giá trị boolean. `listen()` sẽ chuyển `true` đến hàm này khi người dùng đăng nhập và truyền `false` khi người dùng đăng xuất.

GoogleAuth.signIn()

Đăng nhập cho người dùng bằng các tuỳ chọn được chỉ định cho gapi.auth2.init().

Giá trị trả về
Lời hứa	Một `Promise` được thực hiện bằng thực thể `GoogleUser` khi người dùng xác thực và cấp thành công các phạm vi được yêu cầu, hoặc từ chối bằng một đối tượng chứa thuộc tính `error` nếu có lỗi xảy ra. Hãy xem phần tiếp theo để biết mã lỗi.

Mã lỗi

Vui lòng xem GoogleAuth.signIn(options).

GoogleAuth.signIn(`options`)

Đăng nhập vào tài khoản người dùng bằng các tuỳ chọn được chỉ định.

Đối số

Đối số
`options`	Hoặc: Đối tượng `gapi.auth2.SignInOptions` chứa các cặp khoá-giá trị của tham số đăng nhập. Ví dụ: { scope: 'profile email' } Một bản sao của `gapi.auth2.SigninOptionsBuilder`. Ví dụ: options = new gapi.auth2.SigninOptionsBuilder(); options.setAppPackageName('com.example.app'); options.setFetchBasicProfile(True); options.setPrompt('select_account'); options.setScope('profile').setScope('email');

options

Hoặc:

Đối tượng gapi.auth2.SignInOptions chứa các cặp khoá-giá trị của tham số đăng nhập. Ví dụ:
```
{
  scope: 'profile email'
}
```

Một bản sao của gapi.auth2.SigninOptionsBuilder. Ví dụ:

options = new gapi.auth2.SigninOptionsBuilder();
options.setAppPackageName('com.example.app');
options.setFetchBasicProfile(True);
options.setPrompt('select_account');
options.setScope('profile').setScope('email');

Giá trị trả về
Lời hứa	Một `Promise` được thực hiện bằng thực thể `GoogleUser` khi người dùng xác thực và cấp thành công các phạm vi được yêu cầu, hoặc bị từ chối bằng một đối tượng chứa thuộc tính `error` nếu có lỗi xảy ra (xem mã lỗi ở bên dưới).

Mã lỗi

popup_closed_by_user: Người dùng đóng cửa sổ bật lên trước khi hoàn tất quy trình đăng nhập.
access_denied: Người dùng đã từ chối cấp quyền đối với các phạm vi bắt buộc.
immediate_failed: Không thể chọn tự động người dùng nào nếu không nhắc quy trình đồng ý. Đã xảy ra lỗi khi sử dụng signIn với tuỳ chọn prompt: 'none'. Bạn không cần sử dụng tuỳ chọn này, vì gapi.auth2.init sẽ tự động đăng nhập người dùng nếu trước đó đã đăng nhập trong phiên trước đó.

gapi.auth2.SignInOptions

Giao diện đại diện cho các tham số cấu hình khác nhau của phương thức GoogleAuth.signIn(options).

Thông số
`prompt`	`string`	Buộc áp dụng một chế độ cụ thể cho quy trình đồng ý. Không bắt buộc. Các giá trị có thể có là: `consent` Máy chủ uỷ quyền sẽ nhắc người dùng đồng ý trước khi trả về thông tin cho ứng dụng. `select_account` Máy chủ uỷ quyền sẽ nhắc người dùng chọn một Tài khoản Google. Điều này cho phép người dùng có nhiều tài khoản chọn trong số nhiều tài khoản mà họ có thể có các phiên hiện tại. `none` (không nên) Máy chủ uỷ quyền sẽ không hiển thị bất kỳ màn hình xác thực hoặc màn hình xin phép người dùng nào; máy chủ này sẽ trả về lỗi nếu người dùng chưa được xác thực và chưa từng đồng ý với các phạm vi đã yêu cầu. Vì `gapi.auth2.init` sẽ tự động đăng nhập người dùng vào ứng dụng nếu trước đó đã đăng nhập, nên việc gọi `signIn({prompt: 'none'})` thường không thành công.
`scope`	`string`	Các phạm vi cần yêu cầu, ở dạng chuỗi được phân tách bằng dấu cách, ngoài các phạm vi được xác định trong tham số `gapi.auth2.init`. Không bắt buộc nếu bạn không đặt `fetch_basic_profile` thành false.
`ux_mode`	`string`	Chế độ trải nghiệm người dùng sử dụng cho quy trình đăng nhập. Theo mặc định, thao tác này sẽ mở quy trình đồng ý trong cửa sổ bật lên. Các giá trị hợp lệ là `popup` và `redirect`.
`redirect_uri`	`string`	Nếu sử dụng `ux_mode='redirect'`, thông số này cho phép bạn ghi đè `redirect_uri` mặc định sẽ được sử dụng ở cuối quy trình đồng ý. `redirect_uri` mặc định là URL hiện tại đã được loại bỏ các tham số truy vấn và mảnh băm.

GoogleAuth.signOut()

Đăng xuất tài khoản hiện tại khỏi ứng dụng.

Giá trị trả về
Lời hứa	`Promise` được thực hiện khi người dùng đăng xuất.

GoogleAuth.disconnect()

Thu hồi tất cả phạm vi mà người dùng đã cấp.

GoogleAuth.AuthOfflineAccess(`options`)

Yêu cầu người dùng cho phép truy cập vào các phạm vi đã chỉ định khi không có mạng.

Đối số
`options`	Đối tượng `gapi.auth2.OfflineAccessOptions` chứa các cặp tham số khoá-giá trị. Ví dụ: { scope: 'profile email' }

Giá trị trả về
Lời hứa	Một `Promise` được thực hiện khi người dùng cấp các phạm vi được yêu cầu, truyền một đối tượng chứa mã uỷ quyền đến trình xử lý phương thức thực hiện của `Promise`. Ví dụ: auth2.grantOfflineAccess().then(function(resp) { var auth_code = resp.code; });

Mã lỗi

popup_closed_by_user: Người dùng đóng cửa sổ bật lên trước khi hoàn tất quy trình đồng ý.
access_denied: Người dùng đã từ chối cấp quyền đối với các phạm vi bắt buộc.
immediate_failed: Không thể chọn tự động người dùng nào nếu không nhắc quy trình đồng ý. Đã xảy ra lỗi khi sử dụng signIn với tuỳ chọn prompt: 'none'. Bạn không bắt buộc phải sử dụng tuỳ chọn này, vì gapi.auth2.init sẽ tự động đăng nhập người dùng nếu người dùng từng đăng nhập trong phiên trước đó.

gapi.auth2.OfflineAccessOptions

Giao diện đại diện cho các tham số cấu hình khác nhau của phương thức GoogleAuth.grantOfflineAccess(options).

Thông số
`prompt`	`string`	Buộc áp dụng một chế độ cụ thể cho quy trình đồng ý. Không bắt buộc. Các giá trị có thể có là: `consent` Máy chủ uỷ quyền sẽ nhắc người dùng đồng ý trước khi trả về thông tin cho ứng dụng. `select_account` Máy chủ uỷ quyền sẽ nhắc người dùng chọn một Tài khoản Google. Điều này cho phép người dùng có nhiều tài khoản chọn trong số nhiều tài khoản mà họ có thể có các phiên hiện tại. Xin lưu ý rằng `none` không áp dụng cho quy trình mã ngoại tuyến.
`scope`	`string`	Các phạm vi cần yêu cầu, ở dạng chuỗi được phân tách bằng dấu cách, ngoài các phạm vi được xác định trong tham số `gapi.auth2.init`. Không bắt buộc nếu bạn không đặt `fetch_basic_profile` thành false.

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

Đính kèm luồng đăng nhập vào trình xử lý lượt nhấp của vùng chứa được chỉ định.

Đối số
`container`	Mã nhận dạng hoặc tham chiếu đến phần tử `div` để đính kèm trình xử lý lượt nhấp.
`options`	Đối tượng chứa các cặp thông số khoá-giá trị. Hãy xem GoogleAuth.signIn().
`onsuccess`	Hàm gọi sau khi đăng nhập xong.
`onfailure`	Hàm gọi khi không đăng nhập được.

Người dùng

Đối tượng GoogleUser đại diện cho một tài khoản người dùng. Các đối tượng GoogleUser thường được lấy bằng cách gọi GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

Trả về một đối tượng GoogleUser đại diện cho người dùng hiện tại. Xin lưu ý rằng trong phiên bản GoogleAuth mới khởi tạo, người dùng hiện tại chưa được đặt. Sử dụng phương thức currentUser.listen() hoặc GoogleAuth.then() để tạo thực thể GoogleAuth đã khởi tạo.

Giá trị trả về
`GoogleUser`	Người dùng hiện tại

GoogleAuth.currentUser.listen(`listener`)

Theo dõi các thay đổi trong currentUser.

Đối số
`listener`	Một hàm nhận tham số `GoogleUser`. `listen` truyền hàm này một thực thể `GoogleUser` trên mọi thay đổi sửa đổi `currentUser`.

GoogleUser.getId()

Lấy chuỗi mã nhận dạng duy nhất của người dùng.

Không sử dụng mã nhận dạng của Google do getId() trả về để giao tiếp người dùng đã đăng nhập với máy chủ phụ trợ. Thay vào đó, hãy gửi mã thông báo mã nhận dạng. Mã này có thể được xác thực một cách an toàn trên máy chủ.

Giá trị trả về
Chuỗi	Mã nhận dạng duy nhất của người dùng

GoogleUser.isSignedIn()

Trả về true nếu người dùng đã đăng nhập.

Giá trị trả về
Boolean	Đúng nếu người dùng đã đăng nhập

GoogleUser.getHostedDomain()

Lấy miền G Suite của người dùng nếu người dùng đăng nhập bằng tài khoản G Suite.

Giá trị trả về
Chuỗi	Miền G Suite của người dùng

GoogleUser.getGrantedScopes()

Lấy các phạm vi mà người dùng đã cấp dưới dạng chuỗi được phân tách bằng dấu cách.

Giá trị trả về
Chuỗi	Phạm vi do người dùng cấp

GoogleUser.getBasicProfile()

Lấy thông tin hồ sơ cơ bản của người dùng.

Giá trị trả về
`gapi.auth2.BasicProfile`	Bạn có thể truy xuất các thuộc tính của `gapi.auth2.BasicProfile` bằng các phương thức sau: BasicProfile.getId() BasicProfile.getName() BasicProfile.getGivenName() BasicProfile.getFamilyName() BasicProfile.getImageUrl() BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

Nhận đối tượng phản hồi từ phiên xác thực của người dùng.

Đối số
`includeAuthorizationData`	Không bắt buộc: Giá trị boolean chỉ định liệu có luôn trả về phạm vi và mã truy cập hay không. Theo mặc định, mã truy cập và phạm vi đã yêu cầu sẽ không được trả về khi `fetch_basic_profile` là true (giá trị mặc định) và không yêu cầu phạm vi nào khác.

Giá trị trả về
`gapi.auth2.AuthResponse`	Đối tượng `gapi.auth2.AuthResponse`.

GoogleUser.reloadAuthResponse()

Buộc làm mới mã truy cập, sau đó trả về một Promise cho AuthResponse mới.

Giá trị trả về
`Promise`	`Promise` được thực hiện bằng `gapi.auth2.AuthResponse` đã tải lại khi tải lại mã thông báo OAuth.

gapi.auth2.AuthResponse

Phản hồi được trả về khi gọi phương thức GoogleUser.getAuthResponse(includeAuthorizationData) hoặc GoogleUser.reloadAuthResponse().

Thuộc tính
`access_token`	`string`	Mã thông báo truy cập đã được cấp.
`id_token`	`string`	Đã cấp mã thông báo giá trị nhận dạng.
`scope`	`string`	Phạm vi đã cấp trong Mã truy cập.
`expires_in`	`number`	Số giây cho đến khi Mã thông báo truy cập hết hạn.
`first_issued_at`	`number`	Dấu thời gian mà người dùng cấp phạm vi lần đầu tiên được yêu cầu.
`expires_at`	`number`	Dấu thời gian mà Mã thông báo truy cập sẽ hết hạn.

GoogleUser.hasGrantedScopes(`scopes`)

Trả về true nếu người dùng đã cấp phạm vi được chỉ định.

Đối số
`scopes`	Một chuỗi phạm vi được phân tách bằng dấu cách.

Giá trị trả về
Boolean	Đúng nếu phạm vi đã được cấp

GoogleUser.grants(`options`)

Yêu cầu thêm phạm vi cho người dùng.

Hãy xem GoogleAuth.signIn() để biết danh sách các tham số và mã lỗi.

GoogleUser.grantsOfflineAccess(`options`)

Yêu cầu người dùng cho phép truy cập vào các phạm vi đã chỉ định khi không có mạng.

Đối số
`options`	Đối tượng `gapi.auth2.OfflineAccessOptions` chứa các cặp tham số khoá-giá trị. Ví dụ: { scope: 'profile email' }

GoogleUser.disconnect()

Thu hồi tất cả phạm vi mà người dùng đã cấp cho ứng dụng.

Phần tử trên giao diện người dùng

gapi.signin2.render(`id`; `options`)

Hiển thị nút đăng nhập trong phần tử có mã nhận dạng đã cho, sử dụng chế độ cài đặt do đối tượng options chỉ định.

Đối số

id Mã của phần tử kết xuất nút đăng nhập.

options

Đối tượng chứa các chế độ cài đặt dùng để kết xuất nút. Ví dụ:

{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}

Bạn có thể chỉ định các tuỳ chọn sau:

Thông số
xác định phạm vi của thứ nguyên.	Phạm vi cần yêu cầu khi người dùng đăng nhập (mặc định: `profile`).
chiều rộng	Chiều rộng của nút tính bằng pixel (mặc định: `120`).
độ cao	Chiều cao của nút tính bằng pixel (mặc định: `36`).
tiêu đề dài	Hiện các nhãn dài như "Đăng nhập bằng Google" thay vì "Đăng nhập" (mặc định: `false`). Khi sử dụng tiêu đề dài, bạn nên tăng chiều rộng của nút so với giá trị mặc định.
chủ đề	Chủ đề màu của nút: `light` hoặc `dark` (mặc định: `light`).
thành công	Hàm callback để gọi khi người dùng đăng nhập thành công. Hàm này phải nhận một đối số: một thực thể của `gapi.auth2.GoogleUser` (mặc định: không có).
thất bại	Hàm callback để gọi khi không đăng nhập được. Hàm này không nhận đối số (mặc định: không có).

Nâng cao

gapi.auth2.permission(`params`; `callback`)

Thực hiện uỷ quyền OAuth 2.0 một lần. Tuỳ thuộc vào các thông số được sử dụng, thao tác này sẽ mở một cửa sổ bật lên đến quy trình đăng nhập bằng Google hoặc cố gắng tải ngầm phản hồi đã yêu cầu mà không cần người dùng phải tương tác.

Một số trường hợp sử dụng mà phương pháp này hữu ích bao gồm:

Ứng dụng của bạn chỉ cần yêu cầu điểm cuối API của Google một lần, chẳng hạn như để tải các video trên YouTube mà người dùng yêu thích trong lần đầu tiên họ đăng nhập.
Ứng dụng của bạn có cơ sở hạ tầng quản lý phiên riêng và chỉ yêu cầu Mã thông báo mã nhận dạng một lần để xác định người dùng trong phần phụ trợ.
Bạn có thể sử dụng nhiều Mã ứng dụng khách trong cùng một trang.

Cảnh báo: không sử dụng phương thức này cùng với quy trình gapi.auth2.init và signIn được đề xuất. Đây là hai hành vi riêng biệt (Uỷ quyền gapi.auth2.authorize so với Xác thực cho gapi.auth2.init/signIn) và sẽ gặp các vấn đề không mong muốn nếu được sử dụng trong cùng một ứng dụng.

Đối số
`params`	Đối tượng chứa các cặp khoá-giá trị của dữ liệu cấu hình. Hãy xem `gapi.auth2.AuthorizeConfig` để biết các thuộc tính có thể định cấu hình. Ví dụ: { client_id: 'CLIENT_ID.apps.googleusercontent.com', scope: 'email profile openid', response_type: 'id_token permission' }
`callback`	Một hàm được gọi bằng đối tượng `gapi.auth2.AuthorizeResponse` sau khi hoàn tất yêu cầu (thành công hoặc không thành công).

Ví dụ:

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.
});

Mã lỗi

idpiframe_initialization_failed: Không thể khởi chạy iframe bắt buộc từ Google, do một môi trường không được hỗ trợ. Thuộc tính details sẽ cung cấp thêm thông tin về lỗi phát sinh.
popup_closed_by_user: Người dùng đóng cửa sổ bật lên trước khi hoàn tất quy trình đăng nhập.
access_denied: Người dùng đã từ chối cấp quyền đối với các phạm vi bắt buộc.
immediate_failed: Không thể chọn tự động người dùng nào nếu không nhắc quy trình đồng ý. Đã xảy ra lỗi khi sử dụng signIn với tuỳ chọn prompt: 'none'.

gapi.auth2.AuthorizeConfig

Giao diện đại diện cho các tham số cấu hình khác nhau của phương thức gapi.auth2.authorize.

Thuộc tính
`client_id`	`string`	Bắt buộc. Mã ứng dụng khách của ứng dụng (được tìm thấy và tạo trong Google API Console).
`scope`	`string`	Bắt buộc. Các phạm vi cần yêu cầu, dưới dạng chuỗi được phân tách bằng dấu cách.
`response_type`	`string`	Danh sách các loại phản hồi được phân tách bằng dấu cách. Giá trị mặc định là `'permission'`. Các giá trị có thể có là: `id_token` để truy xuất Mã thông báo giá trị nhận dạng `permission` (hoặc `token`) để truy xuất Mã truy cập `code`, để truy xuất Mã uỷ quyền
`prompt`	`string`	Buộc áp dụng một chế độ cụ thể cho quy trình đồng ý. Các giá trị có thể có là: `consent` Máy chủ uỷ quyền sẽ nhắc người dùng đồng ý trước khi trả về thông tin cho ứng dụng. `select_account` Máy chủ uỷ quyền sẽ nhắc người dùng chọn một Tài khoản Google. Điều này cho phép người dùng có nhiều tài khoản chọn trong số nhiều tài khoản mà họ có thể có các phiên hiện tại. `none` Máy chủ uỷ quyền sẽ không hiển thị bất kỳ màn hình xác thực hoặc màn hình xin phép người dùng nào; máy chủ này sẽ trả về lỗi nếu người dùng chưa được xác thực và trước đó chưa đồng ý với các phạm vi đã yêu cầu. Nếu `code` được yêu cầu làm loại phản hồi, thì mã trả về sẽ chỉ có thể trao đổi cho `access_token` chứ không phải `refresh_token`. Lưu ý : nâng cao, thư viện sẽ lưu vào bộ nhớ đệm và tự động làm mới Mã truy cập gần đây nhất mà bạn nhận được. Trong hầu hết trường hợp, khi sử dụng `prompt: 'none'`, bạn không cần phải gửi yêu cầu HTTP tới phần phụ trợ để lấy mã thông báo hợp lệ.
`cookie_policy`	`string`	Các miền để tạo cookie đăng nhập. URI, `single_host_origin` hoặc `none`. Giá trị mặc định là `single_host_origin` nếu bạn không chỉ định.
`hosted_domain`	`string`	Miền G Suite mà người dùng phải đăng nhập. Ứng dụng khách có thể sửa đổi điều này, vì vậy, hãy nhớ xác minh tài sản miền được lưu trữ của người dùng được trả về.
`login_hint`	`string`	Email hoặc Mã nhận dạng người dùng của người dùng để chọn trước trong quy trình đăng nhập. Người dùng có thể sửa đổi thành phần này, trừ phi sử dụng `prompt: "none"`.
`include_granted_scopes`	`boolean`	Liệu yêu cầu Mã thông báo truy cập bao gồm tất cả các phạm vi mà trước đây người dùng đã cấp cho ứng dụng hay chỉ các phạm vi đã yêu cầu trong lệnh gọi hiện tại. Giá trị mặc định là `true`.
`enable_granular_consent`	`boolean`	Không bắt buộc. Liệu có bật các quyền chi tiết hay không. Nếu bạn đặt thành `false`, các quyền đối với Tài khoản Google chi tiết hơn sẽ bị vô hiệu hoá đối với những mã ứng dụng khách OAuth được tạo trước năm 2019. Các mã ứng dụng OAuth được tạo trong hoặc sau năm 2019 sẽ không bị ảnh hưởng vì luôn bật các quyền chi tiết hơn cho các mã ứng dụng này.
`plugin_name`	`string`	Không bắt buộc. Nếu được đặt, các mã ứng dụng khách tạo trước ngày 29 tháng 7 năm 2022 có thể sử dụng Thư viện Google Platform. Theo mặc định, các Mã ứng dụng khách mới tạo sẽ không được sử dụng Thư viện nền tảng mà phải dùng thư viện Dịch vụ nhận dạng mới của Google. Bạn có thể chọn bất kỳ giá trị nào. Bạn nên đặt tên mô tả chẳng hạn như tên sản phẩm hoặc trình bổ trợ để dễ nhận dạng. Ví dụ: `plugin_name: 'YOUR_STRING_HERE'`

gapi.auth2.AuthorizeResponse

Phản hồi được trả về cho lệnh gọi lại của phương thức gapi.auth2.authorize.

Thuộc tính
`access_token`	`string`	Mã thông báo truy cập đã được cấp. Chỉ xuất hiện nếu `permission` hoặc `token` được chỉ định trong `response_type`.
`id_token`	`string`	Đã cấp mã thông báo giá trị nhận dạng. Chỉ xuất hiện nếu `id_token` được chỉ định trong `response_type`.
`code`	`string`	Mã uỷ quyền đã được cấp. Chỉ xuất hiện nếu `code` được chỉ định trong `response_type`.
`scope`	`string`	Phạm vi đã cấp trong Mã truy cập. Chỉ xuất hiện nếu `permission` hoặc `token` được chỉ định trong `response_type`.
`expires_in`	`number`	Số giây cho đến khi Mã thông báo truy cập hết hạn. Chỉ xuất hiện nếu `permission` hoặc `token` được chỉ định trong `response_type`.
`first_issued_at`	`number`	Dấu thời gian mà người dùng cấp phạm vi lần đầu tiên được yêu cầu. Chỉ xuất hiện nếu `permission` hoặc `token` được chỉ định trong `response_type`.
`expires_at`	`number`	Dấu thời gian mà Mã thông báo truy cập sẽ hết hạn. Chỉ xuất hiện nếu `permission` hoặc `token` được chỉ định trong `response_type`.
`error`	`string`	Khi yêu cầu không thành công, tiêu đề này chứa mã lỗi.
`error_subtype`	`string`	Khi yêu cầu không thành công, dữ liệu này có thể chứa thông tin bổ sung về mã lỗi cũng được trả về.

Tài liệu tham khảo về ứng dụng JavaScript đăng nhập bằng Google

Thiết lập tính năng xác thực

gapi.auth2.init(params)

GoogleAuth.the(onInit; onError)

Mã lỗi

gapi.auth2.ClientConfig

Xác thực

gapi.auth2.getAuthInstance()

GoogleAuth.isSignedIn.get()

GoogleAuth.isSignedIn.listen(listener)

GoogleAuth.signIn()

Mã lỗi

GoogleAuth.signIn(options)

Mã lỗi

gapi.auth2.SignInOptions

GoogleAuth.signOut()

GoogleAuth.disconnect()

GoogleAuth.AuthOfflineAccess(options)

Mã lỗi

gapi.auth2.OfflineAccessOptions

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

Người dùng

GoogleAuth.currentUser.get()

GoogleAuth.currentUser.listen(listener)

GoogleUser.getId()

GoogleUser.isSignedIn()

GoogleUser.getHostedDomain()

GoogleUser.getGrantedScopes()

GoogleUser.getBasicProfile()

GoogleUser.getAuthResponse(includeAuthorizationData)

GoogleUser.reloadAuthResponse()

gapi.auth2.AuthResponse

GoogleUser.hasGrantedScopes(scopes)

GoogleUser.grants(options)

GoogleUser.grantsOfflineAccess(options)

GoogleUser.disconnect()

Phần tử trên giao diện người dùng

gapi.signin2.render(id; options)

Nâng cao

gapi.auth2.permission(params; callback)

Ví dụ:

Mã lỗi

gapi.auth2.AuthorizeConfig

gapi.auth2.AuthorizeResponse

gapi.auth2.init(`params`)

GoogleAuth.the(`onInit`; `onError`)

GoogleAuth.signIn(`options`)

GoogleAuth.AuthOfflineAccess(`options`)

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

GoogleAuth.currentUser.listen(`listener`)

GoogleUser.hasGrantedScopes(`scopes`)

GoogleUser.grants(`options`)

GoogleUser.grantsOfflineAccess(`options`)

gapi.signin2.render(`id`; `options`)

gapi.auth2.permission(`params`; `callback`)