Các phương thức API trong chương trình truy cập sớm hoặc chương trình xem trước riêng tư đều ở chế độ riêng tư, nghĩa là các phương thức đó sẽ không xuất hiện trong thư viện ứng dụng tiêu chuẩn và có thể không truy cập được qua HTTP theo mặc định. Trang này mô tả cách bạn có thể truy cập vào các phương thức xem trước này.
Tài liệu này thảo luận 4 cách sử dụng API xem trước:
- Các thư viện ứng dụng tĩnh do Google cung cấp.
- Thư viện ứng dụng được tạo động.
- Các yêu cầu HTTP trực tiếp.
- Thư viện ứng dụng tuỳ chỉnh của riêng bạn.
Bạn nên sử dụng thư viện được tạo tĩnh hoặc động do Google cung cấp để sử dụng API.
Thư viện tĩnh
Bạn phải tạo thư viện ứng dụng bằng các ngôn ngữ như Java, Node.js, PHP và C# từ nguồn. Các thư viện này được cung cấp cho bạn trong phần tải thư viện ứng dụng xuống và đã có sẵn các phương thức xem trước.
Bạn có thể cần sửa đổi cấu hình các phần phụ thuộc thông thường để sử dụng những thư viện cục bộ này thay vì nhập các thư viện ứng dụng chuẩn vì không có phương thức xem trước.
Ví dụ: nếu bạn đang sử dụng Node.js và npm, hãy thêm tệp tải xuống thư viện ứng dụng Node.js (googleapis-classroom-1.0.4.tgz) làm phần phụ thuộc cục bộ trong
package.json:
{
"name": "nodejs-classroom-example",
"version": "1.0.0",
...
"dependencies": {
"@google-cloud/local-auth": "^2.1.0",
"googleapis": "^95.0.0",
"classroom-with-addons": "file:./googleapis-classroom-1.0.4.tgz"
}
}
Sau đó, trong ứng dụng, hãy yêu cầu mô-đun classroom-with-addons ngoài các phần phụ thuộc thông thường và tạo thực thể cho dịch vụ classroom từ mô-đun đó:
const {authenticate} = require('@google-cloud/local-auth');
const {google} = require('googleapis');
const classroomWithAddons = require('classroom-with-addons');
...
const classroom = classroomWithAddons.classroom({
version: 'v1',
auth: auth,
});
...
Thư viện linh động
Các thư viện trong các ngôn ngữ như Python tạo thư viện ứng dụng trong thời gian chạy bằng cách sử dụng Tài liệu khám phá trong dịch vụ Khám phá.
Tài liệu khám phá là một thông số kỹ thuật mà máy có thể đọc được để mô tả và tiêu thụ các API REST, dùng để xây dựng thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác tương tác với các API của Google. Một dịch vụ có thể cung cấp nhiều tài liệu khám phá.
Bạn có thể tìm thấy Tài liệu khám phá của dịch vụ API Lớp học (classroom.googleapis.com) tại điểm cuối sau:
- https://classroom.googleapis.com/$discovery/rest?labels=<PREVIEW_LABEL>&version=v1&key=<PREVIEW_LABEL>
Để tạo thư viện Python và tạo thực thể cho dịch vụ Lớp học bằng các phương thức tiện ích bổ sung, bạn có thể chỉ định URL Khám phá bằng dịch vụ, thông tin xác thực và nhãn thích hợp:
classroom_service_with_rubrics = googleapiclient.discovery.build(
serviceName="classroom",
version="v1",
credentials=credentials,
static_discovery=False,
discoveryServiceUrl=f"https://classroom.googleapis.com/$discovery/rest?labels=ADD_ONS_ALPHA&key=ABCXYZ")
Xem tài liệu về thư viện ứng dụng cho API của Google để biết thông tin chi tiết về từng ngôn ngữ. Điểm khác biệt quan trọng khi làm việc với các API xem trước là chỉ định label thích hợp. Trong bản xem trước này, nhãn đó là ADD_ONS_ALPHA.
Yêu cầu HTTP
Nếu bạn thực hiện các yêu cầu HTTP mà không có thư viện ứng dụng, hãy nhớ thêm nhãn (ADD_ONS_ALPHA) làm tiêu đề X-Goog-Visibilities.
Ví dụ: để xem tất cả các tệp đính kèm do tiện ích bổ sung tạo ra trong một bài đăng, hãy sử dụng yêu cầu curl sau đây:
curl \
'https://classroom.googleapis.com/v1/courses/[courseId]/posts/[postId]/addOnAttachments?key=[YOUR_API_KEY]' \
--header 'X-Goog-Visibilities: ADD_ONS_ALPHA' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
--header 'Accept: application/json' \
--compressed
API cho mỗi yêu cầu HTTP được mô tả trong tài liệu về REST.
Thư viện ứng dụng tuỳ chỉnh
Xem bài viết tạo thư viện ứng dụng nếu bạn cần xây dựng thư viện của riêng mình. Việc tạo thư viện của riêng bạn nằm ngoài phạm vi của hướng dẫn này, nhưng bạn nên xem lại phần thư viện động để tìm hiểu về nhãn xem trước và vai trò của chúng trong mục Khám phá.