Channels

この API では、チャンネルまたは動画を「子ども向け」としてマークする機能がサポートされるようになりました。さらに、channel リソースと video リソースには、そのチャンネルまたは動画の「子ども向け」ステータスを識別するプロパティも含まれるようになりました。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。YouTube ヘルプセンターでは、カスタム URL の利用資格要件と URL の設定方法について説明しています。
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
有効なキー値は次のとおりです。
  • 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 分を超える長さの動画をアップロードできます。ただし、チャンネル所有者はまず電話による確認で長尺動画をアップロードする機能を有効にする必要があります。この機能の詳細については、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.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 ピクセル × 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 ピクセル × 88 ピクセルです。
brandingSettings.image.bannerMobileMediumHdImageUrl string
このプロパティは非推奨になりました。

モバイルアプリのチャンネル ページに表示される中解像度のバナー画像の URL。画像の最大サイズは 960 ピクセル × 263 ピクセルです。
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
このフィールドは、チャンネルに問題があるかどうかを示します。現在、このフィールドは、communityGuidelinesGoodStanding、copyrightStrikesGoodStanding、contentIdClaimsGoodStanding プロパティに対する論理 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
キー値に関連付けられたローカライズされたメタデータの言語。値は、BCP-47 言語コードを含む文字列です。
localizations.(key).title string
ローカライズされたチャンネル タイトル。
localizations.(key).description string
ローカライズされたチャネルの説明。