Reports

report リソースは、レポートの特定のインスタンスを識別します。このリソースは、レポートにデータが含まれる期間と、レポートをダウンロードできる URL を識別します。

メソッド

次の表に、API が report リソースでサポートするメソッドを示します。

メソッド
get 特定のレポートのメタデータを取得します。
list 指定されたレポートジョブに対して生成されたレポートを一覧表示します。

JSON リソース表現

次の JSON 構造は、report リソースの形式を示しています。

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
id string
レポートを一意に識別するために YouTube が割り当てる ID。各レポートは 1 つのジョブに関連付けられますが、1 つのジョブに複数のレポート 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 時間が必要になりますが、ネットワーク リソースの消費量低下には、そのコストを補うだけの利点があります。

gzip エンコードされたレスポンスを受信するには、次の例に示すように、Accept-Encoding HTTP リクエスト ヘッダーを gzip に設定します。

Accept-Encoding: gzip