この API で、チャンネルや動画を「子ども向け」としてマークする機能がサポートされるようになりました。さらに、
channel
リソースと video
リソースに、そのチャンネルまたは動画の「子ども向け」ステータスを識別するプロパティが含まれるようになりました。YouTube API サービスの利用規約とデベロッパー ポリシーも 2020 年 1 月 10 日に更新されました。詳しくは、YouTube Data API サービスと YouTube API サービス利用規約の変更履歴をご覧ください。channel
リソースには、YouTube チャンネルに関する情報が含まれます。
Methods
API は、channels
リソースに対して次のメソッドをサポートしています。
リソース表現
次の 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 } } }
Properties
次の表は、このリソースで使用されているプロパティの定義を示したものです。
Properties | |
---|---|
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 は、API レスポンスで URL がどのように表示されるかである https ドメインでのみ使用できます。アプリケーションが http ドメインから YouTube 画像を読み込もうとすると、破損した画像が表示されることがあります。新たに作成されたチャンネルではサムネイル画像が空白になることがあります。また、表示されるまでに 1 日ほどかかる場合があります。 |
snippet.thumbnails.(key) |
object 有効なキー値は次のとおりです。
|
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 オブジェクトには、チャンネルのローカライズされたタイトルと説明が含まれます。または、チャンネル メタデータのデフォルトの言語で書かれたチャンネルのタイトルと説明が含まれます。
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.videoCount |
unsigned long チャンネルにアップロードされた公開動画の数。この値は、所有者に対するものも含め、チャンネルの公開動画の数のみを反映します。この動作は、YouTube ウェブサイトに表示される数と一致しています。 |
topicDetails |
object topicDetails オブジェクトは、チャンネルに関連付けられたトピックに関する情報をカプセル化します。重要: トピック ID に関連する変更について詳しくは、 topicDetails.topicIds[] プロパティの定義と変更履歴をご覧ください。 |
topicDetails.topicIds[] |
list チャンネルに関連付けられているトピック ID のリスト。 このプロパティは 2016 年 11 月 10 日をもって非推奨となりました。この API は 2017 年 11 月 10 日までサポートされます。 重要: Freebase と Freebase API のサポート終了に伴い、2017 年 2 月 27 日よりトピック ID の動作が変わり始めました。その時点で、YouTube は厳選された少数のトピック ID を返すようになりました。 |
topicDetails.topicCategories[] |
list チャンネルのコンテンツを説明する Wikipedia の URL のリスト。 |
status |
object status オブジェクトは、チャンネルのプライバシー ステータスに関する情報をカプセル化します。 |
status.privacyStatus |
string チャンネルのプライバシー ステータス。 このプロパティの有効な値は次のとおりです。
|
status.isLinked |
boolean YouTube ユーザー名または Google+ アカウントにすでにリンクされているユーザーがチャンネル データで識別されているかどうかを示します。このいずれかのリンクを持つユーザーは公開されている YouTube ID を既に持っているユーザーであり、動画のアップロードなど、いくつかの操作の前提条件となります。 |
status.longUploadsStatus |
string チャンネルが 15 分を超える動画をアップロードできるかどうかを示します。このプロパティは、チャンネル所有者が API リクエストを承認した場合にのみ返されます。この機能について詳しくは、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 x 1 ピクセルのトラッキング ピクセルの URL。 |
brandingSettings.image.bannerTabletLowImageUrl |
string このプロパティは非推奨になりました。 タブレット アプリのチャンネル ページ上に表示される低解像度のバナー画像の URL。画像の最大サイズは 1138px x 188px です。 |
brandingSettings.image.bannerTabletImageUrl |
string このプロパティは非推奨になりました。 タブレット アプリのチャンネル ページに表示されるバナー画像の URL。画像は 1707px × 283px です。 |
brandingSettings.image.bannerTabletHdImageUrl |
string このプロパティは非推奨になりました。 タブレット アプリのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像の最大サイズは 2276 x 377 ピクセルです。 |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string このプロパティは非推奨になりました。 タブレット アプリのチャンネル ページ上に表示される超高解像度のバナー画像の URL。画像の最大サイズは 2560×424 ピクセルです。 |
brandingSettings.image.bannerMobileLowImageUrl |
string このプロパティは非推奨になりました。 モバイルアプリのチャンネル ページ上に表示される低解像度のバナー画像の URL。画像の最大サイズは 320 x 88 ピクセルです。 |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string このプロパティは非推奨になりました。 モバイルアプリのチャンネル ページに表示される中解像度のバナー画像の URL。画像の最大サイズは 960 x 263 ピクセルです。 |
brandingSettings.image.bannerMobileHdImageUrl |
string このプロパティは非推奨になりました。 モバイルアプリのチャンネル ページ上に表示される高解像度のバナー画像の URL。画像の最大サイズは 1,280 x 360 ピクセルです。 |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string このプロパティは非推奨になりました。 モバイルアプリのチャンネル ページ上に表示される非常に高解像度のバナー画像の URL。画像の最大サイズは 1,440 x 395 ピクセルです。 |
brandingSettings.image.bannerTvImageUrl |
string このプロパティは非推奨になりました。 テレビアプリのチャンネル ページに表示される超高解像度のバナー画像の URL。画像の最大サイズは 2120 x 1192 ピクセルです。 |
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 ローカライズされたチャンネルの説明。 |