Cấu hình của dự án trên Google Cloud

Trang này bao gồm thông tin bạn cần biết về việc tạo và định cấu hình dự án trên Google Cloud cho tiện ích bổ sung dành cho Lớp học. Các dự án Google Cloud được dùng để triển khai tính năng Đăng nhập một lần của Google thông qua OAuth 2.0 (SSO của Google), để cho phép các yêu cầu do tiện ích bổ sung của bạn đưa ra và để quản lý trang thông tin của tiện ích bổ sung trên Google Workspace Marketplace của bạn.

Để biết thêm thông tin chung về việc xuất bản tiện ích bổ sung cho Marketplace, hãy xem mục Xuất bản ứng dụng.

Tạo dự án trên Google Cloud

Có hai loại dự án cần tạo: một dự án riêng tư dùng cho dự án công khai mà người dùng cuối có thể truy cập. "Công chúng" và "riêng tư" có đề cập đến chế độ hiển thị của ứng dụng trong Google Workspace Marketplace; Marketplace tư nhân chỉ người dùng trong miền nơi ứng dụng đó mới có thể được cài đặt được tạo, trong khi ứng dụng Marketplace công khai dành cho mọi miền Google Workspace. Tệp này phải là hai mã riêng biệt vì một dự án không thể vừa công khai vừa riêng tư. Ứng dụng công khai phải được xem xét và phê duyệt thì mới có thể xuất hiện trên trang web thương mại.

Để biết thông tin chung về việc tạo dự án trên Google Cloud, hãy truy cập vào bài viết Tạo Dự án trên Google Cloud.

Tạo một dự án công khai trên Google Cloud

Dự án này đại diện cho ứng dụng bổ sung có thể truy cập bằng quản trị viên, giáo viên và học sinh. Dự án công khai phải được xem xét và được nhóm Google Workspace Marketplace phê duyệt trước khi ứng dụng ra mắt hoặc .

  1. Tạo một dự án mới trên Google Cloud trong miền phát hành chính thức của bạn.

    Tạo một dự án trên Google Cloud

  2. Bật API Lớp học trong dự án trên Google Cloud.

    Bật API lớp học

  3. Bật SDK của Google Workspace Marketplace trong dự án trên Cloud.

    Bật SDK trên Google Workspace Marketplace

  4. Thiết lập SDK Marketplace Cấu hình ứng dụng Chế độ hiển thị của ứng dụng thành Công khai rồi đánh dấu vào hộp Không công khai.

  5. Điền các trường bắt buộc trong SDK Marketplace Trang thông tin trên Cửa hàng Play rồi nhấp vào XUẤT BẢN.

  6. Nhóm Google Workspace Marketplace sẽ xem xét ứng dụng của bạn. Chúng sẽ liên hệ với bạn qua địa chỉ email của nhà phát triển được chỉ định trong SDK Thị trường. Sau khi ứng dụng được phê duyệt, hãy xoá hộp Không công khai để giáo viên và quản trị viên có thể tìm thấy thư trong Marketplace.

Tạo một dự án riêng tư trên Google Cloud

Dự án riêng tư này đại diện cho ứng dụng tiện ích bổ sung dùng để phát triển. Người dùng bên ngoài miền mà miền được tạo không thể truy cập vào trang web này, nhưng không cần phê duyệt trước khi cài đặt. Do đó, Google đề xuất sử dụng dự án này để phát triển và thử nghiệm tiện ích bổ sung của bạn trong môi trường được kiểm soát.

