このページでは、YouTube Data API(v3)の変更点とドキュメントの更新について説明します。この変更履歴を配信登録してください。
2024 年 4 月 30 日
注: これはサポート終了のお知らせです。
この改訂での変更内容は次のとおりです。
この API では、チャネル ディスカッションを挿入または取得する機能はサポートされなくなりました。この変更は、YouTube ウェブサイトでサポートされている機能(チャンネルへのコメント投稿には対応していません)と整合しています。
2024 年 3 月 13 日
注: これはサポート終了のお知らせです。
この改訂での変更内容は次のとおりです。
captions.insert
メソッドと captions.update
メソッドの sync
パラメータは非推奨になりました。YouTube では、2024 年 4 月 12 日をもってこのパラメータのサポートを終了する予定です。
この変更に伴い、デベロッパーは字幕トラックを挿入または更新する際にタイミング情報を追加する必要があります。タイミング情報がない場合、アップロードは失敗します。
2024 年 3 月 12 日
この改訂での変更内容は次のとおりです。
captions
リソースのドキュメントを更新し、snippet.name
フィールドに指定できる最大長が 150 文字であることを記載しました。トラック名がそれより長い場合、API は nameTooLong
エラーを返します。
2024 年 3 月 7 日
注: これはサポート終了のお知らせです。
channel
リソース プロパティ brandingSettings.channel.moderateComments
が非推奨になりました。YouTube は、2024 年 3 月 7 日をもってこのパラメータのサポートを終了します。
2024 年 1 月 31 日
この改訂での変更内容は次のとおりです。
channels.list
メソッドの新しい forHandle
パラメータを使用すると、YouTube ハンドルを指定してチャンネルに関する情報を取得できます。
2023 年 11 月 9 日
videoId
リソースは API 呼び出しでは返されないため、Comments
の下にある videoId
リソースへの参照はすべて削除されました。
2023 年 9 月 12 日
注: これはサポート終了のお知らせです。
comments.markAsSpam
メソッドは数年前から非推奨になりました。このメソッドはすでに YouTube ではサポートされていないため、API ではサポートされていません。
comments.markAsSpam
メソッドを参照するすべてのドキュメントに、サポート終了のお知らせを追加しました。
2023 年 8 月 22 日
search.list
メソッドが videoPaidProductPlacement
パラメータをサポートするようになりました。このパラメータを使用すると、クリエイターが有料プロモーションが含まれていると指定した動画のみが含まれるように検索結果をフィルタリングできます。
2023 年 8 月 18 日
video
リソースの liveStreamingDetails.concurrentViewers
の定義を更新し、YouTube Data API が返す同時視聴者数が、YouTube アナリティクスで利用可能な処理済みのスパム除去済み同時視聴者数と異なる可能性があることに注意しました。ライブ配信の指標について詳しくは、YouTube ヘルプセンターをご覧ください。
2023 年 8 月 7 日
2023 年 6 月 12 日にお知らせしたとおり、search.list
メソッドの relatedToVideoId
パラメータは非推奨になりました。このパラメータのサポートは終了し、パラメータへの参照は API ドキュメントから削除されました。
2023 年 6 月 28 日
thumbnails.set メソッドで uploadRateLimitExceeded
エラーがサポートされるようになりました。このエラーは、チャンネルが過去 24 時間以内にアップロードしたサムネイルが多すぎるため、しばらくしてからもう一度お試しください。
2023 年 6 月 12 日
注: これはサポート終了のお知らせです。
search.list メソッドの relatedToVideoId
パラメータは非推奨になりました。YouTube は、2023 年 8 月 7 日をもってこのパラメータのサポートを終了します。
現時点で、search.list
メソッドのドキュメントにサポート終了のお知らせが追加されています。このパラメータは、2023 年 8 月 7 日以降に search.list
ドキュメントから完全に削除されます。
また、API 実装ガイドから、関連動画を取得する方法を示す例を削除しました。
2022 年 8 月 22 日
video.statistics フィールドの型アノテーションが符号なし長整数から文字列に修正されました。
2022 年 8 月 5 日
YouTube は字幕 ID の生成方法を変更しました。この変更の一環として、すべての字幕トラックに新しい字幕 ID を割り当てます。この変更は、caption_id
値を格納するアプリケーションにとっては下位互換性のない変更になる可能性がありますが、caption_id
値を格納するアプリケーションには影響ありません。
現在から 2022 年 12 月 1 日まで、captions.list
、captions.update
、captions.download
、captions.delete
の各メソッドは、新旧両方の字幕トラック ID をサポートします。ただし、2022 年 12 月 1 日以降、YouTube は古い字幕トラック ID のサポートを終了します。その時点で、古い字幕トラック ID を使用してこれらの API メソッドを呼び出すと、captionNotFound
エラーが発生します。
この変更に備えて、現在から 2022 年 12 月 1 日までに保存されているすべての字幕トラック データを完全に置き換えることをおすすめします。つまり、字幕トラック データを保存しているすべての動画について、現在保存されているデータを削除してから、captions.list
メソッドを呼び出して、動画の現在の字幕トラックセットを取得し、通常どおりにそのデータを API レスポンスに保存する必要があります。
2022 年 7 月 12 日
YouTube API サービスの利用規約が更新されました。詳しくは、YouTube API サービス利用規約 - 変更履歴をご覧ください。
2022 年 4 月 27 日
videos.insert
メソッドの説明を更新し、アップロードする動画の最大ファイルサイズが 128 GB から 256 GB に増加したことを記載しました。
2022 年 4 月 8 日
API から返されるサブスクライバーの最大数が制限される可能性があることに注意するよう、subscriptions.list
メソッドの myRecentSubscribers
と mySubscribers
のパラメータ定義の両方を更新しました。この変更は、API の動作を変更するのではなく、ドキュメントを修正するものです。
2021 年 12 月 15 日
2021 年 11 月 18 日にお知らせしたとおり、動画の低評価数を YouTube プラットフォーム全体で非公開にする変更に伴い、video
リソースの statistics.dislikeCount
プロパティが非公開になりました。
この変更について詳しくは、YouTube の公式ブログをご覧ください。
2021 年 11 月 18 日
動画の低評価数を YouTube プラットフォーム全体で非公開にする変更に伴い、video
リソースの statistics.dislikeCount
プロパティは 2021 年 12 月 13 日に非公開になります。つまり、API リクエストが動画の所有者によって認証された場合にのみ、videos.list
エンドポイントからの API レスポンスにプロパティが含まれます。
videos.rate
エンドポイントはこの変更の影響を受けません。
低評価数を一般公開していないが、API クライアントの低評価数について引き続き必要なデベロッパーは、除外の許可リストへの登録を申請できます。免除を申請するには、こちらの申請フォームに記入する必要があります。
この変更について詳しくは、YouTube の公式ブログをご覧ください。
2021 年 7 月 2 日
注: これはサポート終了のお知らせです。
commentThreads.update
エンドポイントは非推奨になり、サポートされなくなりました。このエンドポイントは、他の API エンドポイントを介して使用可能な機能が重複しています。代わりに、comments.update
を呼び出します。
commentThreads
リソースを必要とする場合は、commentThreads.list
メソッドの二次呼び出しを行います。
2021 年 7 月 1 日
YouTube の API サービスを使用するすべてのデベロッパーは、デフォルトの割り当て割り当てである 10,000 ユニットを超える承認を受けるには、API コンプライアンス監査を完了する必要があります。これまで、コンプライアンス監査プロセスと割り当てユニットの追加割り当てのリクエストはどちらも、YouTube API サービス - 監査と割り当て延長フォームに記入して提出したデベロッパーによって行われてきました。
これらのプロセスを明確にし、API サービスを使用するデベロッパーのニーズを満たすために、3 つの新しいフォームと、これらのフォームに記入するためのガイドを追加します。
- 監査対象デベロッパー リクエスト フォーム: API コンプライアンス監査にすでに合格しているデベロッパーは、この短いフォームに記入して送信することで、割り当て量の延長をリクエストできます。
- 再審査請求フォーム: API プロジェクトがコンプライアンス監査で不合格となった(または割り当てユニットの増加が拒否された)デベロッパーは、このフォームに記入して送信できます。
- 制御フォームの変更: API プロジェクトに関連する支配権の変更(株式の売買、合併、その他の企業取引などによる)が発生したデベロッパー、またはデベロッパーに代わって API クライアントを運用する当事者は、このフォームに記入して送信する必要があります。これにより、YouTube の API チームは記録を更新し、新しい API プロジェクトのユースケースのコンプライアンスを監査して、デベロッパーの現在の割り当てを検証できます。
新しいフォームをお送りいただくたびに、YouTube は YouTube API の意図する用途をお知らせし、より適切なサポートをご提供できるようになります。
詳しくは、新しい API コンプライアンス監査ガイドをご覧ください。
2021 年 5 月 12 日
注: これはサポート終了のお知らせです。
この更新は、次の API の変更を対象としています。
-
channel
リソースのcontentDetails.relatedPlaylists.favorites
プロパティは非推奨になりました。2016 年 4 月 28 日の変更履歴に記載されているように、お気に入り動画機能は数年前からすでにサポートを終了しています。このアップデート以前は、API クライアントが存在しないお気に入りの再生リストに動画を追加しようとすると、API によって新しい再生リストが作成されていました。この場合、今後再生リストは作成されず、API からエラーが返されます。アイテムを追加、変更、削除してお気に入りの再生リストを変更する操作も、以前のお知らせによりすべて非推奨となっており、いつでもエラーが返される可能性があります。
-
次の
channel
リソース プロパティは非推奨になりました。これらのプロパティは、YouTube Studio UI と YouTube ですでにサポートされていません。そのため、API 経由でもサポートされなくなりました。brandingSettings.channel.defaultTab
brandingSettings.channel.featuredChannelsTitle
brandingSettings.channel.featuredChannelsUrls[]
brandingSettings.channel.profileColor
brandingSettings.channel.showBrowseView
brandingSettings.channel.showRelatedChannels
すべてのプロパティが
channel
リソース表現から削除され、リソースのプロパティ リストからその定義が削除されました。また、これらのプロパティに関連するエラーは、メソッド固有のドキュメントから削除されました。 -
次の
channelSection
リソース プロパティは非推奨になりました。これらのプロパティは、YouTube Studio UI と YouTube ですでにサポートされていません。そのため、API 経由でもサポートされなくなりました。snippet.style
snippet.defaultLanguage
snippet.localized.title
localizations
localizations.(key)
localizations.(key).title
targeting
targeting.languages[]
targeting.regions[]
targeting.countries[]
この変更に伴い、
channelSection.list
メソッドのhl
パラメータのサポートも非推奨になりました。このパラメータは、サポートしている機能がサポートされていないためです。すべてのプロパティが
channelSection
リソース表現から削除され、リソースのプロパティ リストからその定義が削除されました。また、これらのプロパティに関連するエラーは、メソッド固有のドキュメントから削除されました。 -
channelSection
リソースのsnippet.type
プロパティの次の値が非推奨になりました。これらの値は、YouTube チャンネル ページではすでにサポートされていないため、API 経由でもサポートされなくなりました。likedPlaylists
likes
postedPlaylists
postedVideos
recentActivity
recentPosts
-
playlist
リソースのsnippet.tags[]
プロパティは非推奨になりました。このプロパティはすでに YouTube でサポートされていないため、API 経由ではサポートされません。
2021 年 2 月 9 日
playlistItem
リソースは、次の 2 つの新しいプロパティをサポートしています。
snippet.videoOwnerChannelId
プロパティは、再生リストの動画をアップロードしたチャンネルの ID を識別します。snippet.videoOwnerChannelTitle
プロパティは、再生リストの動画をアップロードしたチャンネルの名前を識別します。
2021 年 1 月 28 日
この改訂での変更内容は次のとおりです。
-
playlistItems.delete
、playlistItems.insert
、playlistItems.list
、playlistItems.update
、playlists.delete
、playlists.list
、playlists.update
メソッドはすべて、新しいplaylistOperationUnsupported
エラーをサポートしています。このエラーは、特定の再生リストで許可されていない操作をリクエストが実行しようとした場合に発生します。たとえば、ユーザーがアップロードした動画の再生リストから動画を削除したり、再生リスト自体を削除したりすることはできません。いずれの場合も、このエラーは
400
HTTP レスポンス コード(不正なリクエスト)を返します。 -
playlistItems.list
メソッドのwatchHistoryNotAccessible
エラーとwatchLaterNotAccessible
エラーがドキュメントから削除されました。ユーザーの再生履歴と [後で見る] のリストには API 経由ではアクセスできませんが、このようなエラーは API では返されません。
2020 年 10 月 15 日
デベロッパー ポリシーに、次の 2 つのセクションを新たに追加しました。
- 新しいセクション III.E.4.i では、YouTube の埋め込みプレーヤーを介して収集および送信されるデータに関する追加情報を提供しています。ユーザーが YouTube の埋め込みプレーヤーを操作して再生の意図を示す前に、YouTube に埋め込まれたユーザーデータについては、お客様の責任となります。自動再生を false に設定することで、ユーザーがプレーヤーを操作する前に YouTube と共有されるデータを制限できます。
- 新しいセクション III.E.4.j は、コンテンツをサイトやアプリに埋め込む前に、子ども向けに制作されたコンテンツ(MFK)ステータスの確認に関するものです。API クライアントに埋め込む動画が子ども向けである場合、その判断と、埋め込みプレーヤーから収集したデータを適切に扱う責任はユーザーにあります。そのため、YouTube の埋め込みプレーヤーを介して API クライアントにコンテンツを埋め込む前に、YouTube Data API サービスを使用しているコンテンツのステータスを確認する必要があります。
新しい動画の MadeForKids ステータスの確認ガイドでは、YouTube Data API サービスを使用して動画の子ども向けステータスを調べる方法について説明しています。
今回の変更に伴い、埋め込みプレーヤー パラメータのドキュメントに、自動再生を有効にするとユーザーがプレーヤーを操作しなくても再生が行われること、つまり、ページの読み込み時に再生データの収集と共有が行われることを説明するリマインダーが追加されました。
2020 年 10 月 8 日
このアップデートでは、channel
リソースに関連する次の 3 つの軽微な変更点をカバーしています。
- チャンネルのサムネイル画像を識別する
snippet.thumbnails
オブジェクトは、新しく作成されたチャンネルでは空の場合があり、データが表示されるまでに最大 1 日かかる場合があります。 statistics.videoCount
プロパティは、チャンネルの公開動画の数のみを反映します(所有者にも反映されます)。この動作は、YouTube ウェブサイトに表示される数と一致しています。brandingSettings.channel.keywords
プロパティで識別されるチャンネル キーワードは、最大許容文字数の 500 文字を超えているか、エスケープされていない引用符("
)が含まれている場合に切り捨てられることがあります。500 文字の制限はキーワードごとの制限ではなく、すべてのキーワードの合計長の制限であることにご注意ください。この動作は、YouTube ウェブサイトの動作と同じです。
2020 年 9 月 9 日
注: これはサポート終了のお知らせです。
この更新には、次の API の変更が含まれます。すべての変更は、このお知らせの日付である 2020 年 9 月 9 日以降に適用されます。そのため、デベロッパーは以下の API 機能を使用できなくなりました。
-
以下の API リソース、メソッド、パラメータ、リソース プロパティは直ちに非推奨になり、この発表日以降は機能しなくなります。
- 次の
channel
リソース プロパティ:statistics.commentCount
プロパティbrandingSettings.image
オブジェクトとそのすべての子プロパティbrandingSettings.hints
リストとそのすべての子プロパティ
channels.list
メソッドのcategoryId
フィルタ パラメータguideCategories
リソースとguideCategories.list
メソッド
- 次の
-
API リクエストで
managedByMe
パラメータがtrue
に設定されている場合、channels.list
メソッドの API レスポンスにprevPageToken
プロパティが含まれなくなりました。この変更は、他のchannels.list
リクエストのprevPageToken
プロパティには影響せず、リクエストのnextPageToken
プロパティにも影響しません。 -
channel
リソースのcontentDetails.relatedPlaylists.watchLater
プロパティとcontentDetails.relatedPlaylists.watchHistory
プロパティは、どちらも 2016 年 8 月 11 日に非推奨が発表されました。playlistItems.insert
メソッドとplaylistItems.delete
メソッドによるこれらのプレイリストのサポートも完全に非推奨になり、2 つのプロパティはドキュメントから削除されました。 -
2013 年 7 月 30 日にサポート終了が発表された
channels.list
メソッドのmySubscribers
パラメータは、ドキュメントから削除されました。subscriptions.list
メソッドとそのmySubscribers
パラメータを使用して、認証されたユーザーのチャンネル登録者のリストを取得します。 -
2017 年 11 月 27 日に非推奨が発表された
channel
リソースのinvideoPromotion
オブジェクトとそのすべての子プロパティが、ドキュメントから削除されました。
2020 年 7 月 29 日
part
パラメータに関連する追加コストをなくし、API リクエストの割り当て請求プロセスを簡素化しました。直ちに有効になり、呼び出されたメソッドの基本料金のみが請求されます。簡素化された割り当ての詳細については、こちらをご覧ください。
この変更により、ほとんどの API 呼び出しで割り当てコストがわずかに削減されますが、一部の API 呼び出しでは引き続き同じコストが発生します。この変更によって API 呼び出しのコストが増加することはありません。全体として、Google Cloud コンソール に表示される割り当て済み割り当てがやや超過する可能性があります。
YouTube API サービスに引き続きアクセスできるように、すべてのデベロッパーに、プロジェクトのコンプライアンス監査を実施することを強くおすすめします。
この変更履歴エントリは 2020 年 7 月 20 日に最初に公開されたものです。
2020 年 7 月 28 日
2020 年 7 月 28 日以降に作成された未確認の API プロジェクトから videos.insert
エンドポイントを使用してアップロードされたすべての動画は、非公開表示モードに制限されます。この制限を解除するには、各プロジェクトで監査を受け、利用規約に準拠していることを確認する必要があります。
未確認の API クライアントを使用して動画をアップロードしたクリエイターには、動画が非公開としてロックされること、公式または監査済みのクライアントを使用することで制限を回避できることを説明するメールが届きます。
現在のところ、2020 年 7 月 28 日より前に作成された API プロジェクトは、この変更の影響を受けません。ただし、YouTube API サービスに引き続きアクセスできるように、すべてのデベロッパーにプロジェクトのコンプライアンス監査を実施することを強くおすすめします。
2020 年 7 月 21 日
[最終更新日: 2020 年 7 月 28 日。]この変更履歴エントリで参照されているドキュメントの更新は、2020 年 7 月 28 日に再公開されました。
昨日、割り当ての請求プロセスに関連するドキュメントの更新版を公開しました。しかし、想定外の事情により、割り当ての変更はまだ有効ではありません。そのため、正確性を考慮してドキュメントが元に戻されました。混乱を避けるため、変更を説明する変更履歴エントリは削除されており、近い将来に再公開されます。
2020 年 7 月 7 日
注: これはサポート終了のお知らせです。
videos.insert
メソッドの autoLevels
パラメータと stabilize
パラメータは非推奨になり、どちらのパラメータもドキュメントから削除されました。これらの値は無視され、新しくアップロードされた動画の処理方法には影響しません。
2020 年 6 月 15 日
新しい YouTube デベロッパー ポリシーへの準拠に関するガイドには、YouTube API サービスの利用規約とポリシー(API TOS)の特定の部分に API クライアントが準拠するようにするためのガイダンスと例が記載されています。
このガイダンスでは、YouTube が API TOS の特定の要素をどのように適用しているかについて説明しますが、既存のドキュメントを置き換えるものではありません。このガイドでは、API コンプライアンス監査でデベロッパーがよく尋ねられる質問について説明します。Google のポリシーの解釈と適用の仕組みをご理解いただくことで、機能開発プロセスが簡素化されることを願っています。
2020 年 6 月 4 日
注: これは、以前のサポート終了のお知らせに対する更新です。
チャンネルのお知らせ機能のサポートは完全に終了しました。この変更は 2020 年 4 月 17 日に最初に発表され、すでに有効となっています。そのため、activities.insert
メソッドはサポートされなくなり、activities.list
メソッドはチャンネルに関する公開情報を返さなくなりました。詳しくは、YouTube ヘルプセンターをご覧ください。
2020 年 4 月 17 日
注: これはサポート終了のお知らせです。
YouTube は、チャンネルのお知らせ機能のサポートを終了します。そのため、activities.insert
メソッドはサポートを終了し、activities.list
メソッドはチャンネルのお知らせを返さなくなります。これらの変更は、2020 年 5 月 18 日以降に API で有効になります。詳しくは、YouTube ヘルプセンターをご覧ください。
2020 年 3 月 31 日
この改訂での変更内容は次のとおりです。
-
新しいリソースとメソッド
-
新しい
member
リソースは、YouTube チャンネルのチャンネル メンバーを表します。メンバーはクリエイターに金銭的サポートを繰り返し提供し、特別な特典を受けることができます。たとえば、クリエイターがチャットに対してメンバー限定モードを有効にすると、メンバーはチャットできます。このリソースは、YouTube Live Streaming API の一部としてドキュメントに記載されている
sponsor
リソースに代わるものです。sponsor
リソースは非推奨になりました。API クライアントはsponsors.list
メソッドの呼び出しを更新して、代わりにmembers.list
メソッドを使用する必要があります。 -
新しい
membershipsLevel
リソースは、API リクエストを承認した作成者が管理する料金レベルを識別します。membershipsLevels.list
メソッドは、クリエイターのすべてのメンバーシップ レベルのリストを取得します。
-
2020 年 1 月 10 日
この API では、子ども向けコンテンツ(YouTube では「子ども向け」と呼んでいます)を識別する機能がサポートされるようになりました。詳しくは、YouTube ヘルプセンターの「子ども向け」コンテンツについての記事をご覧ください。
channel
リソースと video
リソースは、コンテンツ クリエイターと視聴者が子ども向けコンテンツを識別できるように、2 つの新しいプロパティをサポートしています。
-
コンテンツ クリエイターは、
selfDeclaredMadeForKids
プロパティを使用して、チャンネルと動画のどちらが子ども向けであるかを指定できます。
チャネルの場合、channels.update
メソッドを呼び出すときにこのプロパティを設定できます。動画の場合、videos.insert
メソッドかvideos.update
メソッドを呼び出すときにこのプロパティを設定できます。
このプロパティは、チャネルの所有者が API リクエストを承認した場合、channel
リソースまたはvideo
リソースを含む API レスポンスにのみ含まれます。 -
madeForKids
プロパティを使用すると、すべてのユーザーがチャンネルまたは動画の「子ども向け」ステータスを取得できます。たとえば、ステータスはselfDeclaredMadeForKids
プロパティの値に基づいて判断されます。チャンネル、動画、ブロードキャストの視聴者の設定について詳しくは、YouTube ヘルプセンターをご覧ください。
また、YouTube API サービスの利用規約とデベロッパー ポリシーも更新しました。詳しくは、YouTube API サービス利用規約 - 変更履歴をご覧ください。YouTube API サービスの利用規約とデベロッパー ポリシーに対する変更は、2020 年 1 月 10 日(太平洋時間)に有効になります。
2019 年 9 月 10 日
YouTube と、その結果として API レスポンスにおけるチャンネル登録者数のレポート方法の変更を反映するため、API リファレンス ドキュメントが更新されました。この変更に伴い、チャンネル登録者数が 1,000 人を超える場合、YouTube Data API サービスで返されるチャンネル登録者数は 3 桁に切り捨てられます。この変更は、channel
リソースの statistics.subscriberCount プロパティに影響します。
注: この変更は、ユーザーが自身のチャンネルに関するデータに対して承認済みのリクエストを送信する場合でも、このプロパティの値に影響します。チャンネル所有者は、引き続き YouTube Studio で正確なチャンネル登録者数を確認できます。
たとえば、チャンネル登録者数が 123,456 人の場合、statistics.subscriberCount
プロパティには値 123000
が含まれます。次の表は、公開されている他の YouTube ユーザー インターフェースでのチャンネル登録者数が API レスポンスで丸められ、略称される例を示しています。
チャンネル登録者数の例 | YouTube Data API | 一般公開されている YouTube の UI |
---|---|---|
1,234 | 1230 | 1230 |
12,345 | 12300 | 1.23 万 |
123,456 件 | 123000 | 12.3万 |
1,234,567 | 1230000 | 123万 |
1,2345,678 | 12300000 | 1230万 |
123,456,789 | 123000000 | 123M |
2019 年 4 月 4 日
この改訂での変更内容は次のとおりです。
-
API リファレンス ドキュメントが更新され、各メソッドの一般的なユースケースが詳しく説明され、API Explorer ウィジェットを通じて動的で高品質なコードサンプルが提供されています。例については、
channels.list
メソッドのドキュメントをご覧ください。API メソッドを説明するページに、次の 2 つの新しい要素が追加されました。-
API Explorer ウィジェットを使用すると、認証スコープを選択し、サンプルのパラメータやプロパティ値を入力してから、実際の API リクエストを送信して、実際の API レスポンスを確認できます。このウィジェットでは、全画面ビューで完全なコードサンプルが表示され、入力したスコープと値を使用するように動的に更新されています。
-
一般的なユースケース セクションでは、このページで説明されているメソッドの一般的なユースケースを 1 つ以上説明しています。たとえば、
channels.list
メソッドを呼び出して、特定のチャネルに関するデータや、現在のユーザーのチャネルに関するデータを取得できます。このセクションのリンクを使用して、ユースケースのサンプル値を API Explorer に入力したり、それらの値がすでに入力された状態で API Explorer を全画面表示したりすることができます。これらの変更は、独自のアプリケーションに実装しようとしているユースケースに直接適用できるコードサンプルを簡単に確認できるようにすることを目的としています。
コードサンプルは現在、Java、JavaScript、PHP、Python、curl に対応しています。
-
-
コードサンプル ツールも更新され、UI が新しくなり、上記と同じ機能をすべてご利用いただけるようになりました。このツールを使用すると、さまざまなメソッドのユースケースを探索したり、API Explorer に値を読み込んだり、全画面表示の API Explorer を開いて、Java、JavaScript、PHP、Python のコードサンプルを取得したりすることができます。
この変更に伴い、これまで Java、JavaScript、PHP、Python のコードサンプルを掲載していたページは削除されました。
-
Java、JavaScript、PHP、Python のクイックスタート ガイドが更新されました。改訂版のガイドでは、API キーを使用したサンプルの実行方法と、OAuth 2.0 クライアント ID を使用したサンプルの実行方法を、API Explorer のコードサンプルを使用して説明しています。
上記の変更は、2017 年に API ドキュメントに追加されたインタラクティブ ツールに代わるものです。
2018 年 7 月 9 日
この改訂での変更内容は次のとおりです。
-
channel
リソースのsnippet.thumbnails
プロパティの定義が更新され、アプリケーションにサムネイルを表示するとき、API レスポンスで返される画像 URL をそのままコードで使用する必要があることに注意しました。たとえば、アプリケーションでは API レスポンスで返される URL で、https
ドメインの代わりにhttp
ドメインを使用しないでください。2018 年 7 月より、チャンネルのサムネイル URL は
https
ドメインでのみ利用できます。API レスポンスでは、この URL が表示されます。その時間が経過した後、アプリケーションがhttp
ドメインから YouTube 画像を読み込もうとすると、破損した画像が表示されることがあります。 -
注: これはサポート終了のお知らせです。
video
リソースのrecordingDetails.location.altitude
プロパティは非推奨になりました。動画がこのプロパティに対して値を返す保証はありません。同様に、API リクエストでそのプロパティの値を設定しようとしても、受信データが保存されない可能性があります。
2018 年 6 月 22 日
実装ガイド(旧称「実装および移行ガイド」)が更新され、v2 API から v3 API への移行手順が削除されました。さらに、お気に入りの動画など、v3 API でサポートが終了した機能の手順も削除されています。
2017 年 11 月 27 日
この改訂での変更内容は次のとおりです。
-
注: これはサポート終了のお知らせです。
YouTube は、注目動画機能と注目ウェブサイト機能のサポートを終了します。これらの機能は、
channel
リソースのinvideoPromotion
オブジェクトを介して API でサポートされています。そのため、このオブジェクトとそのすべての子プロパティは非推奨になります。invideoPromotion
データの取得と設定は 2017 年 12 月 14 日まで可能です。この日以降は、次のようになります。channels.list
の呼び出し時にinvideoPromotion
の部分を取得しようとすると、空のinvideoPromotion
が返されるか、invideoPromotion
データがまったく返されません。channels.update
の呼び出し時にinvideoPromotion
データを更新しようとすると、少なくとも 2018 年 5 月 27 日までは正常なレスポンスが返されますが、NoOps として扱われるため、実際に更新は実行されません。
2018 年 5 月 27 日以降、これらのリクエストからエラー メッセージが返されることがあります。たとえば、
invalidPromotion
が無効な部分であることを示します。
2017 年 11 月 16 日
この改訂での変更内容は次のとおりです。
-
インタラクティブ コード スニペット ツールで Node.js コードサンプルがサポートされるようになりました。サンプルは、
channels.list
メソッドなど、ほぼすべての API メソッドのドキュメントにも記載されています。カスタマイズ可能なサンプルは、Node.js アプリケーションのユースケース固有の出発点となるように設計されています。この機能は、Node.js クイックスタート ガイドのコードに似ています。ただし、サンプルには、このクイックスタートには表示されないユーティリティ関数が含まれています。
removeEmptyParameters
関数は、API リクエスト パラメータに対応する Key-Value ペアのリストを受け取り、値のないパラメータを削除します。createResource
関数は、API リソース内のプロパティに対応する Key-Value ペアのリストを受け取ります。次に、プロパティをinsert
オペレーションとupdate
オペレーションで使用できる JSON オブジェクトに変換します。以下の例は、プロパティ名と値のセットと、コードによって作成される JSON オブジェクトを示しています。# Key-value pairs: {'id': 'ABC123', 'snippet.title': 'Resource title', 'snippet.description': 'Resource description', 'status.privacyStatus': 'private'} # JSON object: { 'id': 'ABC123', 'snippet': { 'title': 'Resource title', 'description': 'Resource description', }, 'status': { 'privacyStatus': 'private' } }
これらのサンプルはすべて、ダウンロードしてローカルで実行するように設計されています。詳しくは、コード スニペット ツールの手順で完全なコードサンプルをローカルで実行するための前提条件をご覧ください。
2017 年 10 月 25 日
この改訂での変更内容は次のとおりです。
-
インタラクティブ コード スニペット ツールの Python コードサンプルは、サポートが終了した
oauth2client
ライブラリの代わりにgoogle-auth
ライブラリとgoogle-auth-oauthlib
ライブラリを使用するように更新されました。この変更に加えて、このツールでは、インストール済みの Python アプリケーションと Python ウェブサーバー アプリケーション用の完全なコードサンプルが提供されるようになりました。これらのアプリケーションでは、認証フローが若干異なります。サンプル全体(およびこの変更)を確認するには:
- インタラクティブ コード スニペット ツールまたは任意の API メソッド(
channels.list
メソッドなど)のドキュメントをご覧ください。 - コードサンプルの上にある
Python
タブをクリックします。 - タブの上の切り替えボタンをクリックすると、スニペットの表示から完全なサンプルの表示に切り替わります。
- このタブには、
InstalledAppFlow
承認フローを使用する完全なコードサンプルが表示されます。サンプルの上の説明では、この問題について説明しています。また、ウェブサーバー アプリケーションのサンプルへのリンクもあります。 - リンクをクリックして、ウェブサーバーの例に切り替えます。このサンプルでは、Flask ウェブ アプリケーション フレームワークと別の承認フローを使用します。
これらのサンプルはすべて、ダウンロードしてローカルで実行するように設計されています。サンプルを実行する場合は、コード スニペット ツールの手順の完全なコードサンプルをローカルで実行するをご覧ください。
- インタラクティブ コード スニペット ツールまたは任意の API メソッド(
2017 年 8 月 29 日
この改訂での変更内容は次のとおりです。
search.list
メソッドのforContentOwner
パラメータの定義を更新し、このパラメータがtrue
に設定されている場合、type
パラメータをvideo
に設定する必要があります。search.list
メソッドのregionCode
パラメータの定義を更新し、このパラメータによって検索結果が、指定された地域で表示可能な動画に限定されることを明確にしました。- YouTube のブランド ロゴとアイコンが新しくなりました。新しい「developed with YouTube」ロゴは、ブランドの取り扱いガイドラインのページからダウンロードできます。このページには他の YouTube の新しいロゴやアイコンも表示されます。ロゴやアイコンは YouTube ブランドサイトからダウンロードできます。
2017 年 7 月 24 日
この改訂での変更内容は次のとおりです。
- iOS 向けの新しい YouTube Data API クイックスタート ガイドが公開されました。このガイドでは、Objective-C または Swift で記述されたシンプルな iOS アプリケーションで YouTube Data API を使用する方法について説明します。
- YouTube Data API のインタラクティブ コード スニペット ツールに、ツールのいくつかの機能を説明するドキュメントが追加されました。
- API リクエストの実行
- コード スニペットと完全なコードサンプルを切り替える
- ボイラープレート関数の使用
- 既存のリソースの読み込み(更新メソッドの場合)
注: このツールは、API メソッドの API リファレンス ドキュメントにも埋め込まれています(例)。
2017 年 6 月 1 日
この改訂での変更内容は次のとおりです。
-
注: これはサポート終了のお知らせです。
次の
video
リソース プロパティは非推奨です。これらのプロパティは 2017 年 12 月 1 日までサポートされますが、その時点まで動画がこれらのプロパティの値を返す保証はありません。同様に、これらのプロパティ値を設定するvideos.insert
リクエストやvideos.update
リクエストでも、この日付より前にはエラーが生成されませんが、受信データが保存されない可能性もあります。
2017 年 5 月 17 日
この改訂での変更内容は次のとおりです。
-
API リファレンス ドキュメントが更新され、コード スニペットがより広く、インタラクティブになりました。
channels.list
やvideos.rate
などの API メソッドを説明するページに、Java、JavaScript、PHP、Python、Ruby、Apps Script、Go でコード スニペットを表示してカスタマイズできるインタラクティブ ツールが追加されました。このツールでは、特定のメソッドについて 1 つ以上のユースケースのコード スニペットが表示され、各ユースケースではそのメソッドを呼び出す一般的な方法が説明されています。たとえば、
channels.list
メソッドを呼び出して、特定のチャンネルや現在のユーザーのチャンネルに関するデータを取得できます。コードサンプルを操作することもできます。
-
パラメータ値やプロパティの値を変更すると、コード スニペットは動的に更新され、指定した値が反映されます。
-
コード スニペットとフルサンプルを切り替えます。コード スニペットは、API メソッドを呼び出すコードの部分を示しています。完全なサンプルには、このスニペットと、リクエストを承認および送信するためのボイラープレート コードが含まれています。サンプル全体をコピーして、コマンドラインまたはローカル ウェブサーバーから実行できます。
-
ボタンをクリックしてリクエストを実行します。(リクエストを実行するには、ユーザーに代わって API を呼び出すツールを承認する必要があります)。
API Explorer が利用可能なページでは、このツールに代わってこのツールが表示されます。(各ページにはリンクが表示されるため、API Explorer で作業中のリクエストを読み込むこともできます)。
-
-
Data API コード スニペット ツールも更新され、UI が新しくなり、上記と同じ機能をすべてご利用いただけるようになりました。このページで利用できる主な新機能は次のとおりです。
- データを書き込む API リクエストのサポート。
- Java サンプルのサポート。
- ユーザーの承認と API リクエストの作成のための、より柔軟で包括的なボイラープレート コード。
2017 年 4 月 27 日
この改訂での変更内容は次のとおりです。
- 新しいクイックスタート ガイドでは、YouTube Data API リクエストを行う簡単なアプリケーションを設定する方法が説明されています。現在、Android、Apps Script、Go、Java、JavaScript、Node.js、PHP、Python、Ruby 向けのガイドが用意されています。
2017 年 3 月 30 日
この改訂での変更内容は次のとおりです。
channel
リソースの新しいtopicDetails.topicCategories[]
プロパティには、チャンネルのコンテンツを記述する Wikipedia の URL のリストが含まれます。この URL は、リソースのtopicDetails.topicIds[]
プロパティで返されるトピック ID に対応しています。playlistItem
リソースの新しいcontentDetails.videoPublishedAt
プロパティは、動画が YouTube に公開された時刻を識別します。このリソースには、アイテムが再生リストに追加された時刻を示すsnippet.publishedAt
プロパティがすでに含まれています。channel
リソースと同様に、video
リソースはtopicDetails.topicCategories[]
プロパティを返すようになりました。このプロパティには、動画のコンテンツを説明する Wikipedia の URL のリストが含まれています。video
リソースの場合、URL はリソースのtopicDetails.relevantTopicIds[]
プロパティで返されるトピック ID に対応します。video
リソースの新しいcontentDetails.contentRating.mpaatRating
プロパティは、アメリカ映画協会が映画の予告編またはプレビューに付けたレーティングを示します。
2017 年 2 月 27 日
2016 年 8 月 11 日にご案内いたしましたとおり、サポートされているトピック ID のリストをキュレートされたリストに切り替えました。サポートされているトピック ID の完全なリストは、channel
リソースと video
リソースの topicDetails
プロパティと、search.list
メソッドの topicId
パラメータに含まれています。
キュレート済みリストには、いくつかの変更点があります。
- 次のトピックが
Society
のサブトピックとして追加されました。名前 トピック ID ビジネス /m/09s1f
Health /m/0kt51
軍事 /m/01h6rj
政治 /m/05qt0
宗教 /m/06bvp
Animated cartoon
トピック(以前はEntertainment
の子)が削除されました。Children's music
トピック(以前はMusic
の子)が削除されました。
この変更により、動画に関連するトピックが常に video
リソースの topicDetails.relevantTopicIds[]
プロパティ値で返されるようになりました。
2016 年 11 月 29 日
この改訂での変更内容は次のとおりです。
-
2017 年 2 月 10 日よりサポートされるトピック ID のリストに、次の 3 つの小さな変更があります。
- 以前は
Sports
カテゴリの子だったProfessional wrestling
カテゴリが、Entertainment
の子になりました。 Entertainment
の子であるTV shows
カテゴリは新しいカテゴリです。Health
カテゴリ(以前はLifestyle
の子)が削除されました。
また、親カテゴリはいくつかあります(
Entertainment
、Gaming
、Lifestyle
、Music
、Sports
)。Tennis
などの子カテゴリに関連付けられている動画も、親カテゴリ(Sports
)に関連付けられます。 - 以前は
2016 年 11 月 10 日
この改訂での変更内容は次のとおりです。
-
2016 年 8 月 11 日に初めてお知らせしたとおり、Freebase と Freebase API のサポート終了に伴い、トピック ID に関していくつかの変更が必要になります。トピック ID は、
channel
リソースとvideo
リソースに関連付けられたトピックを識別します。また、topicId
検索パラメータを使用して、特定のトピックに関連するチャンネルや動画を検索することもできます。2017 年 2 月 10 日より、YouTube はこれまでより細かい ID のセットではなく、少数のトピック ID を返すようになります。また、チャンネルと動画が特定のトピックに関連付けられるとは限りません。これは、現在の API の動作と整合しています。
API クライアントでこうした変更に備えられるよう、以下の API パラメータとプロパティの定義が更新され、それ以降にサポートされるトピック ID をリストアップしています。なお、カテゴリのリストはすべての宿泊施設で同じです。
channel
リソースのtopicDetails.topicIds[]
プロパティ。video
リソースのtopicDetails.relevantTopicIds[]
プロパティ。search.list
メソッドのtopicId
パラメータ。
-
注: これはサポート終了のお知らせです。
次のプロパティは非推奨となります。
channel
リソースのtopicDetails.topicIds[]
プロパティ。このプロパティは 2017 年 11 月 10 日までサポートされます。video
リソースのtopicDetails.relevantTopicIds[]
プロパティ。このプロパティは 2017 年 11 月 10 日までサポートされます。video
リソースのtopicDetails.topicIds[]
プロパティ。2017 年 2 月 10 日以降、このプロパティには値は含まれません。(この日を過ぎると、動画に関連付けられているすべてのトピックがtopicDetails.relevantTopicIds[]
プロパティ値によって識別されるようになります)。
-
Freebase はすでに非推奨となっているため、Freebase トピックを使用した検索ガイドはドキュメントから削除されました。このガイドでは、アプリケーションで Freebase API がどのように動作するかを示すコードサンプルを提供しました。
さらに、トピック ID に関連するいくつかのコードサンプルが
search.list
メソッドのドキュメントから削除されました。
2016 年 11 月 2 日
この改訂での変更内容は次のとおりです。
-
新しいプロパティとパラメータ
-
video
リソースには、いくつかの新しいプロパティが含まれています。-
player.embedHtml
プロパティには、動画を再生するプレーヤーの埋め込みに使用できる<iframe>
タグが含まれます。新しいplayer.embedHeight
プロパティとplayer.embedWidth
プロパティは、埋め込みプレーヤーのサイズを識別します。これらのプロパティは、API リクエストでmaxHeight
パラメータまたはmaxWidth
パラメータのうち少なくとも 1 つの値が指定されている場合にのみ返されます。これら 2 つの新しいパラメータについては、この変更履歴で後ほど説明します。 -
新しい
hasCustomThumbnail
プロパティは、動画をアップロードしたユーザーが動画のカスタム サムネイル画像を提供しているかどうかを示します。このプロパティは動画をアップロードしたユーザーにのみ表示されます。 -
新しい
fpbRatingReasons[]
は、動画が FPB(南アフリカ)レーティングを受けた理由を示します。 -
新しい
mcstRating
は、ベトナムで動画に対する評価を示します。
-
-
videos.list
メソッドは、maxHeight
とmaxWidth
の 2 つの新しいパラメータをサポートしています。video
リソースのplayer
パートを取得するときは、パラメータのいずれかまたは両方のパラメータを使用できます。デフォルトでは、
player.embedHtml
プロパティで返される<iframe>
の高さは 360 ピクセルです。幅は動画のアスペクト比に合わせて調整されるため、埋め込みプレーヤーに動画を囲む黒い帯が表示されなくなります。たとえば、動画のアスペクト比が 16:9 の場合、プレーヤーの幅は 640 ピクセルになります。新しいパラメータを使用すると、デフォルトのサイズの代わりに、アプリのレイアウトに適した高さや幅を埋め込みコードで使用するように指定できます。API サーバーは、埋め込みプレーヤーに動画を囲む黒い帯が表示されないように、プレーヤーのサイズを適切にスケーリングします。どちらのパラメータも、埋め込みプレーヤーの最大サイズを指定します。そのため、両方のパラメータを指定しても、一方のディメンションのサイズがそのディメンションで許容される最大数よりも小さくなることがあります。
たとえば、動画のアスペクト比が 16:9 の場合について考えてみましょう。したがって、
maxHeight
またはmaxWidth
パラメータが設定されていない場合、player.embedHtml
タグには 640x360 のプレーヤーが含まれます。maxHeight
パラメータが720
に設定され、maxWidth
パラメータが設定されていない場合、API は 1280x720 のプレーヤーを返します。maxWidth
パラメータが960
に設定され、maxHeight
パラメータが設定されていない場合、API は 960x540 のプレーヤーを返します。maxWidth
パラメータが960
に設定され、maxHeight
パラメータが450
に設定されている場合、API は 800x450 のプレーヤーを返します。
上記の新しい
player.embedHeight
プロパティとplayer.embedWidth
プロパティは、プレーヤーのサイズを指定します。
-
-
既存のメソッド、プロパティ、パラメータの更新
-
channelSection
リソースの説明を更新し、ターゲティング データを設定しなくてもチャネルで最大 10 個のセクションを作成でき、ターゲティング データを含む最大 100 個のセクションを作成できることを記載しました。また、ターゲティング オプションは API を使用してのみ設定できることを反映するように、
channelSection
リソースのtargeting
プロパティが更新されました。YouTube ウェブサイトのユーザー インターフェースを使用してチャンネル セクションを変更すると、ターゲティング オプションは削除されます。 -
i18nLanguage
リソースのsnippet.name
プロパティの定義が修正されました。この値は、i18nLanguage.list
メソッドのhl
パラメータで指定された言語で記述されているために、言語名を表すことを反映しています。 -
playlistItem
リソースのcontentDetails.note
プロパティが更新され、プロパティ値の最大長が 280 文字であることが示されます。 -
playlistItem
リソースのcontentDetails.startAt
プロパティとcontentDetails.endAt
プロパティは非推奨になりました。playlistItems.insert
またはplaylistItems.update
リクエストでこれらのフィールドが設定されている場合は無視されます。 -
playlistItems.delete
メソッドとplaylistItems.update
メソッドがonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。このメソッドを使用するリクエストも、https://www.googleapis.com/auth/youtubepartner
スコープへのアクセスを提供するトークンで承認する必要があります。 -
search.list
メソッドのpublishedBefore
パラメータとpublishedAfter
パラメータはどちらも、パラメータ値が包括的であることを示すように更新されています。たとえば、publishedBefore
パラメータが設定されている場合、API は指定された時刻より前またはに作成されたリソースを返します。 -
video
リソースのcontentDetails.contentRating.grfilmRating
プロパティは、grfilmK12
、grfilmK15
、grfilmK18
の 3 つの追加値をサポートします。 -
videos.insert
メソッドの説明を更新し、アップロードする動画の最大ファイルサイズが 64 GB から 128 GB に増加したことを記載しました。
-
-
新しいエラーと更新されたエラー
-
この API では、次の新しいエラーがサポートされています。
エラーのタイプ エラーの詳細 説明 forbidden (403)
homeParameterDeprecated
activities.list
メソッドはこのエラーを返し、ユーザーのホームページのアクティビティ データがこの API を通じて取得できないことを示します。このエラーは、未承認のリクエストでhome
パラメータをtrue
に設定した場合に発生します。invalidValue (400)
invalidContentDetails
playlistItems.insert
メソッドはこのエラーを返し、リクエスト内のcontentDetails
オブジェクトが無効であることを示します。このエラーが発生する 1 つの理由として、contentDetails.note
フィールドが 280 文字を超えていることが考えられます。forbidden (403)
watchHistoryNotAccessible
playlistItems.list
メソッドはこのエラーを返し、リクエストが再生リストの「再生履歴」アイテムを取得しようとしたものの、API を使用して取得できないことを示します。forbidden (403)
watchLaterNotAccessible
playlistItems.list
メソッドはこのエラーを返し、リクエストが「後で見る」再生リスト アイテムを取得しようとしたものの、API を使用して取得できないことを示します。badRequest (400)
uploadLimitExceeded
videos.insert
メソッドはこのエラーを返し、チャンネルがアップロードできる動画数を超えたことを示します。forbidden (403)
forbiddenEmbedSetting
videos.update
メソッドはこのエラーを返し、API リクエストが動画に無効な埋め込み設定を設定しようとしていることを示します。チャンネルによっては、ライブ配信で埋め込みプレーヤーを提供する権限がない場合があります。詳しくは、YouTube ヘルプセンターをご覧ください。 -
重複する動画を再生リストに挿入しても、
playlistItems.insert
メソッドがエラーを返さなくなりました。このエラーは以前、お気に入りの動画などの一部の再生リストで発生しました。これらの再生リストでは重複は許可されませんでしたが、サポートが終了しています。一般的に、再生リストでは重複した動画が許可されます。
-
-
その他の最新情報
-
2016 年 9 月 15 日の変更履歴エントリを更新し、
channel
リソースのcontentDetails.relatedPlaylists.watchHistory
プロパティとcontentDetails.relatedPlaylists.watchLater
プロパティがレスポンスに含まれている場合は常に値HL
とWL
が含まれることを明確にしました。また、これらのプロパティは、承認されたユーザーが自身のチャンネルに関するデータを取得する場合にのみ含められます。
-
2016 年 9 月 15 日
この改訂での変更内容は次のとおりです。
-
2016 年 8 月 11 日の変更履歴の更新では、サポートされるトピック ID のセットが 2017 年 2 月 10 日に変更されるという事実を含め、トピック ID に関連するいくつかの変更点について説明しました。サポートされるトピックのリストは、2016 年 11 月 10 日までに公開されます。
-
以下の変更が有効になりました。以下の変更については、2016 年 8 月 11 日の変更履歴で次のようにお知らせしています。
-
home
パラメータをtrue
に設定してactivities.list
メソッドを呼び出すと、ログアウトした YouTube ユーザーがホームページに表示されるのと同様のアイテムが API レスポンスに含まれるようになりました。これは、2016 年 8 月 11 日に実施された変更履歴の更新内容に記載されていた動作よりも、ユーザー エクスペリエンスを向上させることを目的としたわずかな変更です。この更新では、
home
パラメータを使用したリクエストでは空のリストが返されると記載されていました。 -
channel
リソースのcontentDetails.relatedPlaylists.watchHistory
プロパティとcontentDetails.relatedPlaylists.watchLater
プロパティには、すべてのチャネルについて、それぞれHL
とWL
の値が含まれるようになりました。明確にするために記すと、これらのプロパティは、そのユーザーのチャンネルに関するデータを取得する、承認されたユーザーにのみ表示されます。承認されたユーザーが自身のチャンネルのデータを取得する場合でも、プロパティには常に
HL
とWL
の値が含まれます。そのため、再生履歴と [後で見る] の再生リスト ID を API で取得することはできません。また、チャンネルの再生履歴または [後で見る] 再生リストの再生リストの詳細(
playlists.list
)または再生リストのアイテム(playlistItems.list
)を取得するリクエストでは、空のリストが返されるようになりました。この動作は、新しい値HL
とWL
だけでなく、API クライアントがすでに保存している再生履歴や [後で見る] の再生リスト ID にも当てはまります。
-
-
video
リソースのfileDetails.recordingLocation
オブジェクトとその子プロパティは返されなくなりました。これまでは、このデータ(親fileDetails
オブジェクトなど)は動画の所有者しか取得できませんでした。
2016 年 8 月 11 日
この改訂での変更内容は次のとおりです。
-
新たに公開された YouTube API サービス利用規約(以下「新しい利用規約」)には、現在の利用規約に加えられたさまざまな更新が含まれています。詳細については、YouTube Engineering and Developers ブログをご覧ください。2017 年 2 月 10 日から適用される利用規約の更新に加えて、この更新には、デベロッパーが準拠する必要があるポリシーの説明に役立つ補足ドキュメントがいくつか含まれています。
新しいドキュメントの一覧については、更新版利用規約の変更履歴をご覧ください。また、本利用規約または補足書類に対する今後の変更についても、その変更履歴にて説明いたします。ドキュメントのリンクから、その変更履歴の変更内容を一覧表示する RSS フィードを登録できます。
-
Freebase と Freebase API のサポート終了により、トピック ID に関していくつかの変更が加えられています。トピック ID は、次の API リソースとメソッドで使用されます。
channel
リソースのtopicDetails
部分は、チャンネルに関連付けられているトピックを識別します。video
リソースのtopicDetails
部分は、動画に関連付けられているトピックを識別します。search.list
メソッドのtopicId
パラメータを使用すると、特定のトピックに関連する動画またはチャンネルを検索できます。
これらの機能の変更点は次のとおりです。
-
2017 年 2 月 10 日より、YouTube はこれまでより詳細な ID のセットを返していましたが、今後は少数のトピック ID を返すようになります。サポートされるトピックのセットは、スポーツやバスケットボールなどの大まかなカテゴリを識別しますが、特定のチームや選手を識別するものではありません。この変更についてアプリケーションを準備する時間を確保するため、Google はサポート対象のトピックを発表します。
-
すでに取得している Freebase トピック ID は、2017 年 2 月 10 日まではコンテンツの検索に使用できます。ただし、この期間を過ぎると、前の項目で特定した少数のトピックのみを使用して、トピック別の検索結果を取得できるようになります。
-
2017 年 2 月 10 日以降に、サポートされるトピック ID の数が少ないトピック ID を使って検索結果を検索しようとすると、API は空の結果セットを返します。
-
2016 年 9 月 12 日をもって、次の API フィールドとパラメータが非推奨となります。
-
承認済みユーザーは、
activities.list
メソッドのhome
パラメータを使用して、そのユーザーの YouTube ホームページに表示されるアクティビティ フィードを取得できるようになりました。2016 年 9 月 12 日以降にこのパラメータを使用するリクエストは、空のリストを返します。 -
channel
リソースのcontentDetails.relatedPlaylists.watchHistory
プロパティとcontentDetails.relatedPlaylists.watchLater
プロパティは、そのユーザー自身のチャンネルに関するデータを取得する、承認されたユーザーにのみ表示されます。2016 年 9 月 12 日以降、contentDetails.relatedPlaylists.watchHistory
はHL
の値を返し、contentDetails.relatedPlaylists.watchLater
プロパティはすべてのチャネルについてWL
の値を返します。2016 年 9 月 12 日以降、チャンネルの再生履歴または [後で見る] 再生リストの再生リストの詳細(
playlists.list
)の取得リクエストでは、空のリストが返されます。それ以降は、これらの再生リストに含まれる再生リスト アイテム(playlistItems.list
)の取得リクエストも空のリストを返します。これは、新しい値HL
とWL
のほか、API クライアントがすでに保存している再生履歴や [後で見る] の再生リスト ID にも当てはまります。 -
2016 年 9 月 12 日を過ぎると、
video
リソースのfileDetails.recordingLocation
オブジェクトまたはその子プロパティは返されなくなります。親fileDetails
オブジェクトを取得できるのは動画の所有者のみであるため、このデータは動画の所有者のみが取得できます。
-
2016 年 6 月 13 日
この改訂での変更内容は次のとおりです。
-
channel
リソースのcontentDetails.googlePlusUserId
プロパティは非推奨になりました。これまでは、このプロパティはチャンネルが Google+ プロフィールに関連付けられている場合にのみ存在していました。サポート終了後は、このプロパティはどのchannel
リソースにも含まれなくなります。 -
comment
リソースのsnippet.authorGoogleplusProfileUrl
プロパティは非推奨になりました。これまでは、このプロパティはチャンネルが Google+ プロフィールに関連付けられている場合にのみ存在していました。サポート終了後は、このプロパティはどのcomment
リソースにも含まれなくなります。
サポート終了後はどちらのプロパティも返されないため、対応するリソース ドキュメントから両方のプロパティが削除されました。
2016 年 5 月 31 日
この改訂での変更内容は次のとおりです。
-
subscriptions.list
メソッドの新しいmyRecentSubscribers
パラメータは、認証されたユーザーのチャンネル登録者のリストを、チャンネル登録した日時から新しい順で取得します。新しいパラメータでサポートされるのは、認証済みユーザーのチャンネルの最新のチャンネル登録者 1,000 人のみです。サブスクライバーの完全なリストを取得するには、
mySubscribers
パラメータを使用します。このパラメータは特定の順序でサブスクライバーを返さないため、取得できるサブスクライバーの数は制限されません。 -
activity、playlistItem、playlist、search result、thumbnail、video の各リソースの
snippet.thumbnails.(key)
プロパティの定義が更新され、一部の動画で追加のサムネイル画像サイズが利用できるようになりました。standard
の画像は、幅 640 ピクセル、高さ 480 ピクセルです。maxres
の画像は、幅 1,280 ピクセル、高さ 720 ピクセルです。
-
channelSection.list
メソッドのpart
パラメータの定義を更新し、targeting
の部分は2
の割り当てユニットの費用で取得できることを記載しました。 -
videos.list
メソッドは、不適切に承認されたリクエストがvideo
リソースのfileDetails
、processingDetails
、またはsuggestions
の部分を取得しようとしたときに、forbidden(403
)エラーを返すようになりました。これらの部分は、動画の所有者のみが利用できます。
2016 年 5 月 17 日
新しい Data API コード スニペット ツールには、YouTube Data API の一般的なユースケースに対応した短いコード スニペットが用意されています。コード スニペットは現在、Apps Script、Go、JavaScript、PHP、Python、Ruby のすべての読み取り専用 API メソッドで利用できます。
このツールでは、メソッドごとに 1 つ以上のユースケースのコードサンプルが表示されます。たとえば、search.list
メソッド用に次の 5 つのコード スニペットを使用しています。
- キーワード別に動画を一覧表示する
- 地域別に動画を一覧表示する
- ライブイベントを一覧表示する
- 認証済みユーザーの動画を検索する
- 関連動画を一覧表示する
このツールは、ユースケースごとに API リクエストで使用されているパラメータを表示します。パラメータ値を変更できます。この場合、ツールによってコード スニペットが更新され、指定したパラメータ値が反映されます。
最後に、各リクエストに対する API レスポンスが表示されます。リクエスト パラメータを変更した場合、API レスポンスは指定したパラメータ値に基づきます。API レスポンスを表示するには、ツールがユーザーに代わってリクエストを送信することを承認する必要があります。
2016 年 4 月 28 日
この改訂での変更内容は次のとおりです。
-
video
リソースの新しいcontentDetails.projection
プロパティは、動画の投影形式を指定します。有効なプロパティ値は360
とrectangular
です。 -
2 つのプロパティの違いを説明するために、
video
リソースのrecordingDetails.location
プロパティとfileDetails.recordingLocation
プロパティの両方が更新されました。recordingDetails.location
プロパティは、動画の所有者が動画に関連付ける場所を識別します。この場所は編集可能で、公開動画の場合は検索が可能です。公開動画の場合はユーザーに表示される場合があります。fileDetails.recordingLocation
プロパティ値は不変で、アップロードされた元の動画ファイルに関連付けられている場所を表します。この値は動画の所有者にのみ表示されます。
-
channel
リソースのcontentDetails.relatedPlaylists.favorites
プロパティの定義を更新し、このプロパティ値に空の再生リストを参照し、取得できない再生リスト ID が含まれている可能性があることを指摘しました。これは、お気に入りの動画の機能がすでに終了しているためです。このプロパティは API 非推奨ポリシーの対象ではありません。 -
comments.insert
、comments.update
、commentThreads.insert
、またはcommentThreads.update
メソッドで返されるineligibleAccount
エラーの定義を更新し、API リクエストの承認に使用された YouTube アカウントがユーザーの Google アカウントと統合されていない場合にエラーが発生することを反映しました。
2016 年 4 月 20 日
この改訂での変更内容は次のとおりです。
-
channels.update
メソッドのpart
パラメータの定義を更新して、localizations
もこのパラメータの有効な値であることを記載しました。 -
スタートガイドの割り当て使用量セクションが更新され、Google Developers Console にリンクされます。Google Play Console では、実際の割り当て使用量を確認できます。
2016 年 3 月 16 日
この改訂での変更内容は次のとおりです。
-
既存のリソースとメソッドの更新
-
channelBanner
リソースのドキュメントを更新し、アップロードするチャンネル バナー画像の推奨サイズが 2,560 x 1,440 ピクセルであることを記載しました。最小サイズ(2,048 x 1,152 ピクセル)は変更されません。 -
channel
リソースの新しいsnippet.customUrl
プロパティは、チャネルに関連付けられたカスタム URL を識別します。(すべてのチャンネルにカスタム URL があるわけではありません)。YouTube ヘルプセンターでは、カスタム URL を取得するための資格要件と URL の設定方法について説明しています。 -
channel
リソースのbrandingSettings.watch
オブジェクトとそのすべての子プロパティは非推奨になりました。 -
search.list
リクエストに対する API レスポンスにregionCode
プロパティが追加されました。このプロパティは、検索クエリに使用された地域コードを識別します。地域コードは、指定された国の検索結果を返すように API に指示します。プロパティ値は、地域を識別する 2 文字の ISO 国コードです。
i18nRegions.list
メソッドは、サポートされているリージョンのリストを返します。デフォルト値はUS
です。サポートされていない地域が指定されていても、YouTube はクエリを処理するため、デフォルト値ではなく別の地域を選択することがあります。 -
videoAbuseReportReason
リソースのsnippet.label
プロパティとsnippet.secondaryReasons[].label
プロパティの定義を更新し、不正行為の報告の理由から、プロパティにローカライズされたラベルテキストが含まれていることを記載しました。また、
videoAbuseReportReasons.list
メソッドはhl
パラメータをサポートするようになりました。このパラメータは、API レスポンスのラベルテキストに使用する言語を指定します。デフォルトのパラメータ値はen_US
です。 -
video
リソースの新しいcontentDetails.contentRating.ecbmctRating
プロパティは、文化観光省のトルコの評価・分類委員会による動画の評価を示します。また、他の評価システムの API プロパティでは、次の新しいプロパティ値がサポートされています。
contentDetails.contentRating.fpbRating
(南アフリカ)
評価: 10、プロパティ値:fpb10
contentDetails.contentRating.moctwRating
(台湾)
レーティング: R-12、プロパティ値:moctwR12
contentDetails.contentRating.moctwRating
(台湾)
レーティング: R-15、プロパティ値:moctwR15
-
video
リソースのliveStreamingDetails.activeLiveChatId
プロパティには、動画に関連付けられているアクティブなチャットの ID が含まれます。このプロパティの値は、動画が現在のライブ配信で、チャットが有効になっている場合にのみ存在します。配信が終了してチャットが終了すると、動画のプロパティは返されなくなります。 -
video
リソースのstatus.rejectionReason
プロパティは、新しいプロパティ値legal
をサポートしています。
-
-
この API では、次の新しいエラーがサポートされています。
エラーのタイプ エラーの詳細 説明 badRequest (400)
notEditable
channelSections.insert
、channelSections.update
、channelSections.delete
の各メソッドは、指定されたチャンネル セクションが作成、更新、削除できないことを示すために、このエラーを返します。badRequest (400)
styleRequired
channelSections.insert
メソッドとchannelSections.update
メソッドはこのエラーを返し、API リクエストで送信されたchannelSection
リソースでsnippet.style
プロパティの値を指定する必要があることを示します。badRequest (400)
typeRequired
channelSections.insert
メソッドとchannelSections.update
メソッドはこのエラーを返し、API リクエストで送信されたchannelSection
リソースでsnippet.type
プロパティの値を指定する必要があることを示します。badRequest (400)
processingFailure
commentThreads.list
メソッドはこのエラーを返し、API サーバーがリクエストを正常に処理できなかったことを示します。これは一時的なエラーである可能性がありますが、通常はリクエストの入力が無効であることを示しています。リクエスト本文のcommentThread
リソースの構造をチェックして、有効であることを確認します。forbidden (403)
commentsDisabled
commentThreads.list
メソッドはこのエラーを返し、videoId
パラメータで指定された動画でコメントが無効になっていることを示します。badRequest (400)
commentTextTooLong
commentThreads.insert
メソッドはこのエラーを返し、挿入されているcomment
リソースのsnippet.topLevelComment.snippet.textOriginal
プロパティに含まれる文字数が多すぎることを示します。invalidValue (400)
videoAlreadyInAnotherSeriesPlaylist
playlistItems.insert
メソッドはこのエラーを返し、再生リストに追加しようとしている動画がすでに別のシリーズ再生リストに含まれていることを示します。シリーズ再生リストについて詳しくは、YouTube ヘルプセンターをご覧ください。badRequest (400)
subscriptionForbidden
subscriptions.insert
メソッドはこのエラーを返し、サブスクリプションの最大数に達したか、最近作成したサブスクリプションが多すぎることを示します。後者の場合は、数時間後にリクエストを再試行できます。badRequest (400)
invalidCategoryId
videos.update
メソッドはこのエラーを返し、アップロードされたvideo
リソースのsnippet.categoryId
プロパティに無効なカテゴリ ID を指定したことを示します。videoCategories.list
メソッドを使用して、サポートされているカテゴリを取得します。badRequest (400)
invalidDescription
videos.update
メソッドはこのエラーを返し、アップロードされたvideo
リソースのsnippet.description
プロパティに無効な値が指定されていることを示します。badRequest (400)
invalidPublishAt
videos.update
メソッドはこのエラーを返し、アップロードされたvideo
リソースのstatus.publishAt
プロパティに無効な公開予約時刻が指定されていることを示します。badRequest (400)
invalidRecordingDetails
videos.update
メソッドはこのエラーを返し、アップロードされたvideo
リソースのrecordingDetails
オブジェクトが無効な録画の詳細を指定していることを示します。badRequest (400)
invalidTags
videos.update
メソッドはこのエラーを返し、アップロードされたvideo
リソースのsnippet.tags
プロパティに無効な値が指定されていることを示します。badRequest (400)
invalidTitle
videos.update
メソッドはこのエラーを返し、アップロードされたvideo
リソースのsnippet.title
プロパティに無効な動画タイトルまたは空の動画タイトルが指定されていることを示します。badRequest (400)
invalidVideoMetadata
videos.update
メソッドはこのエラーを返し、リクエスト メタデータが無効であることを示します。このエラーは、リクエストでvideo
リソースのsnippet
部分が更新されても、snippet.title
プロパティとsnippet.categoryId
プロパティの両方に値が設定されていない場合に発生します。
2015 年 12 月 18 日
欧州連合(EU)の法律により、EU 域内のエンドユーザーに対して特定の開示を行い、エンドユーザーから同意を得ることが義務付けられています。そのため、欧州連合のエンドユーザーに対しては、EU ユーザーの同意ポリシーを遵守する必要があります。YouTube API 利用規約に、この要件に関するお知らせを追加しました。
2015 年 11 月 19 日
API で、playlist
リソースと video
リソースの snippet.title
プロパティと snippet.description
プロパティ、channelSection
リソースの snippet.title
プロパティ、channel
リソースの snippet.description
プロパティについて、ローカライズされたテキストを設定および取得できるようになりました。
-
ローカライズしたタイトルと説明の設定
リソースの
insert
メソッドまたはupdate
メソッドを呼び出すときに、そのリソースのローカライズされた値を設定できます。リソースにローカライズされた値を設定するには、次の両方を行います。-
リソースの
snippet.defaultLanguage
プロパティに値が設定されていることを確認します。このプロパティは、リソースのsnippet.title
プロパティとsnippet.description
プロパティの言語を識別します。値には、サポートされている任意のアプリケーション言語か、他のほとんどの ISO 639-1:2002 言語コードを使用できます。たとえば、タイトルと説明が英語の動画をアップロードする場合は、snippet.defaultLanguage
プロパティをen
に設定します。channel
リソースの更新に関する注意:channel
リソースのsnippet.defaultLanguage
プロパティを設定するには、brandingSettings.channel.defaultLanguage
プロパティを実際に更新する必要があります。 -
更新するリソースに
localizations
オブジェクトを追加します。各オブジェクト キーは、アプリケーション言語または ISO 639-1:2002 言語コードを識別する文字列です。各キーは、リソースのローカライズされたタイトル(および説明)を含むオブジェクトにマッピングされます。以下のサンプル スニペットでは、リソースのデフォルト言語を英語に設定しています。また、ドイツ語とスペイン語にローカライズしたタイトルと説明を動画に追加します。
{ "kind": "youtube#video", ... "snippet": { "title": "Playing soccer", "description": "We play soccer in the park on Sundays.", "defaultLanguage": "en", ... }, "localizations": "de": { "title": "Fußball spielen", "description": "Wir spielen Fußball im Park am Sonntag" }, "es": { "title": "Jugar al fútbol", "description": "Nosotros jugamos fútbol en el parque los domingos", } } }
重要: リソースのローカライズ済みデータを更新する場合、API リクエストに既存のローカライズ済みバージョンのデータがすべて含まれている必要があります。たとえば、上記の例で動画にポルトガル語のデータを追加するリクエストを続けて送信した場合、そのリクエストにはドイツ語、スペイン語、ポルトガル語のローカライズ済みデータを含める必要があります。
-
-
ローカライズされた値の取得
API では、リソースのローカライズされた値を取得するために、次の 2 つの方法がサポートされています。
-
hl
パラメータをchannels.list
、channelSections.list
、playlists.list
、videos.list
リクエストに追加すると、YouTube ウェブサイトでサポートされている特定のアプリケーション言語用にローカライズされたデータを取得できます。ローカライズされたリソースの詳細がその言語で提供されている場合、リソースのsnippet.localized
オブジェクトにはローカライズされた値が含まれます。ただし、ローカライズされた詳細を利用できない場合、snippet.localized
オブジェクトには、リソースのデフォルトの言語でリソースの詳細が含まれます。たとえば、
videos.list
リクエストで、ローカライズされたドイツ語とスペイン語のデータを使って、上記で説明した動画のデータを取得するとします。hl
パラメータがde
に設定されている場合、リソースには次のデータが含まれます。{ "kind": "youtube#video", ... "snippet": { "title": "Playing soccer", "description": "We play soccer in the park on Sundays.", "defaultLanguage": "en", "localized": { "title": "Fußball spielen", "description": "Wir spielen Fußball im Park am Sonntag" } ... } }
ただし、
hl
パラメータをfr
に設定すると、snippet.localized
オブジェクトには英語のタイトルと説明が含まれます。英語はリソースのデフォルト言語であり、ローカライズされたフランス語の詳細情報は利用できないためです。重要:hl
パラメータは、YouTube ウェブサイトでサポートされているアプリケーション言語を識別する値のみをサポートしています。ローカライズされたテキストを他の言語で使用できるかどうかを確認するには、リソースのlocalizations
部分を取得し、ローカライズされたテキストが存在するかどうかをフィルタで判断する必要があります。
たとえば、ローカライズされたテキストがアパラチア英語で使用できるかどうかを判断するには、ローカライズの完全なリストを取得する必要があります。
-
リソースを取得するときに、
part
パラメータ値にlocalizations
を含めて、そのリソースのローカライズされた詳細をすべて取得します。YouTube アプリケーションの現在の言語以外の言語のローカライズ済みデータを取得する場合は、この方法を使用してすべてのローカライズを取得し、目的のローカライズ済みデータが存在するかどうかをフィルタで判断する必要があります。
-
-
ローカライズされたテキスト値に関連するエラー
この API では、ローカライズされたテキスト値に関する次の新しいエラーもサポートされています。
エラーのタイプ エラーの詳細 説明 badRequest (400)
defaultLanguageNotSetError
このエラーは、リソースの snippet.defaultLanguage
プロパティが設定されていないため、リソースのlocalizations
オブジェクトを挿入または更新しようとするリクエストが失敗したことを示します。channels.update
、channelSections.insert
、channelSections.update
、playlists.insert
、playlists.update
、videos.insert
、videos.update
の各メソッドは、このエラーをサポートしています。badRequest (400)
localizationValidationError
このエラーは、リソースの localizations
オブジェクトに含まれる値の 1 つが検証できなかったことを示します。たとえば、オブジェクトに無効な言語コードが含まれている場合に、このエラーが発生することがあります。channels.update
、channelSections.insert
、channelSections.update
、playlists.insert
、playlists.update
の各メソッドは、このエラーをサポートしています。
2015 年 11 月 4 日
この改訂での変更内容は次のとおりです。
-
既存のリソースとメソッドの更新
-
search.list
メソッドのorder
パラメータが更新され、ライブ配信をviewCount
で並べ替えると、API の結果がブロードキャストの進行中に同時視聴者数で並べ替えられるようになりました。 -
search.list
メソッドのrelatedToVideoId
パラメータを更新し、このパラメータが設定されている場合、他のサポートされるパラメータはpart
、maxResults
、pageToken
、regionCode
、relevanceLanguage
、safeSearch
、type
(video
に設定する必要がある)、fields
のみであることを明記しました。この更新は、API の動作の変更を反映するものではありません。 -
video
リソースのsnippet.publishedAt
プロパティの定義を更新し、動画が公開された日時を指定するプロパティ値がアップロードされた時刻と異なる可能性があることに注意しました。たとえば、動画を非公開動画としてアップロードし、後で公開する場合、このプロパティの値は動画が公開された時刻を指定します。更新された定義では、非公開動画と限定公開動画の値がどのように入力されるかについても説明されています。この変更は API の動作の変更を反映するものではありません。
-
video
リソースのstatus.publishAt
プロパティの定義が更新され、以下の点に注意してください。videos.update
メソッドを呼び出すときにこのプロパティの値を設定する場合は、動画がすでに非公開であっても、status.privacyStatus
プロパティの値もprivate
に設定する必要があります。- リクエストによって過去の特定の動画を公開するようスケジュール設定されている場合、動画はすぐに公開されます。そのため、
status.publishAt
プロパティに過去の日時を設定した場合は、動画のprivacyStatus
をprivate
からpublic
に変更した場合と同じになります。
-
video
リソースのcontentDetails.contentRating.cncRating
プロパティは、フランスの監督委員会による映画製作委員会による動画のレーティングを指定します。このプロパティは、サポートが終了したcontentDetails.contentRating.fmocRating
プロパティに代わるものです。 -
channel
リソースの brandingSettings.channel.keywords の定義が更新され、プロパティ値に、以前のドキュメントに記載されているように、カンマ区切りのリストではなく、スペース区切りの文字列リストが含まれることが正しく反映されるようになりました。この更新は、API の動作の変更を反映するものではありません。 -
アップロードして動画に関連付けるサムネイル画像がリクエストの本文に含まれていることを正確に反映するように、
thumbnails.set
メソッドのドキュメントが更新されました。リクエストの本文にthumbnail
リソースが含まれていません。以前のドキュメントには、このメソッドを呼び出すときにリクエストの本文を指定すべきでないと記載されていました。この更新は、API の動作の変更を反映するものではありません。 -
現在
activities.list
メソッドに新しい動画のコメントに関連するリソースが含まれていないことを反映するため、activity
リソースの説明を更新しました。リソースのsnippet.type
とcontentDetails.comment
も更新されました。
-
-
新しいエラーと更新されたエラー
-
API で次のエラーがサポートされるようになりました。
エラーの詳細 activities.insert
HTTP レスポンス コード badRequest (400)
理由 invalidMetadata
説明 kind
プロパティが、指定された ID のタイプと一致しません。commentThreads.update
comments.insert
comments.update
HTTP レスポンス コード badRequest (400)
理由 commentTextTooLong
説明 挿入または更新対象の comment
リソースのsnippet.topLevelComment.snippet.textOriginal
プロパティに含まれている文字が多すぎます。playlistItems.insert
playlistItems.update
HTTP レスポンス コード forbidden (403)
理由 playlistItemsNotAccessible
説明 リクエストが適切に認証されていないため、指定された再生リスト アイテムを挿入、更新、または削除できません。 playlists.delete
playlists.insert
playlists.update
HTTP レスポンス コード badRequest (400)
理由 playlistForbidden
説明 この操作は禁止されているか、リクエストが適切に承認されていません。 search.list
HTTP レスポンス コード badRequest (400)
理由 invalidLocation
説明 location
またはlocationRadius
パラメータ値の形式が正しくありません。search.list
HTTP レスポンス コード badRequest (400)
理由 invalidRelevanceLanguage
説明 relevanceLanguage
パラメータ値の形式が正しくありません。subscriptions.insert
HTTP レスポンス コード badRequest (400)
理由 subscriptionForbidden
説明 このエラーは、次のいずれかに該当する場合に発生します。 - 作成しようとしたサブスクリプションはすでに存在しています
- サブスクリプションの数が上限に達しています
- あなたのチャンネルに登録しようとしていますが、登録はサポートされていません。
- 最近作成したサブスクリプションの数が多すぎるため、数時間待ってからリクエストを再試行する必要があります。
videos.update
HTTP レスポンス コード badRequest (400)
理由 invalidDefaultBroadcastPrivacySetting
説明 このリクエストでは、デフォルトのブロードキャストに無効なプライバシー設定が試行されています。
-
2015 年 8 月 28 日
この改訂での変更内容は次のとおりです。
-
既存のリソースとメソッドの更新
-
video
リソースのstatistics.favoriteCount
プロパティは非推奨になりました。Google のサポート終了ポリシーに従い、このプロパティは、この発表から少なくとも 1 年間は
video
リソースに含まれます。ただし、このプロパティ値は常に0
に設定されるようになりました。
-
2015 年 8 月 7 日
この改訂での変更内容は次のとおりです。
-
既存のリソースとメソッドの更新
-
video
リソースのsnippet.tags[]
プロパティの定義が更新され、API サーバーがプロパティの値の長さをどのように計算するかについて、より多くの情報が提供されるようになりました。なお、この更新は API の動作の変更を反映するものではありません。具体的には、タグにスペースが含まれている場合、API サーバーはタグ値が引用符で囲まれているものとして扱われ、引用符は文字数制限にカウントされることを定義しています。したがって、文字数制限の目的上、タグ Foo-Baz には 7 文字が含まれていますが、タグ Foo Baz には 9 文字が含まれています。
-
commentThreads.insert
メソッドでshareOnGooglePlus
パラメータがサポートされなくなりました。このパラメータは、これまで、コメントとそのコメントに対する返信を投稿者の Google+ プロフィールに投稿するかどうかを示していました。リクエストがこのパラメータを送信すると、API サーバーはパラメータを無視しますが、それ以外の場合はリクエストを処理します。
-
2015 年 6 月 18 日
この改訂での変更内容は次のとおりです。
-
既存のリソースとメソッドの更新
-
commentThreads.list
メソッドの新しいorder
パラメータは、API レスポンスがコメント スレッドをリストする順序を指定します。スレッドは、時間または関連性で並べ替えることができます。デフォルトの動作では、時系列で並べ替えられます。 -
video
リソースの新しいsnippet.defaultAudioLanguage
プロパティは、動画のデフォルトの音声トラックで話されている言語を指定します。 -
video
リソースのcontentDetails.licensedContent
プロパティの定義を更新し、コンテンツが YouTube コンテンツ パートナーにリンクされているチャンネルにアップロードされ、そのパートナーによって申し立てが行われている必要があることを明確にしました。これは、実際の API の動作が変更されたわけではありません。 -
captions.delete
、captions.download
、captions.insert
、captions.list
、captions.update
の各メソッドがonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。このメソッドを使用するリクエストも、https://www.googleapis.com/auth/youtubepartner
スコープへのアクセスを提供するトークンで承認する必要があります。
-
-
新しいエラーと更新されたエラー
-
API で次のエラーがサポートされるようになりました。
エラーの詳細 videos.rate
HTTP レスポンス コード badRequest (400)
理由 emailNotVerified
説明 ユーザーは、動画を評価する前に自分のメールアドレスを確認する必要があります。 videos.rate
HTTP レスポンス コード badRequest (400)
理由 videoPurchaseRequired
説明 レンタル動画を評価できるのは、その動画をレンタルしたユーザーのみです。 -
subscriptions.delete
メソッドとsubscriptions.insert
メソッドでは、accountClosed
エラーとaccountSuspended
エラーがサポートされなくなりました。
-
2015 年 4 月 27 日
この改訂での変更内容は次のとおりです。
-
新しいリソースとメソッド
-
新しい
videoAbuseReportReason
リソースには、動画に不適切なコンテンツが含まれるとしてフラグが付けられる理由に関する情報が含まれます。videoAbuseReportReasons.list
メソッドを使用すると、動画にフラグが立てられるすべての理由のリストを取得できます。 -
新しい
videos.reportAbuse
メソッドを使用すると、不適切なコンテンツを含む動画を実際に報告できます。リクエストの本文には、報告する動画と、その動画に不適切なコンテンツが含まれていると判断される理由を指定する JSON オブジェクトが含まれます。正当な理由は、上記のvideoAbuseReportReason.list
メソッドで確認できます。移行ガイドも更新され、不適切な動画を報告する例が追加されました。この変更により、v3 API はサポートが予定されているすべての v2 API 機能をサポートするようになりました。これらの機能はすべて、移行ガイドでも説明されています。
-
-
既存のリソースとメソッドの更新
-
search.list
メソッドの新しいforDeveloper
フィルタ パラメータは、デベロッパーのアプリケーションまたはウェブサイト経由でアップロードされた動画のみを取得するように検索を制限します。forDeveloper
パラメータは、q
パラメータなどのオプションの検索パラメータと組み合わせて使用できます。この機能により、アップロードされた各動画には、Google Developers Console でデベロッパーのアプリケーションに関連付けられているプロジェクト番号が自動的にタグ付けされます。
その後、検索リクエストで
forDeveloper
パラメータがtrue
に設定されると、API サーバーはリクエストの承認認証情報を使用してデベロッパーを識別します。そのため、デベロッパーは、検索結果をデベロッパー自身のアプリやウェブサイト経由でアップロードされた動画に限定できますが、他のアプリやサイト経由でアップロードされた動画に限定することはできません。この新機能は、v2 API でサポートされていたデベロッパー タグ機能と同一ではありませんが、同様の機能を提供します。
-
channel
リソースの新しいsnippet.country
プロパティを使用すると、チャンネル所有者はチャンネルを特定の国に関連付けることができます。注:
channel
リソースのsnippet.country
プロパティを設定するには、brandingSettings.channel.country
プロパティを実際に更新する必要があります。 -
API で
channelSection
リソースのターゲティングがサポートされるようになりました。チャンネル セクション ターゲティングを使用すると、特定の条件に一致するユーザーにコンテンツ セクションの表示を制限できます。API には 3 つのターゲット設定オプションがあります。ユーザーがチャンネル セクションを表示するには、すべてのターゲット設定を満たしている必要があります。
-
targeting.languages[]
: YouTube アプリケーションの言語のリスト。これらの言語を選択したユーザーには、対応するチャンネル セクションが表示されます。 -
targeting.regions[]
: YouTube の優先コンテンツの地域のリスト。チャンネル セクションは、これらの地域のいずれかを選択したユーザーと、その地域のいずれかが自動的に選択されたユーザーに表示されます。 -
targeting.countries[]
: チャンネル セクションが表示される国のリスト。リスト内の各値は ISO 3166-1 alpha-2 国コードです。
-
-
video
リソースのcontentDetails.duration
プロパティの定義が、時間、日などを反映できるように修正されました。 -
channelSections.delete
、playlistItems.delete
、playlists.delete
、subscriptions.delete
、videos.delete
メソッドのドキュメントを修正しました。成功すると、これらのメソッドはすべて HTTP204
レスポンス コード(No Content
)を返すことを反映しました。
-
-
新しいエラーと更新されたエラー
-
API で次のエラーがサポートされるようになりました。
エラーのタイプ エラーの詳細 説明 badRequest (400)
targetInvalidCountry
channelSections.insert
メソッドとchannelSections.update
メソッドは、挿入されたchannelSection
リソースにtargeting.countries[]
プロパティに無効な値が含まれている場合、このエラーを返します。badRequest (400)
targetInvalidLanguage
channelSections.insert
メソッドとchannelSections.update
メソッドは、挿入されたchannelSection
リソースにtargeting.languages[]
プロパティに無効な値が含まれている場合、このエラーを返します。badRequest (400)
targetInvalidRegion
channelSections.insert
メソッドとchannelSections.update
メソッドは、挿入されたchannelSection
リソースにtargeting.regions[]
プロパティに無効な値が含まれている場合、このエラーを返します。badRequest (400)
operationNotSupported
snippet.parentId
プロパティで識別される最上位のコメントに対して API ユーザーがコメントを挿入できない場合、comments.insert
メソッドはこのエラーを返します。commentThread
リソースでは、snippet.canReply
プロパティは現在の閲覧者がスレッドに返信できるかどうかを示します。badRequest (400)
invalidChannelId
search.list
メソッドは、リクエストのchannelId
パラメータに無効なチャンネル ID が指定されている場合、このエラーを返します。badRequest (400)
subscriptionForbidden
API ユーザーがユーザー自身のチャンネルに登録しようとすると、 subscriptions.insert
メソッドはこのエラーを返します。 -
captions.update
メソッドはinvalidMetadata
エラーとvideoNotFound
エラーをサポートしなくなりました。
-
2015 年 4 月 16 日
この改訂での変更内容は次のとおりです。
-
移行ガイドが更新され、v2 API のコメント機能を引き続き使用しているアプリケーションを移行する方法について説明しています。
ガイドでは、v2 API ではサポートされていなかったが、v3 API ではサポートされているコメント機能もいくつか紹介しています。たとえば、次のようなものがあります。
- チャンネルに関するコメントを取得する
- チャンネルに関連するすべてのコメント スレッドを取得する。つまり、API レスポンスにチャンネルまたはその動画に関するコメントを含めることができる。
- コメントのテキストの更新
- コメントをスパムとしてマークする
- コメントの管理ステータスを設定する
-
プッシュ通知への登録ガイドを更新し、通知は Google PubSubHubBub ハブにのみ push され、前述のように Superfeedr ハブにはプッシュされないことを反映しました。
2015 年 4 月 9 日
この改訂での変更内容は次のとおりです。
-
API の新しい
commentThread
リソースとcomment
リソースを使用すると、コメントを取得、挿入、更新、削除、管理できます。-
commentThread
リソースには、YouTube コメント スレッドに関する情報が含まれます。コメント スレッドは、トップレベルのコメントと、そのコメントに対する返信(存在する場合)で構成されます。commentThread
リソースは、動画またはチャンネルに関するコメントを表すことができます。最上位のコメントと返信は、実際には
commentThread
リソース内にネストされたcomment
リソースです。commentThread
リソースには、必ずしもコメントに対するすべての返信が含まれているわけではありません。特定のコメントに対するすべての返信を取得するには、comments.list
メソッドを使用する必要があります。また、一部のコメントには返信がありません。API は、
commentThread
リソースに対して次のメソッドをサポートしています。commentThreads.list
– コメント スレッドのリストを取得します。特定の動画やチャンネルに関連付けられているコメントを取得するには、このメソッドを使用します。commentThreads.insert
– 新しいトップレベル コメントを作成します。(既存のコメントに返信するには、comments.insert
メソッドを使用します)。commentThreads.update
– 最上位のコメントを変更します。
-
comment
リソースには、1 つの YouTube コメントに関する情報が含まれます。comment
リソースは、動画またはチャンネルに関するコメントを表すことができます。また、トップレベルのコメントまたはトップレベルのコメントに対する返信をコメントにすることもできます。API は、
comment
リソースに対して次のメソッドをサポートしています。comments.list
– コメントのリストを取得します。特定のコメントに対するすべての返信を取得するには、このメソッドを使用します。comments.insert
– 既存のコメントへの返信を作成します。comments.update
– コメントを変更します。comments.markAsSpam
– 1 つ以上のコメントをスパムとして報告します。comments.setModerationStatus
– 1 つ以上のコメントの管理ステータスを設定します。たとえば、コメントをクリアして一般公開したり、表示に適さないコメントとして拒否したりできます。API リクエストは、コメントに関連付けられているチャンネルまたは動画の所有者の承認を得る必要があります。comments.delete
– コメントを削除します。
なお、
comments.insert
、comments.update
、comments.markAsSpam
、comments.setModerationStatus
、comments.delete
、commentThreads.insert
、commentThreads.update
の各メソッドを呼び出すには、API の新しいhttps://www.googleapis.com/auth/youtube.force-ssl
スコープ(2015 年 4 月 2 日の変更履歴に記載)が必要です。 -
-
新しいプッシュ通知への登録ガイドでは、ウェブでアクセス可能なリソース用のサーバー間のパブリッシュ/サブスクライブ プロトコルである PubSubHubBub を介したプッシュ通知の API サポートが新しくなりました。PubSubHubBub コールバック サーバーは、チャンネルが次のいずれかのアクティビティを行うと、Atom フィード通知を受信できます。
- 動画をアップロードしました
- 動画のタイトルを更新する
- 動画の説明を更新したとき
-
移行ガイドも更新され、プッシュ通知の新しいサポートについても記載されています。ただし、v2 API では v3 API でサポートされていない他のタイプのプッシュ通知が数多くサポートされていたため、PubSubHubBub のサポートについては、このガイドの非推奨セクションに引き続き記載されています。
-
API の新しい
https://www.googleapis.com/auth/youtube.force-ssl
スコープが、これまでhttps://www.googleapis.com/auth/youtube
スコープをサポートしていたすべての API メソッドで有効なスコープになりました。 -
API で次のエラーがサポートされるようになりました。
エラーのタイプ エラーの詳細 説明 badRequest (400)
invalidRating
リクエストの rating
パラメータに予期しない値が含まれていた場合、videos.rate
メソッドはこのエラーを返します。 -
subscriptions.insert
メソッドはsubscriptionLimitExceeded
エラーをサポートしなくなりました。以前は、リクエストで識別されたサブスクライバーがサブスクリプションのレート制限を超えたことを示していました。
2015 年 4 月 2 日
この改訂での変更内容は次のとおりです。
-
新しい
captions
リソースは、YouTube の字幕トラックを表します。字幕トラックは 1 つの YouTube 動画とのみ関連付けられます。 -
移行ガイドも更新され、v2 API で字幕機能を引き続き使用しているアプリケーションを移行する方法について説明しています。
-
API の新しい
https://www.googleapis.com/auth/youtube.force-ssl
スコープでは、SSL 接続を介して API サーバーと通信する必要があります。この新しいスコープは、
https://www.googleapis.com/auth/youtube
スコープと同じアクセス権を付与します。実際、YouTube API サーバーは HTTPS エンドポイントを介してのみ使用できるため、この 2 つのスコープは機能的に同じです。その結果、https://www.googleapis.com/auth/youtube
スコープは SSL 接続を必要としませんが、実際には他の方法で API リクエストを実行する方法がありません。caption
リソースのすべてのメソッドを呼び出すには、新しいスコープが必要です。
2015 年 3 月 11 日
この改訂での変更内容は次のとおりです。
-
YouTube Data API(v3)移行ガイドには [v3 API の新機能] という新しいタブがあり、v3 API でサポートされている機能と v2 API でサポートされていない機能がリストされています。ガイドの他のタブでは以前と同じ機能が表示され、引き続き表示されます。たとえば、チャンネルの動画内プロモーション キャンペーン データを更新する方法を説明する新機能は、[チャンネル(プロファイル)] タブにも表示されます。
-
YouTube Data API(v3)移行ガイドを更新し、v3 API が次の v2 API 機能をサポートすることを記載しました。
-
YouTube Data API(v3)移行ガイドを更新し、以下の v2 API 機能が v3 API でサポートされていないことを記載しました。
-
おすすめの動画を取得する – v3 API は、現在の API ユーザーにおすすめされる動画のみを含むリストは取得しません。ただし、v3 API を使用しておすすめ動画を検索するには、
activities.list
メソッドを呼び出し、home
パラメータ値をtrue
に設定します。API レスポンスでは、
snippet.type
プロパティの値がrecommendation
の場合、リソースはおすすめ動画に対応します。動画がおすすめされた理由に関する情報は、contentDetails.recommendation.reason
プロパティとcontentDetails.recommendation.seedResourceId
プロパティに含まれます。なお、レスポンスに特定の数のおすすめ動画が含まれているとは限りません。 -
新しい登録チャンネルの動画を取得する – v3 API は、API ユーザーが登録しているチャンネルに最近アップロードされた動画のみを含むリストを取得しません。ただし、v3 API を使用して新しい登録チャンネル動画を見つけるには、
activities.list
メソッドを呼び出し、home
パラメータ値をtrue
に設定します。API レスポンスでは、
snippet.type
プロパティの値がupload
の場合、リソースは新しい定期購入の動画に対応します。レスポンスに、特定の数の新しい登録チャンネル動画が含まれているという保証はありません。 -
フィード更新のプッシュ通知 – v2 API は、シンプル アップデート プロトコル(SUP)または PubSubHubbub を使用してプッシュ通知をサポートしており、YouTube ユーザーのアクティビティ フィードを監視できます。新規のチャンネル登録や、動画の評価、共有、お気に入り登録、コメント、アップロードが行われたときに、通知を受け取るようにしました。
v3 API は PubSubHubbub プロトコルを使用したプッシュ通知をサポートしますが、この通知の対象となるのは、動画のアップロードと、動画のタイトルまたは動画の説明の更新のみです。
-
チャンネルの地域 – v2 API では、YouTube の公開プロフィールに入力されたユーザーの所在地を
<yt:location>
タグで識別していました。このフィールドを使用してチャンネルを特定の国に関連付ける人もいましたが、その目的のためにフィールドのデータを常に使用できるわけではありません。 -
デベロッパー タグの設定または取得 - v2 API では、動画がアップロードされた時点で、キーワード(デベロッパー タグ)を動画に関連付けることができました。デベロッパー タグは YouTube ユーザーには表示されませんが、動画の所有者は特定のデベロッパー タグに一致する動画を取得できます。
v3 API でも同様の機能を使用できますが、同一ではありません。具体的には、デベロッパー独自のアプリケーションによってアップロードされた動画をデベロッパーが検索できるようになります。この機能により、アップロードされた各動画には、Google Developers Console でデベロッパーのアプリケーションに関連付けられているプロジェクト番号が自動的にタグ付けされます。その後、デベロッパーは同じプロジェクト番号を使用して動画を検索します。
-
公開日、視聴回数、評価で動画を一覧表示する – v2 API では、
orderby
パラメータを使用して、位置、再生時間、公開日、タイトルなどの値で再生リスト内の動画を並べ替えることができます。v3 API では通常、再生リストのアイテムは位置の昇順で並べ替えられますが、他の並べ替えオプションは使用できません。ただし、次のような例外があります。次の種類の再生リストでは、新しいアップロード動画、お気に入りの動画、高く評価した動画、最近再生した動画が最初の項目(
snippet.position
=0
)として自動的に追加されます。したがって、これらの各リストは、アイテムがリストに追加された時間に基づいて、新しいアイテムから古いアイテムの順に事実上並べ替えられます。- ユーザーによるアップロード
- お気に入りの動画
- 高く評価した動画
- 再生履歴
ただし、[後で見る] 再生リストに追加された新しいアイテムは、そのリストの最後のアイテムとして追加されるため、リストは実質的に古いアイテムから最新のアイテムに並べ替えられます。
-
バッチ処理 – v3 API は、v2 API でサポートされていたバッチ処理ユースケースの一つをサポートしています。v3 API の
channels.list
、channelSections.list
、guideCategories.list
、playlistItems.list
、playlists.list
、subscriptions.list
、videoCategories.list
、videos.list
メソッドはすべてid
パラメータをサポートしています。このパラメータを使用すると、ID(動画 ID、チャンネル ID など)のカンマ区切りリストを指定できます。これらのメソッドを使用すると、1 つのリクエストで複数のリソースのリストを取得できます。
これらの変更により、ガイドでは、現在の API バージョン(v3)で非推奨になる古い(v2)API でサポートされていたすべての機能が特定されるようになりました。
-
2015 年 3 月 4 日
この改訂での変更内容は次のとおりです。
-
channelSections.delete
メソッドとchannelSections.update
メソッドがonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。 -
次のプロパティとその子プロパティは非推奨になりました。
brandingSettings.image.backgroundImageUrl
brandingSettings.image.largeBrandedBannerImageImapScript
brandingSettings.image.largeBrandedBannerImageUrl
brandingSettings.image.smallBrandedBannerImageImapScript
brandingSettings.image.smallBrandedBannerImageUrl
注: これらのプロパティはいずれも API のサポート終了ポリシーの対象ではありませんでした。
-
video
リソースの新しいcontentDetails.contentRating.contentDetails.contentRating.djctqRatingReasons
プロパティは、動画が DJCQT(ブラジル)のレーティングを受けた理由を示します。 -
API で次のエラーがサポートされるようになりました。
エラーのタイプ エラーの詳細 説明 notFound (404)
channelNotFound
見つからないチャンネルがリクエストの id
パラメータで指定されている場合、channels.update
メソッドはこのエラーを返します。badRequest (400)
manualSortRequiredinvalidValue
playlistItems.insert
メソッドとplaylistItems.update
メソッドは、リクエストが再生リスト アイテムの位置を設定しようとしたときに、再生リストが手動の並べ替えを使用していない場合、このエラーを返します。たとえば、再生リストのアイテムを日付や人気度で並べ替えることができます。このエラーに対処するには、リクエスト本文で送信されたリソースからsnippet.position
要素を削除します。再生リストの項目をリスト内の特定の位置に配置するには、まず再生リストの順序設定を [手動] に更新する必要があります。この設定は YouTube の [動画の管理] で調整できます。forbidden (403)
channelClosed
クローズされたチャンネルがリクエストの channelId
パラメータで指定されている場合、playlists.list
メソッドはこのエラーを返します。forbidden (403)
channelSuspended
停止されているチャンネルがリクエストの channelId
パラメータで指定されている場合、playlists.list
メソッドはこのエラーを返します。forbidden (403)
playlistForbidden
playlists.list
メソッドは、リクエストのid
パラメータがリクエストをサポートしていない場合、またはリクエストが適切に承認されていない場合に、このエラーを返します。notFound (404)
channelNotFound
見つからないチャンネルがリクエストの channelId
パラメータで指定されている場合、playlists.list
メソッドはこのエラーを返します。notFound (404)
playlistNotFound
playlists.list
メソッドは、見つからない再生リストがリクエストのid
パラメータで指定されている場合、このエラーを返します。notFound (404)
videoNotFound
videos.list
メソッドは、見つからない動画がリクエストのid
パラメータで指定されている場合、このエラーを返します。badRequest (400)
invalidRating
リクエストの rating
パラメータに予期しない値が含まれている場合、videos.rate
メソッドはこのエラーを返します。
2015 年 3 月 2 日
この改訂での変更内容は次のとおりです。
-
search.list
メソッドでrelevanceLanguage
パラメータがサポートされるようになりました。これにより、特定の言語に最も関連性のある結果をリクエストできます。YouTube Data API(v3)移行ガイドも更新され、この新しいパラメータの使用方法について説明しています。このパラメータは、現在の API バージョン(v3)と、すでに非推奨となっている以前のバージョン(v2)との間に存在していた機能のギャップを解消するものです。
-
YouTube Data API(v3)移行ガイドも更新され、映画、予告編、テレビ番組、テレビ番組のシーズン、テレビ番組のエピソードを記述するために v2 API で提供されていた特別なフィードとメタデータ フィールドが廃止されました。
2015 年 1 月 14 日
この改訂での変更内容は次のとおりです。
-
YouTube Data API(v3)移行ガイドが更新され、v3 API を使用して JavaScript を使用して動画をアップロードする方法について説明しています。(詳しくは、動画のアップロードのセクションをご覧ください)。この機能は、v2 API がサポートするブラウザベースのアップロード機能と同等です。この移行ガイドの変更は、実際の API の変更を反映しているのではなく、クライアントサイドの JavaScript を使用して動画をアップロードするための新しいサンプルコードが使用可能になったことを反映しています。
JavaScript クライアント ライブラリと CORS を使用した動画のアップロードがサポートされているため、移行ガイドでは、v3 API でサポートが終了する可能性のある機能としてブラウザベースのアップロードをリストしていません。
-
videos.insert
メソッドのドキュメントが更新され、上記の新しい JavaScript コードサンプルが追加されました。YouTube Data API(v3)の JavaScript コードサンプルのリストも更新されました。
2014 年 11 月 11 日
この改訂での変更内容は次のとおりです。
-
search.list
メソッドの呼び出しの割り当てコストが 100 ユニットに変更されました。重要: 多くの場合、他の API メソッドを使用して、割り当てコストを抑えて情報を取得できます。たとえば、GoogleDevelopers チャンネルにアップロードされた動画を見つけるには、次の 2 つの方法があります。
-
割り当て費用: 100 ユニット
search.list
メソッドを呼び出して、GoogleDevelopers
を検索します。 -
割り当て費用: 6 ユニット
channels.list
メソッドを呼び出して、正しいチャンネル ID を見つけます。forUsername
パラメータをGoogleDevelopers
に、part
パラメータをcontentDetails
に設定します。API レスポンスでは、contentDetails.relatedPlaylists.uploads
プロパティに、チャンネルにアップロードされた動画の再生リスト ID を指定します。次に、
playlistItems.list
メソッドを呼び出し、playlistId
パラメータを取得した ID に設定し、part
パラメータをsnippet
に設定します。
-
2014 年 10 月 8 日
この改訂での変更内容は次のとおりです。
-
channel
リソースには、次の 2 つの新しいプロパティが含まれています。-
status.longUploadsStatus
プロパティは、チャンネルが 15 分を超える動画をアップロードできるかどうかを示します。このプロパティは、チャンネル所有者が API リクエストを承認した場合にのみ返されます。有効なプロパティ値は次のとおりです。allowed
– このチャンネルは 15 分を超える動画をアップロードできます。eligible
– このチャンネルに 15 分を超える動画をアップロードできますが、まずこの機能を有効にする必要があります。disallowed
– このチャンネルは 15 分を超える動画をアップロードできない、またはその資格がありません。
これらの値の詳細については、プロパティの定義をご覧ください。YouTube ヘルプセンターでも、この機能について詳しく説明しています。
-
invideoPromotion.useSmartTiming
プロパティは、チャンネルのプロモーション キャンペーンで「スマート タイミング」が使用されているかどうかを示します。この機能は、動画の中でクリックされる可能性が高く、視聴を妨げる可能性が低いタイミングでプロモーションを表示するよう試みます。また、動画ごとに表示するプロモーションを 1 つ取得します。
-
-
video
リソースのsnippet.title
プロパティとsnippet.categoryId
プロパティの定義を更新し、API がvideos.update
メソッドの呼び出しを処理する方法を明確にしました。このメソッドを呼び出してvideo
リソースのsnippet
部分を更新する場合は、両方のプロパティの値を設定する必要があります。video
リソースのsnippet
部分を更新しようとする際に、両方のプロパティに値を設定しないと、API からinvalidRequest
エラーが返されます。このエラーの説明も更新されています。 -
ニュージーランドのフィルム・文学分類局による動画のレーティングを識別する
video
リソースのcontentDetails.contentRating.oflcRating
プロパティが、oflcRp13
とoflcRp16
という 2 つの新しいレーティングをサポートするようになりました。これらはそれぞれRP13
評価とRP16
評価に対応します。 -
channelBanners.insert
メソッドが次のエラーをサポートするようになりました。エラーのタイプ エラーの詳細 説明 badRequest
bannerAlbumFull
チャンネル所有者の YouTube チャンネル アート アルバムの画像が多すぎます。チャンネル所有者は、http://photos.google.com にアクセスしてアルバム ページに移動し、そのアルバムの画像からいくつかを削除する必要があります。
2014 年 9 月 12 日
この改訂での変更内容は次のとおりです。
-
指定したリソース パーツの費用に加えて、
search.list
メソッドの呼び出しの割り当て費用が 1 ユニットから 2 ユニットに変更されました。
2014 年 8 月 13 日
この改訂での変更内容は次のとおりです。
-
subscriptions.insert
メソッドが次のエラーをサポートするようになりました。エラーのタイプ エラーの詳細 説明 badRequest
subscriptionLimitExceeded
リクエストで特定されたサブスクライバーは、サブスクリプションのレート制限を超えました。数時間後には、追加のサブスクリプションを試行できます。
2014 年 8 月 12 日
この改訂での変更内容は次のとおりです。
-
新しいガイド「アプリケーションを YouTube Data API(v3)に移行する」では、YouTube Data API(v3)を使用して、YouTube Data API(v2)の機能を実行する方法を説明しています。古い API のサポートは 2014 年 3 月 4 日に正式に終了しました。このガイドは、まだ v2 API を使用しているアプリケーションを最新の API バージョンに移行する際に役立つ情報です。
2014 年 7 月 8 日
この改訂での変更内容は次のとおりです。
-
playlists.insert
メソッドが次のエラーをサポートするようになりました。エラーのタイプ エラーの詳細 説明 badRequest
maxPlaylistExceeded
このエラーは、チャンネルの再生リストの数が上限に達しているため、再生リストを作成できない場合に発生します。
2014 年 6 月 18 日
この改訂での変更内容は次のとおりです。
-
各 API メソッドの説明が更新され、そのメソッドの呼び出しで発生する割り当てコストが記載されるようになりました。同様に、API 呼び出しで取得できる各部分の割り当てコストを指定するように、
part
パラメータの定義が更新されました。たとえば、subscriptions.insert
メソッドの呼び出しには、約 50 ユニットの割り当てコストが発生します。subscription
リソースも 3 つの部分(snippet
、contentDetails
、subscriberSnippet
)で構成され、各部分の費用は 2 ユニットです。割り当て費用は、警告なしに変更される可能性があります。
-
video
リソースが 43 の新しいコンテンツのレーティング システムをサポートするようになりました。このシステムは、さまざまな国のレーティング機関から動画が受け取ったレーティングを識別するものです。新たにサポートされるレーティング システムは、アルゼンチン、オーストリア、ベルギー、ブルガリア、チリ(テレビジョン)、チリ(映画)
2014 年 5 月 28 日
この改訂での変更内容は次のとおりです。
-
search.list
メソッドでlocation
パラメータとlocationRadius
パラメータがサポートされ、地理的位置に関連付けられた動画を検索できるようになりました。場所に基づいて結果を取得するには、リクエストで両方のパラメータの値を指定する必要があります。リクエストにどちらか一方しか含まれていない場合、API はエラーを返します。-
location
パラメータは、円形の地理的エリアの中心にある緯度と経度の座標を指定します。 -
locationRadius
パラメータは、動画に関連付けられた場所と、その領域の中心からの距離を指定し、その範囲内で動画を検索結果に表示できるようにします。
-
2014 年 5 月 13 日
この改訂での変更内容は次のとおりです。
-
channel
リソースのinvideoPromotion.items[]
プロパティが更新され、通常、チャンネルに設定できるプロモート アイテムを 1 つしか設定できないことに留意しました。プロモートされたアイテムを挿入しすぎると、API は HTTP400
ステータス コードを含むtooManyPromotedItems
エラーを返します。 -
channelSection
リソースに、いくつかの新しいタイプの注目のコンテンツに関する情報を格納できるようになりました。channelSection
リソースのsnippet.type
プロパティで次の値がサポートされるようになりました。postedPlaylists
- チャンネルの所有者がチャンネルのアクティビティ フィードに投稿した再生リストpostedVideos
- チャンネルの所有者がチャンネルのアクティビティ フィードに投稿した動画subscriptions
- チャンネル所有者が登録しているチャンネル
-
video
リソースの新しいcontentDetails.contentRating.ifcoRating
プロパティは、アイルランド映画分類局からの動画の評価を示します。 -
watermark
リソースのposition.cornerPosition
プロパティの定義を更新し、透かしが常にプレーヤーの右上に表示されることに注意を追加しました。 -
search.list
メソッドのq
パラメータの定義を更新し、検索キーワードでブール演算子 NOT(-
)演算子を使用して特定の検索キーワードに関連する動画を除外できることを記載しました。この値では、ブール演算子 OR(|
)演算子を使用して、複数の検索キーワードのいずれかに関連する動画を検索することもできます。 -
search.list
呼び出しに対する API レスポンスで返されるpageInfo.totalResults
プロパティの定義を更新し、値が近似値であり、正確な値を表していない可能性があることを記載しました。また、最大値は 1,000,000 です。この値を使用してページネーションのリンクを作成しないでください。代わりに、nextPageToken
プロパティ値とprevPageToken
プロパティ値を使用して、ページネーション リンクを表示するかどうかを決定します。 -
watermarks.set
メソッドとwatermarks.unset
メソッドが更新され、これらのメソッドへのリクエストが成功すると API が HTTP204
レスポンス コードを返すことを反映しました。
2014 年 5 月 2 日
この改訂での変更内容は次のとおりです。
-
新しい
i18nLanguage
リソースは、YouTube ウェブサイトがサポートするアプリケーション言語を識別します。アプリケーション言語は UI 言語とも呼ばれます。YouTube ウェブサイトの場合、アプリケーションの言語は Google アカウントの設定、ブラウザの言語、IP の場所に基づいて自動的に選択されます。また、ユーザーが YouTube サイトのフッターから目的の UI 言語を手動で選択することもできます。API では、サポートされているアプリケーション言語を一覧表示するメソッドがサポートされています。サポートされている言語は、
videoCategories.list
やguideCategories.list
などの API メソッドを呼び出すときに、hl
パラメータの値として使用できます。 -
新しい
i18nRegion
リソースは、YouTube ユーザーが優先するコンテンツの地域として選択できる地域を識別します。コンテンツ リージョンは、コンテンツ ロケールとも呼ばれます。YouTube ウェブサイトの場合、コンテンツ リージョンは、YouTube のドメインやユーザーの IP の場所などのヒューリスティックに基づいて自動的に選択されます。また、ユーザーが YouTube サイトのフッターから目的のコンテンツ リージョンを手動で選択することもできます。API では、サポートされているコンテンツ リージョンを一覧表示するメソッドがサポートされています。サポートされている地域コードは、
search.list
、videos.list
、activities.list
、videoCategories.list
などの API メソッドを呼び出すときに、regionCode
パラメータの値として使用できます。
2014 年 4 月 7 日
この改訂での変更内容は次のとおりです。
-
新しい
channelSection
リソースには、チャンネルがおすすめとして選択した一連の動画に関する情報が含まれています。たとえば、チャンネルの最新アップロード、特に人気の高いアップロード、1 つまたは複数の再生リストの動画などをセクションとして表示できます。API では、チャンネル セクションを一覧表示、挿入、更新、削除するメソッドがサポートされています。認証されたユーザーのチャンネルに対応するチャンネル セクションのリストを取得するには、特定のチャンネル ID を指定するか、一意のチャンネル セクション ID のリストを指定します。
エラー ドキュメントも更新され、これらの新しいメソッドに対して API がサポートするエラー メッセージについて説明しています。
-
video
リソースのfileDetails
オブジェクトの定義を更新し、動画のprocessingDetails.fileDetailsAvailability
プロパティの値がavailable
の場合にのみそのオブジェクトが返されることを説明しました。同様に、
video
リソースのsuggestions
オブジェクトの定義が更新され、動画のprocessingDetails.tagSuggestionsAvailability
プロパティまたはそのprocessingDetails.editorSuggestionsAvailability
プロパティの値がavailable
である場合にのみそのオブジェクトが返されることを説明しました。 -
videos.insert
メソッドとvideos.update
メソッドのドキュメントを更新し、これらのメソッドを呼び出すときにstatus.publishAt
プロパティを設定できることを反映しました。 -
オブジェクトを取得できるのはチャンネルの所有者のみであることを説明するために、
channel
リソースのinvideoPromotion
オブジェクトの定義が更新されました。 -
videos.rate
メソッドのパラメータ リストが更新され、そのメソッドが実際にはonBehalfOfContentOwner
パラメータをサポートしていないことを反映しました。このパラメータを設定したvideos.rate
リクエストは500
エラーを返すため、これはドキュメント エラーでした。
2014 年 3 月 31 日
この改訂での変更内容は次のとおりです。
-
video
リソースの新しいstatus.publishAt
プロパティを使用すると、非公開動画の公開をスケジュール設定する日時を指定できます。このプロパティを設定できるのは、動画のプライバシー ステータスがprivate
で、動画が一度も公開されていない場合のみです。この新しいプロパティは非推奨ポリシーの対象ではありません。
2014 年 3 月 13 日
この改訂での変更内容は次のとおりです。
-
API が
channel
リソースのcontentOwnerDetails
部分をサポートするようになりました。新しい部分には、チャンネルにリンクされている YouTube パートナーに関連するチャンネル データ(チャンネルにリンクされているコンテンツ所有者の ID、コンテンツ所有者とチャンネルがリンクされた日時など)が含まれます。なお、この新しいパーツは非推奨ポリシーの対象ではありません。 -
ドキュメントに、次のプロパティでサポートされる最大文字数を記載しました。
リソース プロパティ Maximum length channel
invideoPromotion.items[].customMessage
40 文字 video
snippet.title
100 文字 video
snippet.description
5,000 バイト video
snippet.tags
500 文字。プロパティ値はリストであり、リスト内のアイテム間のカンマは制限にカウントされます。 -
channel
リソースのbrandingSettings.watch.featuredPlaylistId
プロパティは非推奨になりました。この値を設定しようとすると、API からエラーが返されます。 -
エラー ドキュメントで、各エラータイプの HTTP レスポンス コードを指定するようになりました。
-
API で次のエラーがサポートされるようになりました。
エラーのタイプ エラーの詳細 説明 badRequest (400)
invalidCriteria
相互に併用できないフィルタ パラメータがリクエストで指定されている場合、 channels.list
メソッドはこのエラーを返します。badRequest (400)
channelTitleUpdateForbidden
channels.update
メソッドは、チャンネルのbrandingSettings
部分を更新し、brandingSettings.channel.title
プロパティの値を変更しようとすると、このエラーを返します。(プロパティを省略した場合、API からエラーは返されません)。badRequest (400)
invalidRecentlyUploadedBy
invideoPromotion.items[].id.recentlyUploadedBy
プロパティに無効なチャンネル ID が指定されている場合、channels.update
メソッドはこのエラーを返します。badRequest (400)
invalidTimingOffset
invideoPromotion
部分に無効なタイミング オフセットが指定されている場合、channels.update
メソッドはこのエラーを返します。badRequest (400)
tooManyPromotedItems
invideoPromotion
部分で指定されているプロモート アイテムの数が許容数を超えている場合、channels.update
メソッドはこのエラーを返します。forbidden (403)
promotedVideoNotAllowed
invideoPromotion.items[].id.videoId
プロパティで指定されている動画 ID が見つからないか、プロモート アイテムとして使用できない場合、channels.update
メソッドはこのエラーを返します。forbidden (403)
websiteLinkNotAllowed
invideoPromotion.items[].id.websiteUrl
プロパティに許可されていない URL が指定されている場合、channels.update
メソッドはこのエラーを返します。required (400)
requiredTimingType
YouTube でプロモート アイテムを表示するタイミングについて、リクエストでデフォルトのタイミング設定が指定されていない場合、 channels.update
メソッドはこのエラーを返します。required (400)
requiredTiming
channels.update
メソッドでは、プロモート アイテムごとにinvideoPromotion.items[].timing
オブジェクトを指定する必要があります。required (400)
requiredWebsiteUrl
channels.update
メソッドでは、プロモート アイテムごとにinvideoPromotion.items[].id.websiteUrl
プロパティを指定する必要があります。badRequest (400)
invalidPublishAt
videos.insert
メソッドは、リクエスト メタデータに無効な公開予約時刻が指定されている場合、このエラーを返します。
2014 年 3 月 4 日
この改訂での変更内容は次のとおりです。
-
YouTube Data API v3 には、YouTube API 利用規約に記載されているサポート終了ポリシーが適用されます。なお、非推奨ポリシーの対象となる API の一覧では、v3 API の一部の機能がポリシーの対象外であることが明示されています。
2013 年 12 月 5 日
この改訂での変更内容は次のとおりです。
-
search.list
メソッドのドキュメントを更新し、検索リクエストを送信するときにフィルタ パラメータの値を 1 つだけ指定する必要がないことを適切に反映しました。代わりに、ゼロのフィルタ パラメータまたは 1 つのフィルタ パラメータに値を設定できます。 -
次のパラメータにも値を指定する場合は
type
パラメータの値をvideo
に設定する必要があることに注意するよう、search.list
メソッドのパラメータの定義を更新しました。eventType
videoCaption
videoCategoryId
videoDefinition
videoDimension
videoDuration
videoEmbeddable
videoLicense
videoSyndicated
videoType
-
アップロードされるチャンネル バナー画像の最小サイズが 2048 x 1152 ピクセルに縮小されました。(以前の最小サイズは 2120x1192 ピクセルでした)。また、
channel
リソースのドキュメントでは、API から配信されるすべてのバナー画像の最大サイズが指定されています。たとえば、テレビ用アプリのbrandingSettings.image.bannerTvImageUrl
画像の最大サイズは 2,120 x 1,192 ピクセルですが、実際の画像は 2,048 x 1,152 ピクセルになることがあります。YouTube ヘルプセンターでは、各種デバイスで表示するためにチャンネル アートを最適化するための詳しいガイダンスが提供されています。 -
次の情報を反映するように、いくつかの
channel
リソース プロパティの定義が更新されました。brandingSettings.channel.description
プロパティの値の最大長は 1,000 文字です。brandingSettings.channel.featuredChannelsTitle
プロパティの最大長は 30 文字です。brandingSettings.channel.featuredChannelsUrls[]
プロパティに最大 100 個のチャネルをリストできるようになりました。brandingSettings.channel.unsubscribedTrailer
プロパティの値を設定した場合は、チャンネル所有者が所有する公開または限定公開動画の YouTube 動画 ID を指定する必要があります。
-
channels.update
メソッドでinvideoPromotion.items[].promotedByContentOwner
プロパティの更新がサポートされるようになりました。このプロパティは、プロモーションの表示時にコンテンツ所有者の名前が表示されるかどうかを示します。このプロパティを設定できるのは、プロパティ値を設定する API リクエストが、コンテンツ所有者の代わりにonBehalfOfContentOwner
パラメータを使用して行われている場合のみです。 -
playlistItems.list
メソッドとplaylistItems.insert
メソッドがonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。 -
contentDetails.contentRating.acbRating
プロパティでは、映画についてはオーストラリア分類委員会(ACB)、子供向けテレビ番組についてはオーストラリア通信メディア庁(ACMA)のレーティングを指定できるようになりました。 -
新しい
contentDetails.contentRating.catvRating
プロパティとcontentDetails.contentRating.catvfrRating
プロパティは、カナダのテレビ分類システムとフランス語の Régie du cinéma レーティング システム(それぞれケベック州で使用される)に基づいて動画が受けたレーティングを示します。 -
videoCategory
リソースの新しいsnippet.assignable
プロパティは、更新された動画または新しくアップロードされた動画をその動画カテゴリに関連付けることができるかどうかを示します。 -
次のメソッドのコードサンプルが追加されました。
activities.insert
(Go)channelBanners.insert
(Python)channels.update
(Python)playlistItems.list
(Go)search.list
(Go)thumbnails.set
(Java)videos.insert
(Go)
2013 年 10 月 24 日
この改訂での変更内容は次のとおりです。
-
この API には、ライブ配信コンテンツの検索とおすすめに役立つ機能が 2 つ追加されています。
検索結果の新しい
snippet.liveBroadcastContent
プロパティは、動画リソースまたはチャンネル リソースにライブ配信コンテンツが含まれているかどうかを示します。有効なプロパティ値はupcoming
、active
、none
です。-
video
リソースの新しいsnippet.liveBroadcastContent
プロパティは、動画が今後のライブ配信か配信中かを示します。このプロパティに設定可能な値は次のとおりです。upcoming
– 動画はまだ開始されていないライブ配信です。active
– 動画は進行中のライブ配信です。none
– この動画は、近日公開または実施中のライブ配信ではありません。これは、YouTube で引き続き視聴可能な、完了したブロードキャストのプロパティ値になります。
-
video
リソースの新しいliveStreamingDetails
プロパティは、ライブ動画配信に関するメタデータを含むオブジェクトです。このメタデータを取得するには、part
パラメータ値のリソース パーツのリストにliveStreamingDetails
を含めます。メタデータには次の新しいプロパティが含まれます。liveStreamingDetails.actualStartTime
– ブロードキャストが実際に開始された時刻。(この値は、ブロードキャストの状態がactive
になると存在します)。liveStreamingDetails.actualEndTime
– ブロードキャストが実際に終了した時刻。(この値はブロードキャストが終了すると存在します)。liveStreamingDetails.scheduledStartTime
– 配信の開始時間。liveStreamingDetails.scheduledEndTime
– ブロードキャストの終了が予定されている時刻。プロパティの値が空であるか、プロパティが存在しない場合、ブロードキャストは無期限に継続するようにスケジュールされます。liveStreamingDetails.concurrentViewers
– ライブ配信の視聴者数。
このメタデータを取得するには、
videos.list
、videos.insert
、またはvideos.update
メソッドを呼び出すときに、part
パラメータ値にliveStreamingDetails
を含めます。
なお、ライブ配信のコンテンツを識別するための他の 2 つの機能(
search.list
メソッドのeventType
パラメータと検索結果のsnippet.liveBroadcastContent
プロパティ)が 2013 年 10 月 1 日にリリースされました。 -
-
videos.insert
メソッドでnotifySubscribers
パラメータがサポートされるようになりました。このパラメータは、YouTube が動画のチャンネルに登録しているユーザーに新しい動画に関する通知を送信するかどうかを示すものです。このパラメータのデフォルト値はTrue
で、新たに動画がアップロードされるとチャンネル登録者に通知されます。ただし、多数の動画をアップロードしているチャンネル所有者は、値をFalse
に設定して、新しい動画に関する通知がチャンネル登録者に送信されないようにすることもできます。 -
channels.update
メソッドを呼び出すときに変更できるプロパティのリストが更新され、invideoPromotion.items[].customMessage
プロパティとinvideoPromotion.items[].websiteUrl
プロパティが含まれるようになりました。また、このリストは、変更可能なbrandingSettings
プロパティを識別するように変更されました。これらのbrandingSettings
プロパティはすでに変更可能であるため、ドキュメントの変更には API の既存の機能の変更は反映されません。 -
playlists.insert
、playlists.update
、playlists.delete
の各メソッドがonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。 -
playlists.insert
メソッドがonBehalfOfContentOwnerChannel
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。 -
video
リソースのcontentDetails.contentRating.tvpgRating
プロパティで、TV-14
評価に対応するpg14
の値がサポートされるようになりました。 -
検索結果の一部である
snippet.liveBroadcastContent
プロパティの定義を修正しました。live
は有効なプロパティ値ですが、active
は有効なプロパティ値でないことを反映しています。 -
video
リソースのcontentDetails.contentRating.mibacRating
プロパティで、次の 2 つの評価がサポートされるようになりました。mibacVap
(VAP)– 子供は大人の同伴が必要です。mibacVm6
(V.M.6)– 6 歳以上に制限されます。mibacVm12
(V.M.12)– 12 歳以上限定。
-
channel
リソースの新しいinvideoPromotion.items[].promotedByContentOwner
プロパティは、プロモーションの表示時にコンテンツ所有者の名前が表示されるかどうかを示します。このフィールドを設定できるのは、値を設定する API リクエストがコンテンツ所有者の代わりに行われている場合のみです。詳細については、onBehalfOfContentOwner
パラメータをご覧ください。
2013 年 10 月 1 日
この改訂での変更内容は次のとおりです。
-
channel
リソースの新しいauditDetails
オブジェクトには、マルチチャンネル ネットワーク(MCN)が特定のチャンネルを承認するかどうかを判断する際に評価するチャンネル データが含まれます。このリソース部分を取得する API リクエストでは、https://www.googleapis.com/auth/youtubepartner-channel-audit
スコープを含む認証トークンを指定する必要があります。また、そのスコープを使用するトークンは、MCN がチャンネルの承認または拒否を決定したとき、またはトークンの発行日から 2 週間以内に取り消す必要があります。 -
channel
リソースのinvideoPromotion.items[].id.type
プロパティで、プロモート アイテムが指定されたチャンネルから最近アップロードされた動画であることを示す値recentUpload
がサポートされるようになりました。デフォルトでは、チャンネルは動画内プロモーション データが設定されているチャンネルと同じになります。ただし、新しい
invideoPromotion.items[].id.recentlyUploadedBy
プロパティの値をそのチャンネルのチャンネル ID に設定することで、別のチャンネルから最近アップロードされた動画をプロモートできます。 -
channel
リソースには、テレビアプリのチャンネル ページに表示されるバナー画像の URL を指定する、brandingSettings.image.bannerTvLowImageUrl
、brandingSettings.image.bannerTvMediumImageUrl
、brandingSettings.image.bannerTvHighImageUrl
の 3 つの新しいプロパティが含まれています。 -
検索結果の新しい
snippet.liveBroadcastContent
プロパティは、動画リソースまたはチャンネル リソースにライブ配信コンテンツが含まれているかどうかを示します。有効なプロパティ値はupcoming
、active
、none
です。video
リソースについて、値upcoming
は動画がまだ開始されていないライブ配信であることを示し、値active
は動画が進行中のライブ配信であることを示します。channel
リソースについて、値upcoming
はチャンネルにまだ開始されていないスケジュール設定されたブロードキャストがあることを示し、値acive
はチャンネルに進行中のライブ配信があることを示します。
-
watermark
リソースのtargetChannelId
プロパティがオブジェクトから文字列に変更されました。透かし画像がリンクしているチャンネルの YouTube チャンネル ID を指定する子プロパティを含める代わりに、targetChannelId
プロパティにその値自体を指定するようになりました。これに伴い、リソースのtargetChannelId.value
プロパティが削除されました。 -
thumbnails.set
メソッドがonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、他のいくつかのメソッドですでにサポートされています。 -
search.list
メソッドがeventType
パラメータをサポートするようになりました。これにより、アクティブなブロードキャスト イベント、今後のブロードキャスト イベント、または完了したブロードキャスト イベントのみを返すように検索を制限できます。 -
新しい
contentDetails.contentRating.mibacRating
プロパティは、イタリアの Ministero dei Beni e delle Attivita Culturali e del Turismo から動画に対する評価を示します。 -
API で次のエラーがサポートされるようになりました。
エラーのタイプ エラーの詳細 説明 badRequest
invalidImage
指定された画像コンテンツが無効な場合、 thumbnails.set
メソッドはこのエラーを返します。forbidden
videoRatingDisabled
評価対象の動画の所有者がその動画の評価を無効にしている場合、 videos.rate
メソッドはこのエラーを返します。
2013 年 8 月 27 日
この改訂での変更内容は次のとおりです。
-
新しい
watermark
リソースは、指定したチャンネルの動画の再生中に表示される画像を識別します。画像のリンク先ターゲット チャンネルや、動画の再生中に透かしを表示するタイミングとその長さを指定することもできます。watermarks.set
メソッドは、チャンネルの透かし画像をアップロードして設定します。watermarks.unset
メソッドは、チャンネルの透かし画像を削除します。エラー ドキュメントでは、特に
watermarks.set
メソッドとwatermarks.unset
メソッドに対して API がサポートするエラー メッセージについて説明しています。 -
channel
リソースの新しいstatistics.hiddenSubscriberCount
プロパティには、チャンネルのチャンネル登録者数が非表示かどうかを示すブール値が含まれます。そのため、チャンネル登録者数が一般公開されている場合、プロパティの値はfalse
です。 -
playlists.list
メソッドがonBehalfOfContentOwner
パラメータとonBehalfOfContentOwnerChannel
パラメータをサポートするようになりました。どちらのパラメータも、他のいくつかのメソッドですでにサポートされています。 -
videos.list
メソッドで、グラフを取得するコンテンツ領域を指定するregionCode
パラメータがサポートされるようになりました。このパラメータは、chart
パラメータと組み合わせるとのみ使用できます。このパラメータの値は ISO 3166-1 alpha-2 の国コードです。 -
error documentation
では、複数の API メソッドで発生する可能性のある、次の新しい一般的なリクエスト エラーについて説明します。エラーのタイプ エラーの詳細 説明 forbidden
insufficientPermissions
リクエストに指定された OAuth 2.0 トークンに関連付けられているスコープでは、リクエストされたデータにアクセスできません。
2013 年 8 月 15 日
この改訂での変更内容は次のとおりです。
-
channel
リソースのinvideoPromotion
オブジェクトには、次の新しいプロパティと更新されたプロパティがあります。-
API で、ウェブサイトをプロモート アイテムとして指定できるようになりました。これを行うには、
invideoPromotion.items[].id.type
プロパティの値をwebsite
に設定し、新しいinvideoPromotion.items[].id.websiteUrl
プロパティを使用して URL を指定します。また、新しいinvideoPromotion.items[].customMessage
プロパティを使用して、プロモーションに表示するカスタム メッセージを定義します。関連するウェブサイト、販売者サイト、ソーシャル ネットワーク サイトなどへのリンクを使用できます。コンテンツのリンクを有効にする方法について詳しくは、YouTube ヘルプセンターの関連ウェブサイトと販売者サイトの手順をご覧ください。
プロモーション リンクを追加すると、それらのリンクを使用して不正なサイトにトラフィックをリダイレクトしないこと、およびそれらのリンクが YouTube の AdWords ポリシー、YouTube 広告ポリシー、YouTube コミュニティ ガイドライン、YouTube 利用規約に準拠することに同意するものとします。
-
動画の再生中にプロモーション アイテムを表示するタイミング設定に関連するプロパティが再構成されました。
-
invideoPromotion.timing
オブジェクトがinvideoPromotion.items[].timing
に移動しました。このオブジェクトを使用して、invideoPromotion.items[]
リスト内のプロモート アイテムごとに時間データをカスタマイズできるようになりました。 -
新しい
invideoPromotion.defaultTiming
オブジェクトでは、プロモーションのデフォルトのタイミング設定を指定します。この設定では、チャンネルの動画のいずれかの再生中にプロモート アイテムを表示するタイミングを定義します。invideoPromotion.items[].timing
オブジェクトを使用して、特定のプロモート アイテムのデフォルトのタイミングをオーバーライドできます。 -
新しい
invideoPromotion.items[].timing.durationMs
プロパティでは、プロモーションを表示する時間をミリ秒単位で指定します。invideoPromotion.defaultTiming
オブジェクトには、プロモート アイテムを表示するデフォルトの時間を指定するdurationMs
フィールドも含まれています。
-
-
invideoPromotion.items[].type
プロパティとinvideoPromotion.items[].videoId
プロパティはどちらもinvideoPromotion.items[].id
オブジェクトに移動しました。
-
-
subscriptions.list
メソッドがonBehalfOfContentOwner
パラメータとonBehalfOfContentOwnerChannel
パラメータをサポートするようになりました。どちらのパラメータも、他のいくつかのメソッドですでにサポートされています。 -
thumbnails.set
リクエストに対する API レスポンスで、kind
プロパティの値がyoutube#thumbnailListResponse
からyoutube#thumbnailSetResponse
に変更されました。 -
次のメソッドのコードサンプルが追加されました。
channels.update
(Java、Python)playlists.insert
(.NET、PHP)subscriptions.insert
(PHP、Python)thumbnails.set
(PHP、Python)videos.insert
(PHP)videos.list
(PHP)videos.rate
(Python)videos.update
(Java、PHP、Python)
playlistItems.insert
メソッドの Python の例も、説明した機能がvideos.rate
メソッドで処理できるようになったため削除されています。 -
error documentation
では、次の新しいリクエスト コンテキスト エラーについて説明します。このエラーは、mine
リクエスト パラメータをサポートするすべての API メソッドで発生する可能性があります。エラーのタイプ エラーの詳細 説明 badRequest
invalidMine
認証されたユーザーが YouTube パートナーであるリクエストでは、 mine
パラメータを使用できません。mine
パラメータを削除するか、onBehalfOfContentOwner
パラメータを削除して YouTube ユーザーとして認証するか、呼び出されたメソッドで利用可能な場合はonBehalfOfContentOwnerChannel
パラメータを指定して、パートナーのチャンネルの 1 つとして動作する必要があります。
2013 年 8 月 8 日
この改訂での変更内容は次のとおりです。
-
動画のアップロード クォータ コストが約 16,000 ユニットから約 1,600 ユニットに変更されることを反映して、「YouTube Data API スタートガイド」ガイドの割り当て使用量セクションが更新されました。
2013 年 7 月 30 日
この改訂での変更内容は次のとおりです。
-
channelBanner
リソースで、kind
プロパティの値がyoutube#channelBannerInsertResponse
からyoutube#channelBannerResource
に変更されました。このリソースは、channelBanners.insert
リクエストに応答して返されます。 -
channel
リソースの新しいbrandingSettings.channel.profileColor
プロパティは、チャンネルのコンテンツを目立たせる目立つ色を指定します。プロパティ値は、ポンド記号(#
)とそれに続く 6 文字の 16 進数文字列です(例:#2793e6
)。 -
この API では、チャンネル登録がチャンネルのすべてのアクティビティに適用されるか、新しいアップロードのみに対するものかを指定できるようになりました。
subscription
リソースの新しいcontentDetails.activityType
プロパティは、チャンネル登録者に通知されるアクティビティのタイプを指定します。有効なプロパティ値はall
とuploads
です。 -
videos.list
メソッドは、YouTube で特に人気の高い動画のチャートを取得するための新しいパラメータをサポートしています。chart
パラメータは、取得するグラフを指定します。現在サポートされている値はmostPopular
のみです。なお、chart
パラメータはフィルタ パラメータです。つまり、他のフィルタ パラメータ(id
やmyRating
)と同じリクエストで使用することはできません。videoCategoryId
パラメータは、グラフを取得する動画のカテゴリを指定します。このパラメータは、chart
パラメータと組み合わせるとのみ使用できます。デフォルトでは、グラフは特定のカテゴリに限定されていません。
-
video
リソースの新しいtopicDetails.relevantTopicIds[]
プロパティは、動画またはそのコンテンツに関連する Freebase トピック ID のリストを提供します。これらのトピックのテーマが動画内で言及されたり、登場したりすることがあります。 -
video
リソースのrecordingDetails.location.elevation
プロパティの名前がrecordingDetails.location.altitude
に変更され、fileDetails.recordingLocation.location.elevation
プロパティの名前がfileDetails.recordingLocation.location.altitude
に変更されました。 -
video
リソースのcontentDetails.contentRating
オブジェクトは、MPAA レーティング、TVPG レーティングなど、さまざまなレーティング スキームで動画が受けたレーティングを指定します。API では、各レーティング システムについて、動画がレーティングされていないことを示すレーティング値がサポートされるようになりました。なお、MPAA レーティングでは、カット版が公式レーティングを受けた映画のノーカット版を識別するために「レーティングなし」と表示されることがよくあります。 -
video
リソースの新しいcontentDetails.contentRating.ytRating
プロパティは、年齢制限のあるコンテンツを識別します。動画に 18 歳未満のユーザーにとって不適切なコンテンツが含まれていると YouTube が判断した場合、このプロパティの値はytAgeRestricted
になります。プロパティが存在しない場合、またはプロパティ値が空の場合、コンテンツは年齢制限として識別されていません。 -
channels.list
メソッドのmySubscribers
パラメータは非推奨になりました。subscriptions.list
メソッドとそのmySubscribers
パラメータを使用して、認証されたユーザーのチャンネル登録者のリストを取得します。 -
channelBanners.insert
、channels.update
、videos.getRating
、videos.rate
メソッドがすべてonBehalfOfContentOwner
パラメータをサポートするようになりました。このパラメータは、認証済みのユーザーがパラメータ値で指定されたコンテンツ所有者の代理を務めていることを示します。 -
channels.update
メソッドのドキュメントを更新し、このメソッドを使用してchannel
リソースのbrandingSettings
オブジェクトとその子プロパティを更新できるという事実を反映しました。ドキュメントには、channel
リソースのinvideoPromotion
オブジェクトに設定できるプロパティの最新リストも記載されています。 -
error documentation
では、次の新しいエラーについて説明しています。エラーのタイプ エラーの詳細 説明 forbidden
accountDelegationForbidden
このエラーは、特定の API メソッドに固有のものではありません。認証されたユーザーに、指定した Google アカウントに代わって操作する権限がないことを示します。 forbidden
authenticatedUserAccountClosed
このエラーは、特定の API メソッドに固有のものではありません。認証されたユーザーの YouTube アカウントが閉鎖されていることを示します。ユーザーが別の Google アカウントに代わって操作している場合、このエラーは他のアカウントが閉鎖されたことを示します。 forbidden
authenticatedUserAccountSuspended
このエラーは、特定の API メソッドに固有のものではありません。これは、認証済みユーザーの YouTube アカウントが停止されていることを示しています。ユーザーが別の Google アカウントに代わって操作している場合、このエラーは他のアカウントが停止されたことを示しています。 forbidden
authenticatedUserNotChannel
このエラーは、特定の API メソッドに固有のものではありません。これは、API サーバーが API リクエストに関連付けられているチャネルを識別できないことを示します。リクエストが承認され、 onBehalfOfContentOwner
パラメータを使用している場合は、onBehalfOfContentOwnerChannel
パラメータも設定する必要があります。forbidden
cmsUserAccountNotFound
このエラーは、特定の API メソッドに固有のものではありません。その CMS ユーザーは、指定されたコンテンツの所有者に代わって操作を実行することを許可されていません。 notFound
contentOwnerAccountNotFound
このエラーは、特定の API メソッドに固有のものではありません。指定されたコンテンツの所有者アカウントが見つかりませんでした。 badRequest
invalidPart
このエラーは、特定の API メソッドに固有のものではありません。リクエストの part
パラメータに、同時に書き込めない部分が指定されています。badRequest
videoChartNotFound
videos.list
メソッドは、サポートされていない動画グラフまたは利用できない動画グラフがリクエストで指定されている場合、このエラーを返します。notFound
videoNotFound
videos.update
メソッドはこのエラーを返し、更新しようとしている動画が見つからないことを示します。リクエスト本文のid
プロパティの値が正しいことを確認してください。
2013 年 6 月 10 日
この改訂での変更内容は次のとおりです。
-
channels.list
メソッドの新しいforUsername
パラメータを使用すると、YouTube ユーザー名を指定してチャンネルに関する情報を取得できます。 -
activities.list
メソッドでregionCode
パラメータがサポートされるようになりました。このパラメータは、指定した国に関連する結果を返すように API に指示します。承認されたユーザーがこれまでに YouTube で行ったアクティビティでは、アクティビティ フィードを生成するのに不十分な場合、YouTube はこの値を使用します。 -
再生リスト リソースに
snippet.tags
プロパティが追加されました。このプロパティが返されるのは、自身の再生リストに関するデータを取得する、承認されたユーザーのみです。承認されたユーザーは、playlists.insert
またはplaylists.update
メソッドを呼び出すときに再生リストタグを設定することもできます。 -
これまで
channels.list
メソッドとsearch.list
メソッドでサポートされていたonBehalfOfContentOwner
パラメータが、videos.insert
、videos.update
、videos.delete
メソッドでもサポートされるようになりました。このパラメータをvideos.insert
メソッドの呼び出しで使用する場合は、新しいonBehalfOfContentOwnerChannel
パラメータの値も指定する必要があります。この値により、動画が追加されるチャンネルが決まります。チャンネルは、onBehalfOfContentOwner
パラメータで指定されたコンテンツ所有者にリンクする必要があります。このパラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
このパラメータは、さまざまな YouTube チャンネルを所有および管理しているコンテンツ パートナーを対象としています。このパラメータを使用すると、パートナーは一度認証するだけで、動画とチャンネルのすべてのデータにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。
特にこのリリースでは、このパラメータにより、コンテンツ パートナーは、パートナーが所有する YouTube チャンネルで動画を挿入、更新、削除できるようになりました。
-
error documentation
では、次の新しいエラーについて説明しています。エラーのタイプ エラーの詳細 説明 forbidden
insufficientCapabilities
このエラーは、特定の API メソッドに固有のものではありません。これは、API を呼び出している CMS ユーザーに、リクエストされた操作を実行するための十分な権限がないことを示します。このエラーは、 onBehalfOfContentOwner
パラメータの使用に関連しています。このパラメータは、いくつかの API メソッドでサポートされています。unauthorized
authorizationRequired
activities.list
メソッドは、リクエストでhome
パラメータを使用しているものの、適切に認証されていない場合に、このエラーを返します。 -
channels
リソースでは、リソースのid
プロパティを使用してチャンネル ID をすでに指定しているため、invideoPromotion.channelId
プロパティが削除されました。 -
新しいチャンネル ID の取り扱いガイドでは、API でチャンネル ID を使用する方法について説明しています。このガイドは、以前のバージョンの API から移行し、
default
ユーザーのコンテンツをリクエストするアプリケーションや、すべての YouTube チャンネルが一意のユーザー名を持つという考えに依存しているアプリケーションを使用しているデベロッパーにとって特に有用です。
2013 年 5 月 22 日
この改訂での変更内容は次のとおりです。
-
新しい
channelBanners.insert
メソッドを使用すると、バナー画像をアップロードできます。バナー画像は、channel
リソースの新しいbrandingSettings.image.bannerExternalUrl
プロパティを使用して、後でチャンネルのバナー画像として設定することができます。 -
channels.update
メソッドのドキュメントが更新され、メソッドを呼び出すときに変更できるプロパティがリストされるようになりました。 -
video
リソースのドキュメントでは、suggestions.processingErrors[]
、suggestions.processingHints[]
、suggestions.processingWarnings[]
、suggestions.editorSuggestions[]
の各プロパティの有効なプロパティ値としてunspecified
が記載されなくなりました。 -
videos.list
メソッドのmaxResults
パラメータのデフォルト値が5
になりました。 -
error documentation
で、channelBanners.insert
メソッドとsubscriptions.list
メソッドのエラーがリストされるようになりました。また、channels.update
メソッドに関する新しいエラーもいくつか示しています。
2013 年 5 月 14 日
この改訂での変更内容は次のとおりです。
-
Python コードサンプルが掲載されているページに、チャンネル登録の追加、再生リストの作成、動画の更新の例を追加しました。
2013 年 5 月 10 日
この改訂での変更内容は次のとおりです。
-
YouTube では、試験的な API の機能とサービスを識別しなくなりました。代わりに、サポート終了予定ポリシーの対象となる YouTube API のリストを提供しています。
2013 年 5 月 8 日
この改訂での変更内容は次のとおりです。
-
チャンネル リソースが
inVideoPromotion
オブジェクトをサポートするようになりました。このオブジェクトは、チャンネルに関連付けられたプロモーション キャンペーンに関する情報をカプセル化します。チャンネルでは、InVideo プロモーション キャンペーンを使用して、チャンネルの動画が再生されている間、動画プレーヤー内にプロモーション動画のサムネイル画像を表示できます。このデータを取得するには、
channels.list
リクエストのpart
パラメータ値にinvideoPromotion
を含めます。 -
新しい
channels.update
メソッドを使用すると、チャンネルの動画内プロモーション キャンペーン データを更新できます。このメソッドは、channel
リソースのinvideoPromotion
部分の更新のみをサポートし、そのリソースの他の部分の更新はまだサポートしていないことに注意してください。
2013 年 5 月 2 日
この改訂での変更内容は次のとおりです。
-
チャンネル リソースが
status.isLinked
プロパティをサポートするようになりました。このプロパティは、YouTube ユーザー名または Google+ アカウントにすでにリンクされているユーザーをチャンネル データで識別するかどうかを示します。このいずれかのリンクを持つユーザーは公開されている YouTube ID を既に持っているユーザーであり、動画のアップロードなど、いくつかの操作の前提条件となります。 -
サブスクリプション リソースが
subscriberSnippet
の部分をサポートするようになりました。このオブジェクトは、チャンネル登録者のチャンネルのスニペット データを格納します。 -
API で
videos.getRating
メソッドがサポートされるようになりました。このメソッドは、認証されたユーザーが 1 つ以上の動画のリストに対して与えた評価を取得します。 -
videos.list
メソッドの新しいmyRating
パラメータを使用すると、認証済みユーザーがlike
またはdislike
と評価した動画のリストを取得できます。myRating
パラメータとid
パラメータはどちらもフィルタ パラメータと見なされるようになりました。つまり、API リクエストでどちらか一方のパラメータのみを指定する必要があります。(以前は、id
パラメータはこのメソッドの必須パラメータでした)。このメソッドは、リクエストが動画の評価情報を取得しようとしたものの、その取得権限を持っていない場合に
forbidden
エラーを返します。 -
myRating
パラメータの導入により、ページ分割をサポートするようにvideos.list
メソッドも更新されました。ただし、ページング パラメータは、myRating
パラメータを使用するリクエストでのみサポートされます。(ページング パラメータと情報は、id
パラメータを使用するリクエストではサポートされていません)。-
maxResults
パラメータには、API が結果セットで返すことができる動画の最大数を指定します。pageToken
パラメータは、取得する結果セット内の特定のページを指定します。 -
videos.list
リクエストへのレスポンスで返されるyoutube#videoListResponse
リソースに、現在の結果セットに含まれる結果の合計数や結果の数などの詳細を含むpageInfo
オブジェクトが追加されました。youtube#videoListResponse
リソースには、nextPageToken
プロパティとprevPageToken
プロパティを含めることもできます。各プロパティは、結果セット内の特定のページを取得するために使用できるトークンを提供します。
-
-
videos.insert
メソッドは、次の新しいパラメータをサポートしています。autoLevels
– 動画の明るさと色を自動的に補正するよう YouTube に指示するには、このパラメータ値をtrue
に設定します。stabilize
– このパラメータ値をtrue
に設定すると、YouTube はカメラの動きに起因するブレを取り除き、動画を調整します。
-
次のリソースの
snippet
にchannelTitle
プロパティが追加されました。playlistItem
– このプロパティは、再生リスト アイテムを追加したチャンネルの名前を指定します。playlist
– 再生リストを作成したチャンネルの名前を指定します。subscription
- このプロパティは、登録先のチャンネルの名前を指定します。
-
次のメソッドのコードサンプルが追加されました。
activities.insert
(Ruby)playlistItems.list
(.NET)search.list
(.NET)subscriptions.insert
(Java、Ruby)videos.insert
(.NET、Ruby)
-
subscriptions.list
メソッドの新しいmySubscribers
パラメータを使用すると、現在認証されているユーザーのサブスクライバーのリストを取得できます。このパラメータは、適切に承認されたリクエストでのみ使用できます。注: この機能は、
channels.list
メソッドで現在サポートされているmySubscribers
パラメータに代わるものです。このパラメータのサポートは終了します。 -
video
リソースのプロパティ値unspecified
は、次のどのプロパティにも使用できなくなりました。 -
予期しないパラメータを含む API リクエストは
badRequest
エラーを返すようになりました。エラーの報告理由はunexpectedParameter
です。 -
許可された項目数が再生リストにすでに上限に達している場合に、
playlistItems.insert
メソッドから返されるエラーです。エラーはforbidden
エラーとして報告され、エラーの理由はplaylistContainsMaximumNumberOfVideos
になりました。
2013 年 4 月 19 日
この改訂での変更内容は次のとおりです。
-
新しい
videos.rate
メソッドを使用すると、ユーザーは動画にlike
またはdislike
の評価を設定したり、動画から評価を削除したりできます。また、エラー ドキュメントも更新され、
videos.rate
メソッド呼び出しに対して API から返されるエラーが列挙されています。 -
サムネイル画像は、API ドキュメントでは個別のリソースとして識別されるようになりました。新しい
thumbnails.set
メソッドを使用すると、カスタム動画サムネイルを YouTube にアップロードして、動画に設定できます。また、エラー ドキュメントも更新され、
thumbnails.set
メソッド呼び出しに対して API から返されるエラーが列挙されています。なお、この変更はサムネイル画像を返す既存のリソースには影響しません。サムネイル画像は以前と同様にこれらのリソースで返されますが、ドキュメントには、API が返す可能性のあるさまざまなサムネイル サイズの名前がリストされるようになりました。
-
channel
リソースの新しいbrandingSettings
部分は、チャンネルのチャンネル ページと動画再生ページの設定、テキスト、画像を識別します。 -
playlistItem
リソースには次の新しいプロパティが含まれています。-
新しい
status
オブジェクトは再生リスト アイテムに関するステータス情報をカプセル化し、status.privacyStatus
プロパティは再生リスト アイテムのプライバシー ステータスを識別します。
-
-
video
リソースには次の新しいプロパティが含まれています。-
status.publicStatsViewable
プロパティは、動画再生ページの拡張動画統計情報が一般公開されているかどうかを示します。デフォルトでは、これらの統計情報は閲覧可能です。また、このプロパティの値がfalse
に設定されていても、動画の再生回数や評価などの統計情報は引き続き一般公開されます。このプロパティの値は、videos.insert
メソッドまたはvideos.update
メソッドを呼び出すときに設定できます。 -
contentDetails.contentRating
オブジェクトは、さまざまな評価スキームで動画が受けた評価をカプセル化します。以下のリストは、サポートされているレーティング システムの一覧と、各レーティング システムに関連付けられている宿泊施設へのリンクを示しています。プロパティ定義では、各システムでサポートされている評価値を指定します。
-
-
playlistItems.update
メソッドのドキュメントを更新し、リクエスト本文として送信されるリソースでsnippet.resourceId
プロパティを指定する必要があることを反映しました。 -
search.list
メソッドが次の機能をサポートするようになりました。-
新しい
forMine
パラメータは、検索対象を認証されたユーザーの動画のみに制限します。 -
order
パラメータで、タイトル(order=title
)または動画数の降順(order=videoCount
)で、結果をアルファベット順に並べ替える機能をサポートするようになりました。 -
新しい
safeSearch
パラメータは、制限されたコンテンツを検索結果に含めるかどうかを示すものです。
-
-
videos.insert
メソッドは、次の表に示す新しいエラーを複数サポートしています。エラーのタイプ エラーの詳細 説明 badRequest
invalidCategoryId
snippet.categoryId
プロパティに無効なカテゴリ ID が指定されています。videoCategories.list
メソッドを使用して、サポートされているカテゴリを取得します。badRequest
invalidRecordingDetails
metadata specifies invalid recording details.
badRequest
invalidVideoGameRating
リクエスト メタデータで指定されたビデオ ゲームの評価は無効です。 badRequest
invalidVideoMetadata
リクエスト メタデータが無効です。 -
onBehalfOfContentOwner
パラメータは、videos.update
メソッドとvideos.delete
メソッドでサポートされているパラメータのリストから削除されました。
2013 年 3 月 12 日
この改訂での変更内容は次のとおりです。
-
次のリソースの
snippet
にchannelTitle
プロパティが追加されました。 -
search.list
メソッドは、次の新しいパラメータをサポートしています。-
channelType
パラメータを使用すると、チャンネルの検索を制限して、すべてのチャンネルまたは番組のみを取得できます。 -
videoType
パラメータを使用すると、動画の検索を限定して、すべての動画、または映画のみ、または番組のエピソードのみを取得できます。
-
-
video
リソースのrecordingDetails
部分の定義を更新し、動画の位置情報データまたは録画時間が設定されている場合にのみ、動画に対してオブジェクトが返されるようにしました。 -
playlistItems.update
メソッドはinvalidSnippet
エラーを返すようになりました。これは、API リクエストに有効なスニペットが指定されていない場合に返されます。 -
いくつかの API メソッドで、YouTube コンテンツ パートナー専用の新しいパラメータがサポートされています。YouTube のコンテンツ パートナーには、YouTube でコンテンツを公開している映画やテレビのスタジオ、レコード レーベル、その他のコンテンツ クリエイターが含まれます。
-
onBehalfOfContentOwner
パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。このパラメータは、さまざまな YouTube チャンネルを所有および管理しているコンテンツ パートナーを対象としています。このパラメータを使用すると、パートナーは一度認証するだけで、動画とチャンネルのすべてのデータにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。
channels.list
、search.list
、videos.delete
、videos.list
、videos.update
のメソッドはすべて、このパラメータをサポートしています。 -
managedByMe
パラメータはchannels.list
メソッドでサポートされています。このパラメータは、onBehalfOfContentOwner
パラメータで指定されたコンテンツ所有者が所有するすべてのチャンネルを返すように API に指示します。 -
forContentOwner
パラメータはsearch.list
メソッドでサポートされており、onBehalfOfContentOwner
パラメータで指定されたコンテンツ所有者が所有するリソースのみが含まれるように検索結果を制限するよう API に指示します。
-
2013 年 2 月 25 日
この改訂での変更内容は次のとおりです。
-
API は、
video
リソースの新しいパーツとプロパティをいくつかサポートしています。-
fileDetails
、processingDetails
、suggestions
の新しいパートは、アップロードした動画に関する情報を動画所有者に提供します。このデータは、動画のアップロードを可能にするアプリケーションで非常に有用で、次のようなものが含まれます。- 処理ステータスと進行状況を
- 動画の処理中に発生したエラーやその他の問題
- サムネイル画像の可用性
- 動画やメタデータの品質を向上させるためのヒント
- YouTube にアップロードされた元のファイルの詳細
これらの部分はすべて、動画の所有者のみが取得できます。以下のリストでは、新しいパートについて簡単に説明しています。
video
リソース ドキュメントでは、各パートに含まれるすべてのプロパティを定義しています。-
fileDetails
オブジェクトには、YouTube にアップロードされた動画ファイルに関する情報(ファイルの解像度、再生時間、オーディオ コーデックと動画コーデック、ストリーミング ビットレートなど)が格納されます。 -
processingProgress
オブジェクトには、アップロードされた動画ファイルの処理における YouTube の進行状況に関する情報が含まれます。オブジェクトのプロパティは、現在の処理ステータスを識別し、YouTube で動画の処理が完了するまでの残り時間を推定します。また、この部分は、ファイルの詳細やサムネイル画像など、さまざまなタイプのデータやコンテンツを動画で利用できるかどうかも示しています。このオブジェクトは、動画をアップロードしたユーザーが、アップロードされた動画ファイルの処理状況を追跡できるようにポーリングするように設計されています。
-
suggestions
オブジェクトには、アップロードした動画の画質やメタデータを改善する機会を特定する提案が含まれます。
-
contentDetails
部分には、4 つの新しいプロパティが含まれています。これらのプロパティは、認証されていないリクエストを使用して取得できます。dimension
– 動画が 2D と 3D のどちらであるかを示します。definition
– 動画が標準画質と高解像度のどちらで視聴できるかを示します。caption
– 動画で字幕を使用できるかどうかを示します。licensedContent
– YouTube コンテンツ パートナーから申し立てを受けたコンテンツが動画に含まれているかどうかを示します。
-
status
の部分には、2 つの新しいプロパティが含まれています。動画の所有者は、動画の挿入時または更新時に両方のプロパティの値を設定できます。これらのプロパティは、認証されていないリクエストを使用して取得することもできます。embeddable
– 動画を他のウェブサイトに埋め込めるかどうかを示します。license
– 動画のライセンスを指定します。有効な値はcreativeCommon
とyoutube
です。
-
-
videos.list
、videos.insert
、videos.update
メソッドのpart
パラメータの定義が更新され、上記で新しく追加された部分と、誤って省略されていたrecordingDetails
部分がリストされるようになりました。 -
channel
リソースの新しいcontentDetails.googlePlusUserId
プロパティには、チャンネルに関連付けられている Google+ プロフィール ID を指定します。この値を使用して、Google+ プロフィールへのリンクを生成できます。 -
各サムネイル画像オブジェクトで画像の幅と高さを指定するようになりました。現在、サムネイル画像は
activity
、channel
、playlist
、playlistItem
、search result
、subscription
、video
リソースで返されます。 -
playlistItems.list
がvideoId
パラメータをサポートするようになりました。このパラメータをplaylistId
パラメータと組み合わせて使用すると、指定した動画を表す再生リスト アイテムのみを取得できます。パラメータによって識別される動画が再生リスト内に見つからない場合、API は
notFound
エラーを返します。 -
エラー ドキュメントで新しい
forbidden
エラーについて説明しています。これは、リクエストされたアクションに対してリクエストが適切に承認されていないことを示します。 -
channel
リソースのsnippet.channelId
プロパティが削除されました。リソースのid
プロパティも同じ値を示します。
2013 年 1 月 30 日
この改訂での変更内容は次のとおりです。
-
新しいエラーページには、API が返す可能性があるエラーが一覧表示されます。このページには、複数の異なる API メソッドで発生する可能性のある一般的なエラーと、メソッド固有のエラーが含まれています。
2013 年 1 月 16 日
この改訂での変更内容は次のとおりです。
-
現在、以下のリストのメソッドと言語のコードサンプルを利用できます。
activities.insert
- JavaplaylistItems.insert
- PythonplaylistItems.list
– Java、JavaScript、PHP、Python、Rubyplaylists.insert
- Java、JavaScript、Pythonsearch.list
– Java、JavaScript、Python、Rubyvideos.insert
- Java
-
activity
リソースで、channelItem
アクションを報告できるようになりました。これは、YouTube が自動生成された YouTube チャンネルに動画を追加したときに発生するものです。(YouTube では、アルゴリズムによって YouTube ウェブサイト上で注目度の高いトピックが特定され、それらのトピックのチャンネルが自動的に生成されます)。 -
次の
search.list
パラメータが更新されました。q
パラメータがフィルタとして指定されなくなったため、次のようになります。relatedToVideo
パラメータの名前がrelatedToVideoId
に変更されました。published
パラメータが、publishedAfter
とpublishedBefore
の 2 つの新しいパラメータに置き換えられました。これらのパラメータについて、以下に説明します。
-
search.list
メソッドは、次の新しいパラメータをサポートしています。パラメータ名 値 説明 channelId
string
指定したチャネルによって作成されたリソースを返します。 publishedAfter
datetime
指定した時間以降に作成されたリソースを返します。 publishedBefore
datetime
指定した時間より前に作成されたリソースを返します。 regionCode
string
指定した国のリソースを返します。 videoCategoryId
string
指定した動画カテゴリに関連付けられている動画のみが含まれるように、動画の検索結果をフィルタリングします。 videoEmbeddable
string
動画の検索結果をフィルタして、ウェブページ上の埋め込みプレーヤーで再生できる動画のみを表示できます。埋め込み可能な動画のみを取得するには、パラメータ値を true
に設定します。videoSyndicated
string
動画の検索結果をフィルタして、YouTube.com の外部で再生できる動画のみが表示されるようにします。シンジケーション動画のみを取得するには、パラメータ値を true
に設定します。 -
新しいプロパティをサポートする API リソースがいくつかあります。次の表に、リソースと新しいプロパティを示します。
リソース プロパティ名 値 説明 activity
contentDetails.playlistItem.playlistItemId
string
再生リスト内のアイテムを一意に識別するために YouTube が割り当てた再生リスト アイテム ID。 activity
contentDetails.channelItem
object
チャンネルに追加されたリソースに関する情報を含むオブジェクト。このプロパティは、 snippet.type
がchannelItem
の場合にのみ存在します。activity
contentDetails.channelItem.resourceId
object
チャンネルに追加されたリソースを識別するオブジェクト。他の resourceId
プロパティと同様に、動画や再生リストなどのリソースタイプを指定するkind
プロパティが含まれます。また、いくつかのプロパティ(videoId
、playlistId
など)のうち、そのリソースを一意に識別する ID を指定するプロパティも 1 つだけ含まれています。channel
status
object
このオブジェクトは、チャンネルのプライバシー ステータスに関する情報をカプセル化します。 channel
status.privacyStatus
string
チャンネルのプライバシー ステータス。有効な値は private
とpublic
です。playlist
contentDetails
object
このオブジェクトには、再生リストのコンテンツに関するメタデータが含まれます。 playlist
contentDetails.itemCount
unsigned integer
再生リスト内の動画数。 playlist
player
object
このオブジェクトには、埋め込みプレーヤーで再生リストを再生する際に使用する情報が含まれています。 playlist
player.embedHtml
string
再生リストを再生する動画プレーヤーを埋め込む <iframe>
タグ。video
recordingDetails
object
このオブジェクトは、動画が記録された場所や時刻を特定または説明する情報をカプセル化します。 video
recordingDetails.location
object
このオブジェクトには、動画に関連付けられた位置情報の情報が含まれます。 video
recordingDetails.location.latitude
double
緯度。 video
recordingDetails.location.longitude
double
経度。 video
recordingDetails.location.elevation
double
地上の高度(メートル単位)。 video
recordingDetails.locationDescription
string
動画が撮影された場所のテキストによる説明。 video
recordingDetails.recordingDate
datetime
動画が録画された日付と時刻。値は ISO 8601( YYYY-MM-DDThh:mm:ss.sZ
)形式で指定します。 -
いくつかの API メソッドのドキュメントで、リクエストの本文で指定する必要があるプロパティや、リクエスト本文の値に基づいて更新されるプロパティが明記されるようになりました。次の表に、これらのメソッドと必須または変更可能なプロパティを示します。
注: 他のメソッドのドキュメントには、必須のプロパティと変更可能なプロパティがすでにリストされている場合があります。
メソッド プロパティ activities.insert
必須プロパティ: snippet.description
snippet.description
contentDetails.bulletin.resourceId
playlists.update
必須プロパティ: id
playlistItems.update
必須プロパティ: id
videos.update
必須プロパティ: id
-
同じチャンネルにすでに存在する再生リストと同じタイトルの再生リストを作成または更新しようとしても、API が
playlistAlreadyExists
エラーを報告しなくなりました。 -
新しいエラータイプをサポートする API メソッドがいくつかあります。メソッドと新たにサポートされるエラーを次の表に示します。
メソッド エラーのタイプ エラーの詳細 説明 guideCategories.list
notFound
notFound
id
パラメータによって識別されるガイド カテゴリが見つかりません。guideCategories.list メソッドを使用して、有効な値のリストを取得します。playlistItems.delete
forbidden
playlistItemsNotAccessible
リクエストは適切に認証されていないため、指定された再生リスト アイテムを削除できません。 videoCategories.list
notFound
videoCategoryNotFound
id
パラメータで特定される動画カテゴリが見つかりません。videoCategories.list メソッドを使用して、有効な値のリストを取得します。