Tham chiếu máy khách JavaScript để đăng nhập bằng tài khoản Google

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

Nếu bạn gặp bất kỳ vấn đề nào khi sử dụng thư viện, vui lòng báo cáo thư viện đó cho kho lưu trữ GitHub.

Thiết lập phương thức xác thực

Tải thư viện nền tảng Google API để 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 tạo đố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 tuỳ chọn bổ sung 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 đó.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}

GoogleAuth.then(onInit, onError)

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

Mã lỗi

idpiframe_initialization_failed

Không thể khởi chạy một iframe bắt buộc từ Google, chẳng hạn do môi trường không được hỗ trợ. Tài sản details sẽ cung cấp thêm thông tin về lỗi đã nêu.

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.

Xá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, nhận 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 các 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.

GoogleAuth.isSignedIn.get()

Trả về thông tin người dùng hiện tại có đang đăng nhập hay không.

GoogleAuth.isSignIn.listen(trình nghe)

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

GoogleAuth.signIn()

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

Mã lỗi

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

GoogleAuth.signIn(options)

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

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 trong các phạm vi cần thiết.

immediate_failed

Không thể tự động chọn người dùng mà không cần 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 tùy chọn này vì gapi.auth2.init sẽ tự động đăng nhập người dùng nếu họ đã đăng nhập trước đó trong một phiên trước đó.

gapi.auth2.SignInOptionsS

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

GoogleAuth.signOut()

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

GoogleAuth.Disconnect()

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

GoogleAuth.grantOfflineAccess(options)

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

{
  scope: 'profile email'
}

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 lấy sự đồng ý.

access_denied

Người dùng đã từ chối cấp quyền trong các phạm vi cần thiết.

immediate_failed

Không thể tự động chọn người dùng mà không cần 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 tùy chọn này vì gapi.auth2.init sẽ tự động đăng nhập người dùng nếu họ đã đăng nhập trước đó trong một 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).

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

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

Số 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ó được bằng cách gọi GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

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

GoogleAuth.currentUser.listen(listener)

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

GoogleUser.getId()

Lấy 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.

GoogleUser.getHostedDomain()

Nhận 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.

GoogleUser.getGrantedScopes()

Lấy 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.

GoogleUser.getBasicProfile()

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

GoogleUser.getAuthResponse(IncludeIncludeData)

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

GoogleUser.reloadAuthResponse()

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

gapi.auth2.AuthResponse

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

GoogleUser.hasGrantedScopes(scopes)

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

GoogleUser.grant(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 thông số và mã lỗi.

GoogleUser.grantOfflineAccess(options)

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

{
  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.

Thành phần 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 nhất định, sử dụng các chế độ cài đặt do đối tượng options chỉ định.

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

Nâng cao

gapi.auth2.authorized(params, callback)

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

Phương pháp này có thể hữu ích trong một số trường hợp sau đây:

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

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}

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 một iframe bắt buộc từ Google, chẳng hạn do môi trường không được hỗ trợ. Tài sản details sẽ cung cấp thêm thông tin về lỗi đã nêu.

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 trong các phạm vi cần thiết.

immediate_failed

Không thể tự động chọn người dùng mà không cần 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.DelegateConfig

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.

gapi.auth2.authorizedResponse

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