Channels

この API は、チャンネルまたは動画を「子ども向け」としてマークする機能をサポートするようになりました。さらに、channel リソースと video リソースには、そのチャンネルや動画の「子ども向け」ステータスを識別するプロパティも含まれるようになりました。YouTube API サービスの利用規約とデベロッパー ポリシーも 2020 年 1 月 10 日に更新されました。詳しくは、YouTube Data API サービスの変更履歴と YouTube API サービスの利用規約をご覧ください。

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

Methods

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,
      "moderateComments": boolean,
      "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 ドメインでのみ使用できます(このように、URL は API レスポンスに表示されます)。アプリケーションが 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
チャンネルにアップロードされた公開動画の数。この値は、チャンネルの公開動画の数(所有者を含む)のみが反映されます。この動作は、YouTube ウェブサイトに表示される数と同じです。
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 を返し始めました。

topicDetails.topicCategories[] list
チャンネルのコンテンツを説明する Wikipedia の URL のリスト。
status object
status オブジェクトは、チャンネルのプライバシー ステータスに関する情報をカプセル化します。
status.privacyStatus string
チャンネルのプライバシー ステータス。

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

このプロパティの有効な値は次のとおりです。
  • 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 文字制限はキーワードごとの制限ではなく、すべてのキーワードの長さの上限です。
brandingSettings.channel.trackingAnalyticsAccountId string
チャンネルへのトラフィックのトラッキングと測定に使用する Google アナリティクス アカウントの ID。
brandingSettings.channel.moderateComments boolean
この設定では、チャンネル ページに投稿されたユーザーからのコメントを、チャンネル所有者が一般公開するために承認する必要があるかどうかを決定します。デフォルト値は false です。
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。画像の最大サイズは 1,138 x 188 ピクセルです。
brandingSettings.image.bannerTabletImageUrl string
このプロパティは非推奨になりました。

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

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

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

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

モバイルアプリのチャンネル ページに表示される中解像度のバナー画像の URL。画像の最大サイズは 960x263 ピクセルです。
brandingSettings.image.bannerMobileHdImageUrl string
このプロパティは非推奨になりました。

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

モバイルアプリのチャンネル ページに表示される高解像度のバナー画像の URL。画像の最大サイズは 1,440 x 395 ピクセルです。
brandingSettings.image.bannerTvImageUrl string
このプロパティは非推奨になりました。

テレビ アプリケーションのチャンネル ページに表示される超高解像度バナー画像の URL。画像の最大サイズは 2,120 x 1,192 ピクセルです。
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
チャンネルのローカライズされた説明。