Tài nguyên report xác định một phiên bản cụ thể của báo cáo. Tài nguyên này xác định khoảng thời gian mà báo cáo chứa dữ liệu cũng như URL có thể tải báo cáo xuống.
Phương thức
Bảng sau đây cho biết các phương thức mà API hỗ trợ cho các tài nguyên report.
| Phương thức | |
|---|---|
get |
Truy xuất siêu dữ liệu cho một báo cáo cụ thể. |
list |
Liệt kê các báo cáo đã được tạo cho công việc báo cáo được chỉ định. |
Biểu diễn tài nguyên JSON
Cấu trúc JSON dưới đây cho thấy định dạng của tài nguyên report:
{
"id": string,
"jobId": string,
"startTime": timestamp,
"endTime": timestamp,
"createTime": timestamp,
"jobExpireTime": timestamp,
"downloadUrl": string
}Thuộc tính
Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:
| Thuộc tính | |
|---|---|
id |
string
Mã nhận dạng mà YouTube gán để nhận dạng duy nhất báo cáo. Mỗi báo cáo được liên kết với một công việc, mặc dù một công việc có thể được liên kết với nhiều mã báo cáo. |
jobId |
string
Mã công việc đã tạo báo cáo này. |
startTime |
timestamp
Thời điểm bắt đầu khoảng thời gian mà trường hợp báo cáo đề cập. Giá trị đưa vào là dấu thời gian theo định dạng "Zulu" (giờ UTC) RFC3339 , chính xác đến từng micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z". |
endTime |
timestamp
Thời điểm kết thúc khoảng thời gian mà trường hợp báo cáo đề cập. Giá trị duy nhất là một dấu thời gian trong RFC3339 "Zulu" (giờ UTC) , chính xác đến từng micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z". |
createTime |
timestamp
Ngày và giờ tạo công việc. Giá trị thuộc tính là một dấu thời gian trong RFC3339 giờ UTC "Zulu" , chính xác đến từng micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z". |
jobExpireTime |
timestamp
Ngày và giờ mà công việc được liên kết với báo cáo đã hết hạn hoặc sẽ hết hạn. Giá trị thuộc tính là một dấu thời gian trong RFC3339 giờ UTC "Zulu" , chính xác đến từng micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z".Tài sản này có giá trị nếu loại báo cáo liên quan đến công việc của báo cáo không được dùng nữa hoặc báo cáo được tạo cho công việc đó không được tải xuống trong một khoảng thời gian dài. Giá trị này đánh dấu ngày mà sau đó YouTube sẽ không tạo báo cáo mới cho công việc đó nữa. Nếu có công việc xác định ngày hết hạn, bạn nên cập nhật hệ thống để ngừng yêu cầu báo cáo chậm nhất vào ngày đó. Trong một số trường hợp, có thể có báo cáo thay thế. |
downloadUrl |
string
URL mà từ đó có thể tải báo cáo xuống. Giá trị thuộc tính có độ dài tối đa là 1.000 ký tự.Để truy xuất báo cáo, hãy gửi một yêu cầu HTTP GET đến URL này. Trong yêu cầu, hãy đặt tiêu đề Yêu cầu HTTP Authorization, dùng mã thông báo uỷ quyền làm giá trị tiêu đề.
Sử dụng gzip Bạn có thể giảm băng thông cần thiết để tải báo cáo xuống bằng cách bật tính năng nén gzip đối với các yêu cầu tải xuống. Mặc dù ứng dụng của bạn sẽ cần thêm thời gian của CPU để giải nén các phản hồi API, nhưng lợi ích của việc tiêu thụ ít tài nguyên mạng hơn thường lớn hơn chi phí đó. Để nhận phản hồi được mã hoá bằng gzip, hãy đặt tiêu đề của yêu cầu HTTP Accept-Encoding: gzip |