job リソースは、スケジュールされたレポートジョブを表します。レポート作成ジョブは、特定のチャンネルやコンテンツ所有者向けに YouTube が毎日生成する特定のレポートを識別します。
メソッド
次の表に、API が job リソースに対してサポートするメソッドを示します。
| メソッド | |
|---|---|
create |
レポートジョブを作成します。レポート作成ジョブを作成すると、そのレポートを毎日生成するよう YouTube に指示することになります。レポートはジョブの作成後 24 時間以内に利用可能になります。 |
delete |
レポートジョブを削除します。 |
get |
チャンネルまたはコンテンツ所有者に対してスケジュール設定されている特定のレポート作成ジョブに関する情報を取得します。 |
list |
チャンネルまたはコンテンツ所有者に対してスケジュール設定されたレポート作成ジョブを一覧表示します。レスポンスの各リソースには id プロパティが含まれます。このプロパティは、YouTube が求人を一意に識別するために使用する 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 コンテンツ所有者向けに、システム管理レポートが自動生成されます。コンテンツ所有者は、これらのレポートを作成するジョブを変更または削除できません。 |