API thư viện Google Photos chứa nhiều phạm vi dùng để truy cập vào các mục và album nội dung nghe nhìn. Các phản hồi được trả về từ nhiều lệnh gọi sẽ khác nhau, tuỳ thuộc vào phạm vi mà nhà phát triển đã yêu cầu.
Mọi yêu cầu mà ứng dụng của bạn gửi đến API Thư viện Google Photos đều phải bao gồm mã thông báo uỷ quyền. Mã này cũng giúp Google xác định ứng dụng của bạn.
Giới thiệu về giao thức cấp phép
Ứng dụng của bạn phải sử dụng OAuth 2.0 để cấp phép các yêu cầu. Chúng tôi không hỗ trợ giao thức cấp phép nào khác. Nếu ứng dụng của bạn sử dụng chức năng Đăng nhập bằng Google, thì Google sẽ giúp bạn xử lý một số bước trong quá trình cấp phép.
Cấp phép cho các yêu cầu bằng OAuth 2.0
Tất cả các yêu cầu gửi tới API thư viện Google Photos phải được một người dùng đã xác thực cấp phép.
Các chi tiết của quy trình cấp phép đối với OAuth 2.0 sẽ khác nhau đôi chút tuỳ thuộc vào loại ứng dụng bạn đang viết. Quy trình chung sau đây áp dụng cho tất cả các loại ứng dụng:
- Khi tạo ứng dụng của mình, bạn sẽ đăng ký ứng dụng bằng Google API Console. Sau đó, Google cung cấp thông tin bạn sẽ cần sau này, chẳng hạn như mã ứng dụng khách và mật khẩu ứng dụng khách.
- Kích hoạt API Thư viện Google Photos trong Google API Console. (Nếu API không được liệt kê trong API Console, thì hãy bỏ qua bước này.)
- Khi cần quyền truy cập vào dữ liệu người dùng, ứng dụng sẽ yêu cầu Google cung cấp phạm vi truy cập cụ thể.
- Google hiển thị màn hình yêu cầu sự đồng ý cho người dùng để hỏi xem họ có cho phép ứng dụng của bạn yêu cầu một số dữ liệu của họ hay không.
- Nếu người dùng đồng ý, thì Google sẽ cấp cho ứng dụng của bạn một mã truy cập ngắn hạn.
- Sau đó, ứng dụng yêu cầu dữ liệu người dùng và đính kèm mã truy cập trong yêu cầu.
- Nếu xác định rằng yêu cầu của bạn và mã này là hợp lệ, Google sẽ trả về dữ liệu mà ứng dụng yêu cầu.
Một số quy trình cấp phép có các bước bổ sung khác, chẳng hạn như sử dụng mã làm mới để lấy mã truy cập mới. Để biết thông tin chi tiết về quy trình cho các loại ứng dụng khác nhau, hãy xem tài liệu về OAuth 2.0 của Google.
Dưới đây là thông tin về phạm vi của OAuth 2.0 cho API Thư viện Google Photos:
| Phạm vi | Ý nghĩa |
|---|---|
https://www.googleapis.com/auth/photoslibrary.readonly |
Liệt kê các mục từ thư viện và tất cả album, truy cập tất cả mục nội dung đa phương tiện và liệt kê album mà người dùng sở hữu, bao gồm cả các mục đã được chia sẻ với họ. Đối với album do người dùng chia sẻ, thuộc tính chia sẻ
chỉ được trả về nếu phạm vi Bạn chỉ có thể sử dụng thuộc tính Để biết thêm thông tin, hãy xem bài viết Chia sẻ nội dung nghe nhìn. |
https://www.googleapis.com/auth/photoslibrary.appendonly |
Quyền truy cập để tải các byte lên, tạo các mục nội dung đa phương tiện, tạo album và bổ sung tài liệu phong phú. Chỉ cho phép tạo nội dung nghe nhìn mới trong thư viện của người dùng và trong các album do ứng dụng tạo. |
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata |
Quyền đọc đối với các mục nội dung đa phương tiện và album do nhà phát triển tạo. Để biết thêm thông tin, hãy xem phần Truy cập các mục nội dung nghe nhìn và Danh sách nội dung, album và mục nội dung nghe nhìn trong thư viện. Được yêu cầu cùng với phạm vi |
https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata |
Chỉ có quyền chỉnh sửa. Quyền truy cập để thay đổi các thông tin chi tiết này đối với những album và mục nội dung đa phương tiện do nhà phát triển tạo: |
https://www.googleapis.com/auth/photoslibrary.sharing |
Quyền truy cập vào tính năng chia sẻ cuộc gọi. Quyền truy cập để tạo, chia sẻ album, tải các mục nội dung nghe nhìn lên và tham gia album chia sẻ. |
https://www.googleapis.com/auth/photoslibrary |
Không nên. Chỉ yêu cầu quyền truy cập vào các phạm vi bạn cần bằng cách uỷ quyền gia tăng.
Có quyền truy cập vào cả phạm vi |
Để yêu cầu quyền truy cập bằng OAuth 2.0, ứng dụng của bạn cần thông tin về mức truy cập, cũng như thông tin mà Google cung cấp khi bạn đăng ký ứng dụng của mình (chẳng hạn như mã ứng dụng khách và mật khẩu ứng dụng khách).
Mẹo: Thư viện ứng dụng API Google có thể xử lý một số bước trong quy trình cấp phép cho bạn. Thư viện này được cung cấp bằng nhiều ngôn ngữ lập trình. Hãy xem trang về các thư viện và mẫu để biết thêm chi tiết.
Chọn phạm vi
Theo quy tắc chung, hãy chọn phạm vi hạn chế nhất có thể và tránh yêu cầu các phạm vi mà ứng dụng của bạn không cần. Người dùng dễ dàng cấp quyền truy cập vào các phạm vi giới hạn, được mô tả rõ ràng hơn. Người dùng có thể do dự khi cấp quyền truy cập rộng rãi vào nội dung nghe nhìn của họ, trừ phi họ tin tưởng ứng dụng của bạn và hiểu lý do ứng dụng cần thông tin đó.
Phạm vi yêu cầu tăng dần
Làm theo các phương pháp hay nhất để uỷ quyền, ứng dụng của bạn chỉ nên yêu cầu phạm vi nếu cần. Tránh yêu cầu trước tất cả phạm vi cho ứng dụng khi đăng nhập. Thay vào đó, hãy đưa ra lý do và đưa ra yêu cầu theo ngữ cảnh. Giải thích rõ những việc bạn sẽ làm với dữ liệu của người dùng và những lợi ích họ sẽ được hưởng khi cấp quyền truy cập, theo Nguyên tắc về trải nghiệm người dùng và các phương pháp hay nhất để đưa ra thông báo và yêu cầu sự đồng ý.
Tài khoản dịch vụ
API Thư viện không hỗ trợ tài khoản dịch vụ. Ứng dụng của bạn phải sử dụng các luồng OAuth 2.0 khác hiện có như OAuth 2.0 cho ứng dụng máy chủ web hoặc OAuth 2.0 cho ứng dụng dành cho thiết bị di động và máy tính.