Bạn cần có quyền truy cập vào một miền Google Workspace for Education bằng công cụ Teaching & Học tập hoặc Plus để tạo một dự án riêng tư. Nếu bạn chưa có quyền truy cập vào hãy làm theo các bước sau để thiết lập miền minh hoạ của Google Workspace for Education, hãy nâng cấp miền đó lên Ngoài ra, hãy cấp phép cho ứng dụng này và cho phép ứng dụng này truy cập vào API tiện ích bổ sung của Lớp học:

  1. Hoàn thành các bước để đăng ký miền thử nghiệm dành cho nhà phát triển.

  2. Sau khi đăng nhập với tư cách quản trị viên trong miền minh hoạ, hãy tạo một tài khoản Dự án trên Google Cloud.

    Tạo một dự án trên Google Cloud

    Nếu bạn không thể truy cập vào bảng điều khiển Google Cloud hoặc không thể tạo Dự án trên đám mây, hãy kiểm tra các mục sau trong Bảng điều khiển dành cho quản trị viên:

    • Truy cập vào Cài đặt tài khoản > trang cài đặt quyền truy cập theo độ tuổi và chọn mục Tất cả người dùng trong nhóm hoặc đơn vị tổ chức này đều 18 tuổi hoặc cũ hơn.
    • Trong Ứng dụng > Các dịch vụ bổ sung của Google:
    • Google Cloud Platform BẬT cho mọi người.
    • Chế độ cài đặt tạo dự án là Cho phép người dùng tạo dự án.
    • Chế độ cài đặt quyền truy cập của Cloud Shell là Cho phép truy cập vào Cloud Shell.

  3. Hoàn thành và gửi biểu mẫu yêu cầu nâng cấp miền minh hoạ. Đang gửi nội dung này biểu mẫu yêu cầu Google nâng cấp miền minh hoạ của bạn lên Google Workspace for Education Plus với 10 và cho phép dự án Cloud của bạn vào API tiện ích bổ sung dành cho Lớp học.

    Bạn sẽ nhận được email khi các quá trình nâng cấp và thêm vào danh sách cho phép được đã hoàn tất. Cấp giấy phép Plus cho tài khoản giáo viên kiểm tra trong Bảng điều khiển dành cho quản trị viên. Thấp hơn Thư mục > Người dùng, tạo hoặc chọn tài khoản giáo viên kiểm tra. Trong mỗi Giấy phép của giáo viên, hãy xác nhận rằng Google Workspace for Education Plus đã được Cấp.

  4. Bật API Lớp học trong dự án trên Google Cloud.

    Bật API lớp học

  5. Bật SDK của Google Workspace Marketplace trong dự án trên Cloud.

    Bật SDK trên Google Workspace Marketplace

  6. Thiết lập SDK Marketplace Cấu hình ứng dụng Chế độ hiển thị của ứng dụng sang chế độ riêng tư.

  7. Điền các trường bắt buộc trong SDK Marketplace Trang thông tin trên Cửa hàng Play rồi nhấp vào XUẤT BẢN. Sau khi xuất bản trang thông tin ứng dụng, người dùng trong miền có thể tìm và cài đặt ứng dụng trong Google Workspace Marketplace hoặc bằng cách truy cập URL ứng dụng xuất hiện tại trang thông tin trên Cửa hàng Play.

OAuth 2.0

Để truy cập vào API Lớp học, bạn phải đồng ý với quyền truy cập vào dữ liệu của người dùng. Các có được bằng cách yêu cầu Google truy cập vào phạm vi OAuth cho người dùng đã đăng nhập người dùng và nhận mã thông báo có thể dùng để thực hiện lệnh gọi API sau đó Google Lớp học. Bạn phải định cấu hình phạm vi trong Trang thông tin trên Cửa hàng Google Workspace Marketplace để quản trị viên miền có thể thay mặt người dùng trong miền của mình đưa ra sự đồng ý nếu họ cài đặt tiện ích bổ sung.

Hãy xem trang Các phạm vi của OAuth cho API Google để biết danh sách chi tiết về tất cả các phạm vi hiện có phạm vi và mục đích sử dụng của chúng. Xem phần Định cấu hình trang OAuth trong tài liệu về Workspace để biết thông tin chung về cấu hình OAuth.

Quyền của người dùng

Ứng dụng web của bạn nên yêu cầu ít nhất một trong các phạm vi sau:

  • https://www.googleapis.com/auth/userinfo.email, cho phép để xem địa chỉ email của người dùng.
  • https://www.googleapis.com/auth/userinfo.profile, cho phép ứng dụng để xem thông tin cá nhân như dọc, họ và tên tên và thông tin cá nhân khác mà người dùng đã công khai sẵn có.

