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 つのジョブに関連付けられますが、ジョブは複数のレポート 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