Reports

Tài nguyên report xác định một bản sao 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 mà bạn có thể tải báo cáo xuống.

Phương pháp

Bảng sau đây cho thấy các phương thức mà API hỗ trợ cho tài nguyên report.

Phương pháp
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 đã chỉ định.

Trình bày tài nguyên JSON

Cấu trúc JSON bên dưới 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 riêng báo cáo. Mỗi báo cáo được liên kết với một công việc duy nhất, 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ủa công việc đã tạo báo cáo này.
startTime timestamp
Ngày bắt đầu khoảng thời gian mà bản sao báo cáo bao gồm. Giá trị toàn diện là dấu thời gian ở định dạng RFC3339 UTC "Zulu", chính xác đến từng micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z".

endTime timestamp
Khoảng thời gian mà bản sao báo cáo đề cập. Giá trị độc quyền là dấu thời gian ở định dạng RFC3339 UTC "Zulu", 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 việc làm. Giá trị thuộc tính là dấu thời gian ở định dạng RFC3339 UTC "Zulu", chính xác đến micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z".

jobExpireTime timestamp
Ngày và giờ liên kết với công việc liên quan đến báo cáo này sẽ hết hạn hoặc sẽ hết hạn. Giá trị thuộc tính là dấu thời gian ở định dạng RFC3339 UTC "Zulu", chính xác đến micrô giây. Ví dụ: "2015-10-02T15:01:23.045678Z".

Thuộc tính này có giá trị nếu loại báo cáo liên kết với công việc của báo cáo không được dùng nữa hoặc cá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 sẽ đánh dấu ngày mà sau đó YouTube sẽ không còn 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 muộn nhất vào ngày đó. Trong một số trường hợp, bạn có thể xem báo cáo thay thế.
downloadUrl string
URL mà bạn có thể tải báo cáo xuống. Giá trị thuộc tính có độ dài tối đa là 1000 ký tự.

Để truy xuất báo cáo, hãy gửi yêu cầu HTTP GET đến URL này. Trong yêu cầu, hãy đặt tiêu đề của yêu cầu HTTP Authorization và sử dụng mã uỷ quyền làm giá trị cho tiêu đề.

Sử dụng gzip

Bạn có thể giảm băng thông cần thiết để tải xuống báo cáo bằng cách bật nén gzip trên 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 để xử lý các phản hồi của API không nén, nhưng việc tốn ít tài nguyên mạng hơn thường tốn nhiều chi phí hơn.

Để nhận phản hồi được mã hoá gzip, hãy đặt tiêu đề của yêu cầu HTTP Accept-Encoding thành gzip như trong ví dụ sau:

Accept-Encoding: gzip