Sau khi người dùng đã uỷ quyền một trong các phạm vi này trong tiện ích bổ sung của bạn, các phạm vi đó sẽ được xác định bởi tham số truy vấn login_hint. Thông số này được truyền đến bất kỳ URL của ứng dụng web khi mở iframe. Nếu người dùng chưa uỷ quyền trong số này, login_hint sẽ không được gửi.

login_hint là tham số SSO Connect chuẩn mà bạn có thể tuỳ ý chuyển đến Google khi sử dụng tính năng Đăng nhập bằng Google hoặc yêu cầu mã thông báo OAuth. Nó nhằm mục đích làm cho trải nghiệm uỷ quyền suôn sẻ hơn cho người dùng cuối.

Phạm vi tiện ích bổ sung dành cho Lớp học

Sau đây là các phạm vi dành riêng cho các tiện ích bổ sung dành cho Lớp học:

  • https://www.googleapis.com/auth/classroom.addons.teacher, cho phép quyền truy cập vào mọi phương thức API.
  • https://www.googleapis.com/auth/classroom.addons.student, cho phép quyền truy cập để khởi chạy thao tác xác thực và đọc tệp đính kèm.

Ngay cả khi có mã truy cập OAuth hợp lệ cho biết thông tin đăng nhập của người dùng, các lệnh gọi API đều phải tuân theo các yêu cầu bổ sung:

  • Tất cả các phương thức đều yêu cầu người dùng phải là giáo viên hoặc học viên trong khoá học do courseId chỉ định trong yêu cầu.
  • Người dùng phải yêu cầu người dùng để tạo, cập nhật, xoá và trả điểm về tệp đính kèm trở thành giáo viên.
  • Các lệnh gọi đến một bài đăng cụ thể trên Google Lớp học được kiểm soát bởi những điều sau kiểm tra.
    • Khi đã có ít nhất một tệp đính kèm trên bài đăng, tiện ích bổ sung có thể yêu cầu:
      • xác thực khởi chạy iframe
      • Thao tác đọc, cập nhật và xoá tệp đính kèm
      • Cập nhật điểm trên bài đăng đó
    • Khi iframe Khám phá tệp đính kèm được mở lần đầu tiên, tiện ích bổ sung có thể chưa có tệp đính kèm trên bài đăng. Tham số truy vấn addOnToken được cung cấp để có thể dùng để đưa ra yêu cầu về những điều sau:
      • Tạo tệp đính kèm dưới bài đăng (bắt buộc phải có addOnToken)
      • Xác thực quá trình khởi chạy (addOnToken được xác thực nếu được cung cấp và là bạn bắt buộc phải sử dụng khi tiện ích bổ sung không có tệp đính kèm bài đăng)

Xác minh OAuth

Tiện ích bổ sung dành cho Lớp học sử dụng API của Google để truy cập vào .

Hãy tham khảo Câu hỏi thường gặp về việc xác minh ứng dụng để dùng API qua OAuth để biết thêm thông tin về xác minh.

Trang thông tin trên Google Workspace Marketplace

Để xem thông tin chung về cấu hình SDK của Google Workspace Marketplace, hãy truy cập vào Bật và định cấu hình SDK trên Google Workspace Marketplace và Tạo trang thông tin trên Cửa hàng Google Workspace Marketplace.

Những điều cần cân nhắc về trang thông tin

Cửa hàng SDK Marketplace của dự án công khai trên Google Cloud Danh sách chỉ định tên của ứng dụng và nội dung mô tả cho người dùng cuối. Bạn có thể cung cấp các chi tiết này trong nhiều ngôn ngữ trong phần Chi tiết ứng dụng.

