report
リソースは、レポートの特定のインスタンスを識別します。リソースでは、レポートにデータが格納されている期間と、レポートをダウンロードできる URL を確認できます。
Methods
次の表に、API が report
リソースをサポートしているメソッドを示します。
Methods | |
---|---|
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: gzip |