Channels

この API では、チャンネルとしてマークする機能、または 動画を「子ども向け」として分類しないようにします。加えて、channelvideo リソースには、「子ども向け」を識別するプロパティも追加されました。 ステータスが表示されます。YouTube API サービスの利用規約とデベロッパー ポリシー も 2020 年 1 月 10 日に更新されました。詳細については、 YouTube Data API サービスYouTube API サービス利用規約

channel リソースには、YouTube チャンネルに関する情報が含まれます。

メソッド

この API では、channels リソースについて次のメソッドがサポートされています。

list
リクエスト条件に一致する 0 個以上の channel リソースのコレクションを返します。 こちらから今すぐお試しください。
update
チャンネルのメタデータを更新します。このメソッドは現在、channel リソースの brandingSettings オブジェクトと invideoPromotion オブジェクトと、その子プロパティの更新のみをサポートしています。 こちらから今すぐお試しください。

リソース表現

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

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "customUrl": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    },
    "country": string
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string
    }
  },
  "statistics": {
    "viewCount": unsigned long,
    "subscriberCount": unsigned long,  // this value is rounded to three significant figures
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ],
    "topicCategories": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean,
    "longUploadsStatus": string,
    "madeForKids": boolean,
    "selfDeclaredMadeForKids": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "trackingAnalyticsAccountId": string,
      "unsubscribedTrailer": string,
      "defaultLanguage": string,
      "country": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    }
  },
  "auditDetails": {
    "overallGoodStanding": boolean,
    "communityGuidelinesGoodStanding": boolean,
    "copyrightStrikesGoodStanding": boolean,
    "contentIdClaimsGoodStanding": boolean
  },
  "contentOwnerDetails": {
    "contentOwner": string,
    "timeLinked": datetime
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを指定します。値は youtube#channel です。
etag etag
このリソースの ETag。
id string
チャンネルを一意に識別するために YouTube によって使用される ID。
snippet object
snippet オブジェクトには、タイトル、説明、サムネイル画像など、チャンネルに関する基本情報が格納されます。
snippet.title string
チャンネルのタイトル。
snippet.description string
チャンネルの説明。プロパティの値の最大長は 1,000 文字です。
snippet.customUrl string
チャンネルのカスタム URL。カスタム URL を取得するための資格要件と URL の設定方法については、YouTube ヘルプセンターをご覧ください。
snippet.publishedAt datetime
チャンネルが作成された日時。値は ISO 8601 形式で指定します。
snippet.thumbnails object
チャンネルに関連付けられているサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトです。

アプリケーションでサムネイルを表示する場合は、API レスポンスで返される画像 URL をコードで使用するようにします。たとえば、API レスポンスで返される URL に https ドメインではなく http ドメインを使用しないでください。

チャンネルのサムネイル URL は https ドメインでのみ使用できます。そのため、API レスポンスで URL が表示されます。アプリケーションが http ドメインから YouTube の画像を読み込もうとすると、破損した画像が表示されることがあります。新しく作成されたチャンネルのサムネイル画像は空になり、表示されるまでに最長で 1 日ほどかかることがあります。
snippet.thumbnails.(key) object
有効な Key-Value は次のとおりです。
  • default – デフォルトのサムネイル画像。動画(または、再生リストのアイテムや検索結果など、動画を参照するリソース)のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。
  • medium – 高解像度バージョンのサムネイル画像。動画(または動画を参照するリソース)の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。
  • high – 高解像度バージョンのサムネイル画像。動画(または動画を参照するリソース)の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。
snippet.thumbnails.(key).url string
画像の URL。アプリケーションでサムネイル URL を使用する際のガイドラインについては、snippet.thumbnails プロパティの定義をご覧ください。
snippet.thumbnails.(key).width unsigned integer
画像の幅。
snippet.thumbnails.(key).height unsigned integer
画像の高さ。
snippet.defaultLanguage string
channel リソースの snippet.title プロパティと snippet.description プロパティ内のテキストの言語。
snippet.localized object
snippet.localized オブジェクトには、チャンネルのローカライズされたタイトルと説明、またはチャンネルのメタデータのデフォルトの言語でチャンネルのタイトルと説明が含まれます。
  • channels.list リクエストで hl パラメータを使用して、ローカライズされたテキストを返す言語が指定されていて、hl パラメータ値が YouTube アプリケーションの言語を識別し、その言語でローカライズされたテキストを利用できる場合、ローカライズされたテキストがリソース スニペットで返されます。
  • hl パラメータ値が指定されていないか、または値が指定されているが、指定された言語でローカライズされたメタデータが利用できない場合、デフォルト言語のメタデータが返されます。
このプロパティには読み取り専用の値が含まれます。ローカライズされたメタデータを追加、更新、削除するには、localizations オブジェクトを使用します。
snippet.localized.title string
ローカライズされたチャンネルのタイトル。
snippet.localized.description string
ローカライズされたチャンネルの説明。
snippet.country string
チャンネルが関連付けられている国。このプロパティの値を設定するには、brandingSettings.channel.country プロパティの値を更新します。
contentDetails object
contentDetails オブジェクトは、チャンネルのコンテンツに関する情報をカプセル化します。
contentDetails.relatedPlaylists object
relatedPlaylists オブジェクトは、チャンネルに関連付けられた再生リスト(チャンネルのアップロード動画や高評価動画など)を識別するマップです。これらの再生リストはすべて playlists.list メソッドを使用して取得できます。
contentDetails.relatedPlaylists.likes string
チャンネルの高く評価した動画を含む再生リストの ID。リストのアイテムを追加または削除するには、playlistItems.insert メソッドと playlistItems.delete メソッドを使用します。
contentDetails.relatedPlaylists.favorites string
このプロパティは非推奨となりました。

チャンネルのお気に入りの動画を含む再生リストの ID。リストのアイテムを追加または削除するには、playlistItems.insert メソッドと playlistItems.delete メソッドを使用します。

YouTube では、お気に入りの動画機能のサポートを終了しています。たとえば、video リソースの statistics.favoriteCount プロパティは 2015 年 8 月 28 日に非推奨になりました。その結果、履歴上の理由により、このプロパティの値に空の再生リストを参照する再生リスト ID が含まれているため、取得できません。
contentDetails.relatedPlaylists.uploads string
チャンネルにアップロードされた動画を含む再生リストの ID。新しい動画をアップロードするには videos.insert メソッドを、以前にアップロードした動画を削除するには videos.delete メソッドを使用します。
statistics object
statistics オブジェクトは、チャネルの統計情報をカプセル化します。
statistics.viewCount unsigned long
チャンネルが視聴された回数。
statistics.commentCount unsigned long
このプロパティのサポートは終了しました。

チャンネルのコメント数。
statistics.subscriberCount unsigned long
チャンネルのチャンネル登録者数。この値は 3 に切り捨てられます 重要です詳しくは、 変更履歴または 詳しくは、YouTube ヘルプセンターをご覧ください。 チャンネル登録者数の四捨五入に関する詳細をご覧ください。
statistics.hiddenSubscriberCount boolean
チャンネル登録者数が一般公開されているかどうかを示します。
statistics.videoCount unsigned long
チャンネルにアップロードされた公開動画の数。この値は、指標スコープ内で 所有者にもチャンネルの公開動画のみに適用されます。この動作はカウントと一致しています。 表示されます。
topicDetails object
topicDetails オブジェクトは、チャンネルに関連付けられたトピックに関する情報をカプセル化します。

重要: トピック ID に関連する変更について詳しくは、topicDetails.topicIds[] プロパティの定義と変更履歴をご覧ください。
topicDetails.topicIds[] list
チャンネルに関連付けられているトピック ID のリスト。

このプロパティは 2016 年 11 月 10 日をもってサポートを終了しました。サポート期間は 2017 年 11 月 10 日までです。

重要: Freebase と Freebase API のサポート終了により、2017 年 2 月 27 日より、トピック ID の動作が変わり始めました。そのとき、YouTube はキュレートされたトピック ID をいくつか返し始めました。

<ph type="x-smartling-placeholder">
topicDetails.topicCategories[] list
チャンネルのコンテンツを記述する Wikipedia URL のリスト。
status object
status オブジェクトは、チャンネルのプライバシー ステータスに関する情報をカプセル化します。
status.privacyStatus string
チャンネルのプライバシー ステータス。

このプロパティで有効な値は次のとおりです。 <ph type="x-smartling-placeholder">
    </ph>
  • private
  • public
  • unlisted
status.isLinked boolean
チャンネルデータで、YouTube ユーザー名または Google+ アカウントにすでにリンクされているユーザーが特定されているかどうかを示します。このいずれかのリンクを持つユーザーは公開されている YouTube ID を既に持っているユーザーであり、動画のアップロードなど、いくつかの操作の前提条件となります。
status.longUploadsStatus string
チャンネルが 15 分を超える動画をアップロードできるかどうかを示します。このプロパティは、チャンネル所有者が API リクエストを承認した場合にのみ返されます。この機能について詳しくは、YouTube ヘルプセンターをご覧ください。

このプロパティで有効な値は次のとおりです。 <ph type="x-smartling-placeholder">
    </ph>
  • allowed – このチャンネルでは 15 分を超える動画をアップロードできます。
  • disallowed – このチャンネルでは 15 分を超える動画をアップロードできない、またはアップロードできません。チャンネルが YouTube コミュニティ ガイドラインに基づく良好な状態で、Content ID によって全世界でブロックされていない場合にのみ、長い動画をアップロードできます。

    長い動画をアップロードできない原因となっている問題を解決した後、チャンネルのステータスは allowed または eligible に戻ります。
  • eligible – このチャンネルでは 15 分を超える動画をアップロードできます。ただし、チャンネル所有者はまず https://www.youtube.com/verify で、より長い動画をアップロードできる機能を有効にする必要があります。この機能について詳しくは、YouTube ヘルプセンターをご覧ください。
status.madeForKids boolean
この値は、チャンネルが子ども向けとして指定されているかどうかを示します。 現在の「子ども向け」チャネルのステータスです。たとえば、ステータスが selfDeclaredMadeForKids プロパティの値に基づいて決定されます。詳しくは、 詳しくは、YouTube ヘルプセンターをご覧ください。 チャンネル、動画、配信の視聴者設定に関する情報。
status.selfDeclaredMadeForKids boolean
channels.update リクエストで、 チャンネル所有者はこのプロパティを使用して、チャンネルを子ども向けとして指定できます。「 プロパティ値は、チャンネル所有者が API リクエストを承認した場合にのみ返されます。
brandingSettings object
brandingSettings オブジェクトは、チャンネルのブランディングに関する情報をカプセル化します。
brandingSettings.channel object
channel オブジェクトは、チャンネル ページのブランディング プロパティをカプセル化します。
brandingSettings.channel.title string
チャンネルのタイトル。タイトルの文字数は全角 15 文字(半角 30 文字)以内です。
brandingSettings.channel.description string
チャンネルの説明。チャンネル ページのチャンネル情報ボックスに表示されます。プロパティの値の最大長は 1,000 文字です。
brandingSettings.channel.keywords string
チャンネルに関連付けられたキーワード。値は、スペース区切りの文字列のリストです。水路 最大文字数である 500 文字(または 500 文字)を超えると、 (")が返されます。500 文字(全角 150 文字)は 制限はキーワードごとの制限ではなく、すべてのキーワードの長さに対する制限です。
brandingSettings.channel.trackingAnalyticsAccountId string
チャンネルへのトラフィックのトラッキングと測定に使用する Google アナリティクス アカウントの ID。
brandingSettings.channel.unsubscribedTrailer string
チャンネル登録していない視聴者向けに、チャンネル ページの一覧ビューにあるおすすめ動画モジュールで再生される動画。チャンネル登録者の視聴者には、最近のチャンネル アクティビティを紹介する別の動画が表示されることがあります。

指定する場合、プロパティの値は、チャンネル所有者が所有する公開動画または限定公開動画の YouTube 動画 ID にする必要があります。
brandingSettings.channel.defaultLanguage string
channel リソースの snippet.title プロパティと snippet.description プロパティ内のテキストの言語。
brandingSettings.channel.country string
チャンネルが関連付けられている国。このプロパティを更新して、snippet.country プロパティの値を設定します。
brandingSettings.watch object
注: このオブジェクトとそのすべての子プロパティのサポートは終了しました。

watch オブジェクトは、チャンネルの動画再生ページのブランディング プロパティをカプセル化します。
brandingSettings.watch.textColor string
注: このプロパティのサポートは終了しました。

動画再生ページのブランド領域のテキストの色。
brandingSettings.watch.backgroundColor string
注: このプロパティのサポートは終了しました。

動画再生ページのブランド領域の背景色。
brandingSettings.watch.featuredPlaylistId string
注: このプロパティのサポートは終了しました。値を設定しようとすると、API からエラーが返されます。
brandingSettings.image object
このプロパティと、そのすべての子プロパティのサポートは終了しました。

image オブジェクトは、チャンネルのチャンネル ページや動画再生ページに表示される画像に関する情報をカプセル化します。
brandingSettings.image.bannerImageUrl string
このプロパティのサポートは終了しました。

YouTube ウェブサイトのチャンネル ページに表示されるバナー画像の URL。画像は 1060px × 175px です。
brandingSettings.image.bannerMobileImageUrl string
このプロパティのサポートは終了しました。

モバイルアプリのチャンネル ページに表示されるバナー画像の URL。画像は 640px × 175px です。
brandingSettings.image.watchIconImageUrl string
このプロパティのサポートは終了しました。

動画プレーヤーの上に表示される画像の URL。高さは 25px ですが幅は固定ではなく、170px 以下の画像です。この画像が提供されていない場合は、画像の代わりにチャンネル名が表示されます。
brandingSettings.image.trackingImageUrl string
このプロパティのサポートは終了しました。

チャンネル ページまたは動画ページの視聴回数の統計情報の収集に使用できる 1 ピクセル x 1 ピクセルのトラッキング ピクセルの URL。
brandingSettings.image.bannerTabletLowImageUrl string
このプロパティのサポートは終了しました。

タブレット アプリのチャンネル ページに表示される低解像度のバナー画像の URL。画像の最大サイズは 1138px x 188px です。
brandingSettings.image.bannerTabletImageUrl string
このプロパティのサポートは終了しました。

タブレット アプリのチャンネル ページに表示されるバナー画像の URL。画像は 1707px × 283px です。
brandingSettings.image.bannerTabletHdImageUrl string
このプロパティのサポートは終了しました。

タブレット アプリのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像の最大サイズは 2276px x 377px です。
brandingSettings.image.bannerTabletExtraHdImageUrl string
このプロパティのサポートは終了しました。

タブレット アプリケーションのチャンネル ページ上に表示される超高解像度のバナー画像の URL。画像の最大サイズは 2,560 x 424 ピクセルです。
brandingSettings.image.bannerMobileLowImageUrl string
このプロパティのサポートは終了しました。

モバイル アプリケーションのチャンネル ページに表示される低解像度のバナー画像の URL。画像の最大サイズは 320 x 88 ピクセルです。
brandingSettings.image.bannerMobileMediumHdImageUrl string
このプロパティのサポートは終了しました。

モバイル アプリケーションのチャンネル ページに表示される中解像度のバナー画像の URL。画像の最大サイズは 960 x 263 ピクセルです。
brandingSettings.image.bannerMobileHdImageUrl string
このプロパティのサポートは終了しました。

モバイル アプリケーションのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像の最大サイズは 1280px x 360px です。
brandingSettings.image.bannerMobileExtraHdImageUrl string
このプロパティは非推奨になりました。

モバイル アプリケーションのチャンネル ページ上に表示される、非常に高解像度のバナー画像の URL。画像の最大サイズは 1440 x 395 ピクセルです。
brandingSettings.image.bannerTvImageUrl string
このプロパティのサポートは終了しました。

テレビ アプリケーションのチャンネル ページ上に表示される超高解像度のバナー画像の URL。画像の最大サイズは 2120px x 1192px です。
brandingSettings.image.bannerTvLowImageUrl string
このプロパティのサポートは終了しました。

テレビ アプリケーションのチャンネル ページ上に表示される低解像度のバナー画像の URL。画像の最大サイズは 854 x 480 ピクセルです。
brandingSettings.image.bannerTvMediumImageUrl string
このプロパティのサポートは終了しました。

テレビ アプリケーションのチャンネル ページ上に表示される中解像度のバナー画像の URL。画像の最大サイズは 1,280 x 720 ピクセルです。
brandingSettings.image.bannerTvHighImageUrl string
このプロパティのサポートは終了しました。

テレビ アプリケーションのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像の最大サイズは 1,920 x 1,080 ピクセルです。
brandingSettings.image.bannerExternalUrl string
このプロパティは、YouTube が生成に使用するバナー画像の場所を指定します。 チャンネル用のさまざまなバナー画像サイズ。
brandingSettings.hints[] list
このプロパティと、そのすべての子プロパティのサポートは終了しました。

hints オブジェクトは、追加のブランディング プロパティをカプセル化します。
brandingSettings.hints[].property string
このプロパティのサポートは終了しました。

プロパティ。
brandingSettings.hints[].value string
このプロパティのサポートは終了しました。

プロパティの値。
auditDetails object
auditDetails オブジェクトは、マルチチャンネル ネットワーク(MCN)が特定のチャンネルを承認するか拒否するかを判断する際に評価するチャンネル データをカプセル化します。このリソース部分を取得する API リクエストでは、https://www.googleapis.com/auth/youtubepartner-channel-audit スコープを含む認証トークンを指定する必要があります。また、そのスコープを使用するトークンは、MCN がチャンネルの承認または拒否を決定したとき、またはトークンが発行された日から 2 週間以内に取り消す必要があります。
auditDetails.overallGoodStanding boolean
このフィールドは、チャンネルに問題があるかどうかを示します。現在、このフィールドは communityGuidelinesGoodStandingcopyrightStrikesGoodStandingcontentIdClaimsGoodStanding プロパティに対する論理 AND 演算の結果を表しています。つまり、その他すべてのプロパティの値が true の場合、このプロパティの値は true になります。ただし、これらのプロパティのいずれかの値が false の場合、このプロパティの値は false になります。ただし、このプロパティの値の設定に使用される方法は、変更される可能性があります。
auditDetails.communityGuidelinesGoodStanding boolean
チャンネルが YouTube のコミュニティ ガイドラインを遵守しているかどうかを示します。
auditDetails.copyrightStrikesGoodStanding boolean
チャンネルに著作権侵害の警告があるかどうかを示します。
auditDetails.contentIdClaimsGoodStanding boolean
チャンネルに未解決の申し立てがあるかどうかを示します。
contentOwnerDetails object
contentOwnerDetails オブジェクトは、チャンネル データをコンテンツ マネージャにリンクした YouTube パートナーにのみ表示されるチャンネル データをカプセル化します。
contentOwnerDetails.contentOwner string
チャンネルにリンクされているコンテンツ所有者の ID。
contentOwnerDetails.timeLinked datetime
チャンネルがコンテンツ所有者にリンクした日時。値は ISO 8601 形式で指定します。
localizations object
localizations オブジェクトは、チャンネルのメタデータの翻訳をカプセル化します。
localizations.(key) object
Key-Value に関連付けられているローカライズされたメタデータの言語。値は BCP-47 言語コードを含む文字列です。
localizations.(key).title string
ローカライズされたチャンネルのタイトル。
localizations.(key).description string
ローカライズされたチャンネルの説明。