Hãy làm theo các nguyên tắc sau trên trang thông tin của bạn:

  • Trong phần Chi tiết ứng dụng:

    • Tránh dấu câu trong Tên ứng dụng. Ví dụ: sử dụng "Tiện ích bổ sung của tôi bởi Công ty của tôi" thay vì "Công ty của tôi: Tiện ích bổ sung của tôi" hoặc "Tiện ích bổ sung của tôi, bởi Công ty".

    • Mô tả ngắn và Mô tả chi tiết không được chứa cùng một văn bản.

    + Đảm bảo rằng bạn đã chọn giá trị cho trường Pricing (Định giá). Chiến dịch này trường bao gồm các lựa chọn Miễn phí, Có tính phí khi dùng thử miễn phí, Có tính phí bằng tính năng miễn phí và giá có tính phí. Bạn không cần chỉ định chi phí số tiền trong trang thông tin trên Marketplace.

    • Hãy đảm bảo rằng bạn đã chọn giá trị cho trường Danh mục. Tài nguyên học tập hoặc Công cụ dành cho giáo viên và quản trị viên có thể là những lựa chọn phù hợp cho một tiện ích bổ sung dành cho Lớp học.

    • Xem các mặt hàng được liệt kê trong phần Ứng dụng của Marketplace chi tiết mô tả để biết thêm thông tin.

  • Trong mục Thành phần đồ hoạ:

  • Trong Đường liên kết hỗ trợ:

    • Đảm bảo rằng bạn đã cung cấp đường liên kết đến Điều khoản Dịch vụ.

  • Đảm bảo rằng bạn tuân thủ các nguyên tắc sử dụng thương hiệu API của Google, bao gồm tên và mô tả được phép.

  • Nếu bạn đề cập đến bất kỳ sản phẩm nào của Google trong trang thông tin của mình, hãy sử dụng tên của sản phẩm đó trong định dạng được cung cấp trong Danh sách nhãn hiệu. Hãy đảm bảo rằng bạn đưa vào ký hiệu nhãn hiệu (TM) nếu được chỉ định; sử dụng "Google Tài liệuTM", chứ không phải "Google Tài liệu".

Tích hợp với các dịch vụ cấp phép và thanh toán của Google

Nếu bạn muốn cho phép các ứng dụng trên Google Workspace Marketplace tích hợp với các dịch vụ thanh toán và cấp phép của Google, hãy truy cập API Marketplace.

Cài đặt

Tiện ích bổ sung có thể cho phép cài đặt riêng lẻ ngoài quản trị viên cài đặt. Trang này nêu bật một số khác biệt giữa hai cách cài đặt loại. quảng cáo không nhằm quảng bá một trong hai loại chế độ cài đặt này. Bạn có thể chọn có cho phép cài đặt riêng lẻ trong SDK Google Workspace Marketplace hay không trang Cấu hình ứng dụng.

Cài đặt dành cho quản trị viên

Cài đặt của quản trị viên cho phép quản trị viên thêm tiện ích bổ sung cho tất cả trong một miền hoặc vào các nhóm truy cập hoặc đơn vị tổ chức cụ thể. Chỉ quản trị viên miền có thể thực hiện cài đặt quản trị viên. Chiến lược phát hành đĩa đơn quản trị viên có thể tuỳ ý đồng ý với tất cả phạm vi truy cập thay mặt cho tất cả người dùng trong miền; người dùng sẽ không được nhắc đồng ý với bất kỳ phạm vi truy cập nào nếu quản trị viên chọn làm như vậy.

Sau đây là một số cân nhắc về việc cài đặt dành cho quản trị viên.

  • Kiểm soát chặt chẽ hơn. Quản trị viên có thể giới hạn người dùng nào có thể truy cập vào tiện ích bổ sung.
  • Khả năng tương thích với việc cấp phép. Nếu ứng dụng của bạn yêu cầu giấy phép, phân phối các lượt cài đặt thông qua một quản trị viên có thể giúp đảm bảo rằng giấy phép đang được phân phối và sử dụng một cách thích hợp với tổ chức.
  • Giảm gánh nặng cho người dùng cuối. Cài đặt dành cho quản trị viên sẽ giảm tập hợp tải nhanh cho giáo viên và học sinh. Điều này có thể mang lại cho người dùng trải nghiệm liền mạch hơn với ít lượt nhấp hơn và có ít khả năng gây nhầm lẫn hơn.

Xem phần Cài đặt các ứng dụng trên Marketplace trong miền của bạn để biết thêm thông tin về cách thực hiện các cài đặt dành cho quản trị viên và Cách hoạt động của cơ cấu tổ chức để tìm hiểu thêm về đơn vị tổ chức và nhóm quản lý quyền truy cập.

Cài đặt riêng lẻ

Cài đặt riêng lẻ sẽ thêm tiện ích bổ sung vào tài khoản riêng của người dùng. Người dùng được nhắc đồng ý với phạm vi truy cập của tiện ích bổ sung trong quá trình cài đặt.

