report 리소스는 보고서의 특정 인스턴스를 식별합니다. 리소스는 보고서에 데이터가 포함된 기간과 보고서를 다운로드할 수 있는 URL을 식별합니다.
메서드
다음 표에서는 API가 report 리소스에 지원하는 메서드를 보여줍니다.
| 메서드 | |
|---|---|
get |
특정 보고서의 메타데이터를 검색합니다. |
list |
지정된 보고 작업에 대해 생성된 보고서를 나열합니다. |
JSON 리소스 표현
아래의 JSON 구조는 report 리소스의 형식을 보여줍니다.
{
"id": string,
"jobId": string,
"startTime": timestamp,
"endTime": timestamp,
"createTime": timestamp,
"jobExpireTime": timestamp,
"downloadUrl": string
}속성
다음 표는 이 리소스에 표시되는 속성을 정의합니다.
| 속성 | |
|---|---|
id |
stringYouTube가 보고서를 고유하게 식별하기 위해 할당하는 ID입니다. 각 보고서는 단일 작업과 연결되지만 하나의 작업이 여러 보고서 ID와 연결될 수 있습니다. |
jobId |
string이 보고서를 만든 작업의 ID입니다. |
startTime |
timestamp보고서 인스턴스에 적용되는 기간의 시작 시간입니다. 여기에 해당하는 값은 RFC3339 UTC 'Zulu'의 타임스탬프입니다. 마이크로초 단위까지 정확해야 합니다. 예를 들면 "2015-10-02T15:01:23.045678Z"입니다. |
endTime |
timestamp보고서 인스턴스에 적용되는 기간의 종료 시간입니다. 제외 값은 RFC3339 UTC 'Zulu'의 타임스탬프입니다. 마이크로초 단위까지 정확해야 합니다. 예를 들면 "2015-10-02T15:01:23.045678Z"입니다. |
createTime |
timestamp작업이 생성된 날짜 및 시간입니다. 속성 값은 RFC3339 UTC 'Zulu'의 타임스탬프입니다. 마이크로초 단위까지 정확해야 합니다. 예를 들면 "2015-10-02T15:01:23.045678Z"입니다. |
jobExpireTime |
timestamp보고서와 연결된 작업이 만료되거나 만료될 날짜 및 시간입니다. 속성 값은 RFC3339 UTC 'Zulu'의 타임스탬프입니다. 마이크로초 단위까지 정확해야 합니다. 예: "2015-10-02T15:01:23.045678Z".보고서 작업과 연결된 보고서 유형이 지원 중단되었거나 해당 작업에 대해 생성된 보고서가 장시간 다운로드되지 않은 경우 이 속성에 값이 포함됩니다. 이 값은 YouTube에서 해당 작업에 대한 새 보고서를 더 이상 생성하지 않는 날짜를 표시합니다. 만료일을 식별하는 작업이 있는 경우 해당 날짜까지 보고서 요청을 중지하도록 시스템을 업데이트해야 합니다. 경우에 따라 대체 보고서가 제공될 수 있습니다. |
downloadUrl |
string보고서를 다운로드할 수 있는 URL입니다. 속성 값의 최대 길이는 1, 000자(영문 기준)입니다. 보고서를 가져오려면 이 URL로 HTTP GET 요청을 보내세요. 요청에서 승인 토큰을 헤더 값으로 사용하여 Authorization HTTP 요청 헤더를 설정합니다.
gzip 사용 다운로드 요청 시 gzip 압축을 사용 설정하면 보고서를 다운로드하는 데 필요한 대역폭을 줄일 수 있습니다. 애플리케이션에서 API 응답의 압축을 풀기 위해 추가 CPU 시간이 필요하지만 일반적으로 보다 적은 네트워크 리소스를 사용함으로써 얻는 장점이 CPU 시간 추가로 인한 비용을 능가합니다. gzip으로 인코딩된 응답을 받으려면 다음 예와 같이 Accept-Encoding: gzip |