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 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, vui lòng báo cáo vấn đề đó cho kho lưu trữ GitHub của chúng tôi.

Thiết lập xác thực

Tải thư viện nền tảng API của 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 chạy đối tượng GoogleAuth. Bạn phải gọi phương thức này trước khi gọi 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 này bằng mã ứng dụng OAuth 2.0 và mọi tùy 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 hoạt động 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 xảy ra lỗi khi khởi chạy (điều này có thể xảy ra trong trình duyệt không được hỗ trợ cũ), hàm onError sẽ được gọi.

Mã lỗi

idpiframe_initialization_failed

Ví dụ: không khởi chạy được iframe bắt buộc từ Google 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 trình bày các thông số cấu hình khác nhau cho 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, lấy trạng thái đăng nhập hiện tại của người dùng, lấy dữ liệu cụ thể từ hồ sơ của người dùng trên Google, 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.

GoogleAuth.issignedIn.get()

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

GoogleAuth.issignedIn.listen(listener)

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

GoogleAuth.signIn()

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

Mã lỗi

Hãy xem GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Đăng nhập vào người dùng bằng các tùy 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 quyền truy cập đối với các phạm vi bắt buộc.

immediate_failed

Người dùng không thể được tự động chọn mà không cần nhắc quy trình đồng ý. Đã xảy ra lỗi khi sử dụng signIn với tùy chọn prompt: 'none'. Bạn không nê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 đã đăng nhập trước đó trong một phiên hoạt động trước đó.

gapi.auth2.SignInOptions

Giao diện trình bày các thông số cấu hình khác nhau cho 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.tách()

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

GoogleAuth.).Xem ngoại tuyến(options)

Xin phép người dùng truy cập vào các phạm vi đã 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 đồng ý.

access_denied

Người dùng đã từ chối quyền truy cập đối với các phạm vi bắt buộc.

immediate_failed

Người dùng không thể được tự động chọn mà không cần nhắc quy trình đồng ý. Đã xảy ra lỗi khi sử dụng signIn với tùy chọn prompt: 'none'. Bạn không nê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 đã đăng nhập trước đó trong một phiên hoạt động trước đó.

gapi.auth2.OfflineAccessOptions

Giao diện trình bày các thông số cấu hình khác nhau cho phương thức GoogleAuth.grantOfflineAccess(options).

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.

Số người dùng

Đối tượng GoogleUser đại diện cho một tài khoản người dùng. GoogleUser đối tượng 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. Xin lưu ý rằng trong phiên bản GoogleAuth mới khởi chạy, người dùng hiện tại chưa được đặt. Hãy sử dụng phương thức currentUser.listen() hoặc GoogleAuth.then() để thu thập bản sao GoogleAuth đã khởi tạo.

GoogleAuth.currentUser.listen(listener)

Theo dõi các thay đổi trong hiện tại đối với Người dùng.

GoogleUser.getId()

Lấy chuỗi ID duy nhất của người dùng.

GoogleUser.isSignIn()

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(includeVéData)

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

GoogleUser.uploadAuthResponse()

Buộc làm mới mã truy cập và sau đó trả lại Lời hứa cho AuthResponse mới.

gapi.auth2.AuthResponse

Phản hồi sẽ được trả về khi gọi các 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 đã chỉ định.

GoogleUser.grant(options)

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

Xem GoogleAuth.signIn() để biết danh sách các thông số và mã lỗi.

GoogleUser.grantOfflineAccess(options)

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

{
  scope: 'profile email'
}

GoogleUser.ắm()

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 thành phần 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 ủy quyền OAuth 2.0 một lần. Tùy thuộc vào các thông số được sử dụng, thao tác này sẽ mở cửa sổ bật lên đến luồng đăng nhập của Google hoặc cố gắng tải phản hồi theo yêu cầu mà không cần sự tương tác của người dùng.

Một số trường hợp sử dụng phương thức 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, ví dụ như để tải video yêu thích trên YouTube của người dùng vào 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à ứng dụng này chỉ yêu cầu Mã thông báo ID một lần để xác định người dùng trong phần phụ trợ của bạn.
• Một số mã ứng dụng đượ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

Ví dụ: không khởi chạy được iframe bắt buộc từ Google 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 quyền truy cập đối với các phạm vi bắt buộc.

immediate_failed

Người dùng không thể được tự động chọn mà không cần nhắc quy trình đồng ý. Đã xảy ra lỗi khi sử dụng signIn với tùy chọn prompt: 'none'.

gapi.auth2.Ủy quyền đã định cấu hình

Giao diện trình bày các thông số cấu hình khác nhau cho phương thức gapi.auth2.authorize.

gapi.auth2.Ủy quyền phản hồi

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