Sau đây là một số điểm cần cân nhắc liên quan đến việc cài đặt riêng lẻ.

  • Hỗ trợ áp dụng. Nhiều người dùng hơn có thể thấy và cài đặt tiện ích bổ sung của bạn từ Google Workspace Marketplace. Có thể bạn sẽ thấy lời nhắc cho phép cài đặt riêng lẻ có thêm giáo viên áp dụng hoặc ủng hộ sản phẩm của bạn.
  • Kiểm thử với quản trị viên. Quản trị viên có thể cài đặt riêng để thử nghiệm hoặc đánh giá trước khi phê duyệt hoặc cài đặt tiện ích bổ sung đó nhóm rộng hơn.

Ngoài việc thay mặt người dùng cài đặt tiện ích bổ sung, quản trị viên cũng có thể duy trì danh sách cho phép để cho phép người dùng cài đặt tiện ích bổ sung cho phép cài đặt. Nếu một tiện ích bổ sung không có trong danh sách cho phép, người dùng vẫn có thể thấy trang thông tin của tiện ích bổ sung trên Google Workspace Marketplace nhưng không thể cài đặt add-on; thay vào đó, họ sẽ thấy thông báo giải thích rằng tiện ích bổ sung này chưa được được quản trị viên miền cho phép cài đặt. Xem bài viết Quản lý Google Workspace Các ứng dụng trên Marketplace trên danh sách cho phép của bạn để tìm hiểu thêm về hoạt động này.

Xem tài liệu về cách cài đặt Google Workspace Marketplace để biết thêm thông tin.

Tích hợp ứng dụng

Bạn phải cung cấp URL iframe khởi chạy trong trường URI thiết lập tệp đính kèm. Chiến dịch này URL được dùng làm giá trị iframe src cho iframe của tính năng Khám phá tệp đính kèm. Chiến lược phát hành đĩa đơn iframe của tính năng Khám phá tệp đính kèm được giáo viên dùng để tìm nội dung hoặc hoạt động vào bài tập.

Bạn cũng phải chỉ định tất cả tiền tố URI mà từ đó các tệp đính kèm được cho phép từ tiện ích bổ sung của bạn. Tính năng này giúp tăng cường bảo mật bằng cách ngăn chặn các tệp đính kèm các nguồn trái phép.

Hãy xem trang hướng dẫn về iframe để biết thêm thông tin chi tiết về các trường này.

Tài khoản thử nghiệm

Tạo tài khoản thử nghiệm trên miền minh hoạ để xác minh hành vi chính xác của tiện ích bổ sung riêng tư. Cần có 2 tài khoản của học viên để kiểm tra việc chuyển đổi giữa sinh viên trong iframe Đánh giá bài tập của sinh viên.

Tài khoản thử nghiệm được đề xuất:

  • Giáo viên Tammy, tammy.teacher@<miền minh hoạ của bạn>
  • Sam Sinh viên, sam.student@<miền minh hoạ của bạn>
  • Sally Sinh viên, sally.student@<miền minh hoạ của bạn>

Hãy làm theo quy trình sau để tạo một tài khoản thử nghiệm mới:

  1. Đăng nhập vào Bảng điều khiển dành cho quản trị viên.
  2. Chuyển đến mục Người dùng.
  3. Nhấp vào Thêm người dùng mới (xem Hình 1).
  4. Nhập thông tin của người dùng và chỉ định vai trò thích hợp.

Nhấp vào Thêm người dùng mới Hình 1. Vị trí của đường liên kết Thêm người dùng mới bên trong Bảng điều khiển dành cho quản trị viên.

Làm theo quy trình sau để tạo một nhóm kiểm thử mới:

  1. Đăng nhập vào Bảng điều khiển dành cho quản trị viên.
  2. Chuyển đến Nhóm.
  3. Nhấp vào Tạo nhóm (xem Hình 2).
  4. Nhập thành viên và chủ sở hữu của nhóm.

Nhấp vào Tạo nhóm Hình 2. Vị trí của đường liên kết Tạo nhóm trong Bảng điều khiển dành cho quản trị viên.