job
リソースは、スケジュールされたレポートジョブを表します。レポートジョブは、特定のチャンネルまたはコンテンツ所有者について YouTube が毎日生成する特定のレポートを識別します。
Methods
次の表に、API が job
リソースに対してサポートしているメソッドを示します。
Methods | |
---|---|
create |
レポートジョブを作成します。レポートジョブを作成すると、そのレポートを毎日生成するよう YouTube に指示することになります。レポートは、ジョブが作成されてから 24 時間以内に利用可能になります。 |
delete |
レポートジョブを削除します。 |
get |
チャンネルまたはコンテンツ所有者に対してスケジュールされている特定のレポートジョブに関する情報を取得します。 |
list |
チャンネルまたはコンテンツ所有者のためにスケジュールされたレポートジョブを一覧表示します。レスポンス内の各リソースには、YouTube が求人を一意に識別するために使用する ID を指定する id プロパティが含まれています。この ID は、ジョブに対して生成されたレポートのリストを取得したり、ジョブを削除したりする際に必要になります。 |
JSON リソース表現
次の JSON 構造は、job
リソースの形式を示しています。
{ "id": string, "reportTypeId": string, "name": string, "createTime": timestamp, "expireTime": timestamp, "systemManaged": boolean }
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
プロパティ | |
---|---|
id |
string 報告ジョブを一意に識別するために YouTube によって使用される ID。値の最大長は 40 文字です。 |
reportTypeId |
string ジョブが作成するレポートのタイプ。プロパティ値は、 reportTypes.list メソッドから取得される reportType の id の id に対応します。 |
name |
string ジョブを説明するために YouTube が生成する名前。値の最大長は 100 文字です。 |
createTime |
timestamp ジョブが作成された日時。プロパティ値は、RFC3339 UTC「Zulu」形式のタイムスタンプで、精度はマイクロ秒です。例: "2015-10-02T15:01:23.045678Z" |
expireTime |
timestamp ジョブが期限切れになった日時または期限切れになる日時。プロパティ値は、RFC3339 UTC「Zulu」形式のタイムスタンプで、精度はマイクロ秒です。例: "2015-10-02T15:01:23.045678Z" 。このプロパティには、ジョブに関連付けられたレポートタイプが非推奨となっている場合、またはジョブに対して生成されたレポートが長時間ダウンロードされていない場合に値があります。この値は、YouTube がジョブの新しいレポートを生成しなくなる日付を示します。 有効期限を指定するジョブがある場合は、その日までにレポートのリクエストを停止するようにシステムを更新する必要があります。場合によっては、交換に関する報告を利用できることがあります。 |
systemManaged |
boolean ジョブがシステム管理レポートを生成する場合、この値は true になります。YouTube は、 YouTube クリエイター ツールの同じレポートへのアクセス権を持つ YouTube コンテンツ所有者向けに、システム管理レポートを自動的に生成します。コンテンツ所有者は、レポートを作成するジョブを変更または削除できません。 |