概要
このガイドでは、アプリケーションに YouTube プレーヤーを埋め込む方法と、YouTube 埋め込みプレーヤーで使用できるパラメータの定義を紹介します。
IFrame URL にパラメータを追加すると、アプリケーション内での再生方法をカスタマイズできます。たとえば autoplay
パラメータによる動画の自動再生や、loop
パラメータによる動画の繰り返し再生が可能です。enablejsapi
パラメータを使用して、プレーヤーを IFrame Player API によって制御することもできます。
このページには、任意の YouTube 埋め込みプレーヤーでサポートされるすべてのパラメータが定義されています。パラメータをサポートするプレーヤーについては、各パラメータ定義に記述してあります。
注: 埋め込みプレーヤーには少なくとも 200×200 px のビューポートが必要です。プレーヤーにコントロール バーを表示させる場合は、ビューポートの最小サイズを下回らずにコントロール バーを表示できるよう、十分な大きさを確保する必要があります。少なくとも幅 480 ピクセル、高さ 270 ピクセルの、アスペクト比 16:9 のプレーヤーをおすすめします。
YouTube プレーヤーの埋め込み
次のいずれの方法を使用しても、アプリケーションに YouTube プレーヤーを埋め込み、プレーヤーのパラメータを指定できます。下の手順で埋め込むプレーヤーでは、単一の動画を読み込みます。それに続くセクションでは、再生リストや検索結果など、他の種類のコンテンツをプレーヤーに読み込ませる設定方法を説明します。
<iframe>
タグを使用してプレーヤーを埋め込む
アプリケーションに <iframe>
タグを定義します。このタグの中では、プレーヤーに読み込むコンテンツを src
URL に指定した上で、必要な他のプレーヤー パラメータも追加します。<iframe>
タグの height
パラメータと width
パラメータで、プレーヤーのサイズを指定します。
<iframe>
の要素を自分で作成する(IFrame Player API を使用しない)場合は、URL の末尾に直接、プレーヤーのパラメータを追加できます。URL の形式は次のとおりです。
https://www.youtube.com/embed/VIDEO_ID
下の <iframe>
タグでは、YouTube 動画 M7lc1UVf-VE
を再生する 640x360 ピクセルのプレーヤーが読み込まれます。URL の autoplay
パラメータが 1
に設定されているため、プレーヤーが読み込まれると、動画は自動的に再生されます。
<iframe id="ytplayer" type="text/html" width="640" height="360" src="https://www.youtube.com/embed/M7lc1UVf-VE?autoplay=1&origin=http://example.com" frameborder="0"></iframe>
IFrame Player API を使用してプレーヤーを埋め込む
Player API の JavaScript コードが読み込まれた後、IFrame Player API の手順に沿って動画プレーヤーをウェブページまたはアプリケーションに挿入します。動画プレーヤーのコンストラクタの 2 番目のパラメータは、プレーヤー オプションを指定するオブジェクトです。プレーヤー パラメータは、このオブジェクト内で playerVars
プロパティによって識別されます。
下の HTML コードと JavaScript コードは、ytplayer
という id
値を持つページ要素に YouTube プレーヤーを挿入する簡単な例です。ここに指定されている onYouTubePlayerAPIReady()
関数は、IFrame Player API コードが読み込まれたときに自動的に呼び出されます。このコードでは、プレーヤー パラメータを何も定義せず、他のイベント ハンドラも定義していません。
<div id="ytplayer"></div> <script> // Load the IFrame Player API code asynchronously. var tag = document.createElement('script'); tag.src = "https://www.youtube.com/player_api"; var firstScriptTag = document.getElementsByTagName('script')[0]; firstScriptTag.parentNode.insertBefore(tag, firstScriptTag); // Replace the 'ytplayer' element with an <iframe> and // YouTube player after the API code downloads. var player; function onYouTubePlayerAPIReady() { player = new YT.Player('ytplayer', { height: '360', width: '640', videoId: 'M7lc1UVf-VE' }); } </script>
再生するコンテンツの選択
埋め込みプレーヤーの設定次第で、動画、再生リスト、ユーザーのアップロード動画、または特定のクエリに対する検索結果が読み込まれるようにすることができます。
以下のリストで、これらのオプションについて説明します。
-
動画の読み込み
IFrame を埋め込むには、読み込む動画の YouTube 動画 ID を、IFrame の
src
URL 内で指定します。https://www.youtube.com/embed/VIDEO_ID
YouTube Data API(v3)を使用している場合、検索結果、再生リスト アイテム リソース、動画リソースなどを動画 ID に指定することで、再生するコンテンツをリソースに応じて自動的に取得できます。動画 ID を取得した後、上のプレーヤー URL で末尾部の
VIDEO_ID
を動画 ID に置き換えます。 -
再生リストの読み込み
listType
プレーヤー パラメータをplaylist
に設定します。また、list
プレーヤー パラメータを、読み込む YouTube 再生リスト ID に設定します。https://www.youtube.com/embed?listType=playlist&list=PLAYLIST_ID
再生リスト ID の前には、次の例に示すように、文字
PL
を付ける必要があります。https://www.youtube.com/embed?listType=playlist&list=PLC77007E23FF423C6
YouTube Data API(v3)を使用している場合、検索結果、チャンネル リソース、またはアクティビティ リソースを再生リスト ID に指定することで、再生するコンテンツをリソースに応じて自動的に取得できます。再生リスト ID を取得した後、上のプレーヤー URL で末尾部の
PLAYLIST_ID
を再生リスト ID に置き換えます。 -
ユーザーのアップロード動画の読み込み
listType
プレーヤー パラメータをuser_uploads
に設定します。また、list
プレーヤー パラメータを、読み込むアップロード動画の所有者の YouTube ユーザー名に設定します。https://www.youtube.com/embed?listType=user_uploads&list=USERNAME
-
特定のクエリの検索結果の読み込み
listType
プレーヤー パラメータをsearch
に設定します。次に、list
プレーヤー パラメータに検索キーワードを指定すると、その検索結果がプレーヤーに読み込まれます。https://www.youtube.com/embed?listType=search&list=QUERY
サポートされるパラメータ
次のパラメータはすべて省略可能です。
パラメータ | |
---|---|
|
プレーヤーを読み込んだときに最初の動画を自動再生するかどうかを指定します。サポートされる値は 0 または 1 です。デフォルト値は 0 です。
|
|
プレーヤーに表示する字幕のデフォルトの言語を指定します。パラメータの値は、ISO 639-1 2 文字言語コードに設定します。 このパラメータを使用したうえで cc_load_policy パラメータを 1 に設定した場合、プレーヤーが読み込まれたときに指定した言語の字幕が表示されます。cc_load_policy パラメータを設定していない場合、字幕がデフォルトで表示されなくなります。ただし、ユーザーが字幕を表示する設定にした場合はその指定した言語で表示されます。
|
|
このパラメータの値を 1 に設定すると、ユーザーが字幕をオフにしていても、字幕がデフォルトで表示されます。デフォルトの動作はユーザー設定に基づきます。
|
|
プレーヤーの動画進行状況バーで使用される色を指定します。これは、動画の視聴した部分を示す色として使用されます。有効なパラメータ値は red と white です。デフォルトでは、動画進行状況バーで赤が使用されます。color オプションの詳細については YouTube API ブログをご覧ください。注: color パラメータを white に設定すると、modestbranding オプションが無効になります。
|
|
動画プレーヤーのコントロールを表示するかどうかを指定します。
|
|
このパラメータの値を 1 に設定すると、プレーヤーはキーボード操作に応答しなくなります。デフォルト値は 0 (キーボード操作が有効)です。現在サポートされているキーボード操作は、次のとおりです。
|
|
このパラメータの値を 1 に設定すると、IFrame または JavaScript Player API を呼び出してプレーヤーを制御できます。デフォルト値は 0 (これらの API を使用してプレーヤーを制御できない)です。IFrame API とその使用方法について詳しくは、IFrame API のドキュメントをご覧ください(JavaScript Player API のサポートは終了しています)。 |
|
動画を特定の位置で停止させる場合に、再生を開始してからの時間(秒数)でその位置を指定します。パラメータ値は正の整数です。 時間は動画の先頭から測定されます。 start プレーヤー パラメータや startSeconds パラメータの値からではありません。これらは、動画の読み込みまたはキューイングを行うために YouTube Player API 関数で使用されるパラメータです。
|
|
このパラメータを 0 に設定すると、全画面表示ボタンはプレーヤーに表示されなくなります。デフォルト値は 1 であり、全画面表示ボタンが表示されます。
|
|
プレーヤーのインターフェースの言語を設定します。パラメータの値は、ISO 639-1 規格の 2 文字言語コードまたは完全指定のロケールです。たとえば、fr や fr-ca は有効な値です。IETF 言語タグ(BCP 47)などの他の言語入力コードも正しく処理されます。インターフェースの言語はプレーヤーのツールチップで使用され、デフォルトの字幕トラックにも影響します。なお、ユーザー個別の言語設定と利用可能な字幕トラックに基づいて、YouTube が特定のユーザーに対し異なる字幕トラックを選択することもあります。 |
|
このパラメータの値を 1 に設定すると、動画アノテーションがデフォルトで表示されます。3 に設定すると、動画アノテーションはデフォルトで表示されなくなります。デフォルト値は 1 です。
|
|
list パラメータは、プレーヤーに読み込むコンテンツを識別するときに、listType パラメータと組み合わせて使用します。
list パラメータと listType パラメータに値を指定する場合は、IFrame 埋め込み URL に動画 ID を指定する必要がありません。 |
|
listType パラメータは、プレーヤーに読み込むコンテンツを識別するときに、list パラメータと組み合わせて使用します。有効なパラメータ値は、playlist 、search および user_uploads です。list パラメータと listType パラメータに値を指定する場合は、IFrame 埋め込み URL に動画 ID を指定する必要がありません。 |
|
単一動画プレーヤーの場合に 1 を設定すると、最初の動画が繰り返し再生されます。再生リスト プレーヤーまたはカスタム プレーヤーの場合、再生リスト全体を再生した後、最初の動画からもう一度再生が始まります。サポートされている値は 0 と 1 で、デフォルト値は 0 です。注: このパラメータは AS3 プレーヤーと埋め込み IFrame でのみサポートされており、AS3 または HTML5 プレーヤーのいずれかが読み込まれます。 loop パラメータは、現時点では playlist pパラメータと組み合わせて AS3 プレーヤーで使用した場合のみ動作します。単一の動画をループさせる場合は、loop パラメータの値を 1 に設定し、すでに Player API URL に指定してある動画 ID と同じ値を playlist パラメータの値に設定します。https://www.youtube.com/v/VIDEO_ID? |
|
このパラメータを使用すると、YouTube プレーヤーに YouTube ロゴが表示されないようにすることができます。パラメータの値を 1 に設定すると、YouTube ロゴがコントロール バーに表示されなくなります。ただし、動画を一時停止したときにユーザーがプレーヤーにカーソルを合わせると、動画の右上に引き続き小さい YouTube テキストラベルが表示されます。
|
|
このパラメータは IFrame API のセキュリティを強化します。埋め込み IFrame でのみ使用できます。IFrame API を使用している場合、つまり enablejsapi パラメータの値を 1 に設定している場合は、常に自分のドメインを origin パラメータ値として指定する必要があります。
|
|
このパラメータには、再生する動画 ID をカンマ区切りのリスト形式で指定します。値を指定すると、URL パスの VIDEO_ID に指定した動画が最初に再生され、playlist パラメータに指定した動画はその後に再生されます。
|
|
このパラメータは iOS 上の HTML5 プレーヤーで動画をインラインまたは全画面表示のどちらで再生するかを制御します。有効な値は次のとおりです。
|
|
注: このパラメータは 2018 年 9 月 25 日以降に変更されます。 変更前は、最初の動画の再生が終了したときに、プレーヤーに関連動画を表示するかどうかを指定します。
rel パラメータを 0 に設定すると、再生した動画と同じチャンネルから関連動画が選択されます。
|
|
注: このパラメータはサポートを終了しており、2018 年 9 月 25 日以降はご利用いただけません。 サポートされている値は 0 と 1 です。このパラメータの値を 0 に設定すると、動画の再生が始まる前に動画のタイトルやアップロードしたユーザーなどの情報は表示されません。プレーヤーに再生リストを読み込む場合に、このパラメータの値を明示的に 1 に設定すると、再生リストに含まれる動画のサムネイル画像も読み込み時に表示されます。
|
|
このパラメータを指定すると、動画の先頭から指定された秒数分進めた位置から動画の再生が開始されます。パラメータ値は正の整数です。seekTo 関数と同様に、プレーヤーは指定された時間に最も近いキーフレームを探します。そのため、リクエストされた時間の直前から再生が開始される場合もありますが、ずれは通常、最大で 2 秒程度です。
|
|
プレーヤーが埋め込まれている URL を識別します。この値は、YouTube プレーヤーがウィジェットに埋め込まれ、このウィジェットがウェブページやアプリケーションに埋め込まれた場合に、YouTube アナリティクスのレポートで使用されます。このシナリオでは、origin パラメータはウィジェット プロバイダのドメインを識別しますが、YouTube アナリティクスが実際のトラフィック ソースとしてウィジェット プロバイダを識別することはありません。代わりに、YouTube アナリティクスは widget_referrer パラメータ値を使用して、トラフィック ソースに関連するドメインを識別します。
|
変更履歴
August 23, 2018
Note: This is a deprecation announcement for the showinfo
parameter. In addition, the behavior for the rel
parameter is changing. Titles, channel information, and related videos are an important part of YouTube’s core user experience, and these changes help to make the YouTube viewing experience consistent across different platforms.
- The behavior for the
rel
parameter is changing on or after September 25, 2018. The effect of the change is that you will not be able to disable related videos. However, you will have the option of specifying that the related videos shown in the player should be from the same channel as the video that was just played.
To be more specific:- Prior to the change, if the parameter's value is set to
0
, then the player does not show related videos. - After the change, if the
rel
parameter is set to0
, the player will show related videos that are from the same channel as the video that was just played.
- Prior to the change, if the parameter's value is set to
- The
showinfo
parameter, which indicates whether the player should display information like the video title and uploader before the video starts playing, is also being deprecated. Following the change, the channel avatar and video title will always display before playback begins, when playback is paused, and when playback ends. The avatar being displayed is new behavior that will be consistent across all embedded players.
These changes will become effective on or after September 25, 2018. After that time, the showinfo
parameter will be ignored. The behavior following the changes is consistent with the current default behavior for embedded players with the exception of the channel avatar changes mentioned above.
August 16, 2018
The cc_lang_pref
parameter can be used to specify the default language that the player will use to display captions. This parameter can be used in conjunction with the cc_load_policy
parameter to automatically show captions in the specified language during playback.
September 15, 2017
The controls
parameter's definition has been updated to remove references to the deprecated Flash (AS3) player. The value 2
has been deprecated as it was originally designed to provide a performance improvement for embeds that loaded a Flash player.
June 12, 2017
The new widget_referrer
parameter helps to enable more accurate YouTube Analytics reporting when the YouTube player is embedded in a widget, and that widget is then embedded in a web page or application.
November 1, 2016
This document has been updated to remove references to the deprecated Flash (AS3) player as well as to parameters only supported by that player. The YouTube Flash player was deprecated in January 2015.
October 20, 2016
This update contains the following changes:
-
The
disablekb
parameter definition has been corrected to note that the default value is0
, which means that keyboard controls are enabled. A value of1
indicates that keyboard controls should be disabled.The list of keyboard controls that the player supports has also been updated to include the following:
- [f]: Toggle full-screen display
- [j]: Jump back 10 seconds in the current video
- [k]: Play / Pause
- [l]: Jump ahead 10 seconds in the current video
- [m]: Mute or unmute the video
- [0-9]: Jump to a point in the video.
0
jumps to the beginning of the video,1
jumps to the time 10% into the video,2
jumps to the point 20% into the video, and so forth.
In addition, the effect of pressing the [arrow left] or [arrow right] keys has changed. These keys now jump 5 seconds back (arrow left) or ahead (arrow right) in the current video.
August 11, 2016
This update contains the following changes:
-
The newly published YouTube API Services Terms of Service ("the Updated Terms"), discussed in detail on the YouTube Engineering and Developers Blog, provides a rich set of updates to the current Terms of Service. In addition to the Updated Terms, which will go into effect as of February 10, 2017, this update includes several supporting documents to help explain the policies that developers must follow.
The full set of new documents is described in the revision history for the Updated Terms. In addition, future changes to the Updated Terms or to those supporting documents will also be explained in that revision history. You can subscribe to an RSS feed listing changes in that revision history from a link in that document.
December 18, 2015
European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy. We have added a notice of this requirement in our YouTube API Terms of Service.
August 19, 2015
-
The
autohide
parameter has been deprecated for the HTML5 player. In HTML5 players, the video progress bar and player controls display or hide automatically. That behavior corresponds to anautohide
setting of1
. -
The
theme
parameter has been deprecated for the HTML5 player. HTML5 players now always use the dark theme.
March 9, 2015
-
The document has been updated to reflect the fact that YouTube
<object>
embeds, the YouTube Flash Player API and the YouTube JavaScript Player API have all been deprecated as of January 27, 2015. A deprecation warning appears in several sections of this document to help point readers to the IFrame Player API as an alternative. -
The definition of the
autohide
parameter has been updated to clarify the meaning of the parameter's values. The default behavior (autohide=2
) is that if the player has a 16:9 or 4:3 aspect ratio, the player's video progress bar and player controls display or hide automatically. Otherwise, those controls are visible throughout the video. -
The definition of the
hl
parameter has been updated to note that the parameter value could be an ISO 639-1 two-letter language code or a fully specified locale. For example,fr
andfr-ca
are both valid parameter values. -
The definition of the
enablejsapi
parameter has been reworded to clarify that the parameter enables a player to be controlled via API calls. The API could be either the IFrame Player API or the JavaScript Player API.
October 14, 2014
-
The HTML5 player now supports the
cc_load_policy
,disablekb
,end
,fs
,list
, andlistType
parameters. The parameter descriptions have been updated accordingly.
July 18, 2014
-
The new
hl
parameter can be used to set the player's interface language. The interface language is used for tooltips in the player and also affects the default caption track. The selected caption track may also depend on the availability of caption tracks and user's individual language preferences.The parameter's value is an ISO 639-1 two-letter language code, though other language input codes, such as IETF language tags (BCP 47) may also be handled properly.
-
The definition of the
playsinline
parameter, which only affects HTML5 players on iOS, has been modified slightly. The definition now notes that setting the parameter value to1
causes inline playback only forUIWebViews
created with theallowsInlineMediaPlayback
property set toTRUE
.
January 28, 2014
-
The
playsinline
parameter controls whether videos play inline or fullscreen in an HTML5 player on iOS. Setting the value to1
causes inline playback. -
The Selecting content to play section has been updated to explain how to find YouTube video IDs and playlist IDs using the YouTube Data API (v3) rather than the older API version.
-
The
controls
parameter's definition has been updated to reflect the fact that the parameter value only affects the time that the Flash player actually loads in IFrame embeds. In addition, for IFrame embeds, the parameter value also determines when the controls display in the player. If you set the parameter's value to2
, then the controls display and the Flash player loads after the user initiates the video playback.
May 10, 2013
This update contains the following changes:
-
YouTube no longer identifies experimental API features and services. Instead, we now provide a list of YouTube APIs that are subject to the deprecation policy.
July 20, 2012
This update contains the following changes:
-
The definition of the
controls
parameter has been updated to reflect support for a parameter value of2
and to explain that, for AS3 players, the parameter value determines the time when the Flash player actually loads. If thecontrols
parameter is set to0
or1
, the Flash player loads immediately. If the parameter value is2
, the Flash player does not load until the video playback is initiated.
June 5, 2012
This update contains the following changes:
-
The HTML5 player now supports the
color
,modestbranding
, andrel
parameters, and the definitions for these parameters have been updated accordingly. -
The definition of the
showinfo
parameter has been updated to explain how that if the player is loading a playlist, and you explicitly set the parameter value to1
, then, upon loading, the player will also display thumbnail images for the videos in the playlist. Note that this functionality is only supported for the AS3 player since that is the only player that can load a playlist.
May 4, 2012
This update contains the following changes:
-
The
showinfo
parameter's definition has been updated to reflect the fact that the HTML5 player supports this parameter.
May 3, 2012
This update contains the following changes:
-
The new
end
parameter specifies the time, measured in seconds from the start of the video, when the player should stop playing a video. Note that the time when playback is stopped is measured from the beginning of the video and not from the value of either thestart
player parameter or thestartSeconds
parameter, which is used in YouTube Player API functions for loading or queueing a video.
March 29, 2012
This update contains the following changes:
-
The new Embedding a YouTube player section explains different ways to embed a YouTube player in your application. This section covers manual IFrame embeds, IFrame embeds that use the IFrame Player API, and AS3 and AS2 object embeds. This section incorporates information from the old Example usage section, which has been removed.
-
The new Selecting content to play section explains how to configure the player to load a video, a playlist, search results for a specified query, or uploaded videos for a specified user.
-
The new
list
andlistType
parameters let you specify the content that the player should load. You can specify a playlist, a search query, or a particular user's uploaded videos. -
The definitions of the
fs
andrel
parameters have been updated to more clearly explain the default parameter values for the AS3 player. -
The
border
,color1
,egm
,hd
, andshowsearch
parameters, which are all only supported for the deprecated AS2 Player API, have been moved to a new section named deprecated parameters only used in the AS2 Player API. -
The document no longer provides a way to filter the parameter list to only display parameters supported in either the AS3, AS2, or HTML5 player. Instead, each parameter definition has been updated to identify the players that support that parameter.
August 11, 2011
This update contains the following changes:
-
The new
theme
andcolor
parameters let you customize the appearance of the embedded player's player controls. See the YouTube API blog for more information.
June 8, 2011
This update contains the following changes:
-
The new
modestbranding
parameter lets you use a YouTube player that does not show a YouTube logo. As of this release, the parameter was only supported for the AS3 embedded player and for IFrame embeds that loaded the AS3 player. As of June 5, 2012, the HTML5 player also supported this parameter.
February 14, 2011
This update contains the following changes:
-
The documentation has been updated to note that the AS2 Player API has been deprecated. The deprecation of the AS2 Player API was actually announced on October 14, 2009.
February 3, 2011
This update contains the following changes:
-
The documentation has been updated to identify parameters supported in the HTML5 (IFrame) embedded player.
-
The document now displays all of the parameters supported in any of YouTube's embedded players (HTML5, AS3, AS2).
-
The following parameters are supported in the AS2 player but have been deprecated for the newer AS3 and HTML5 players:
border
,color1
,color2
,egm
,hd
, andshowsearch
.In addition, the
loop
parameter has limited support in the AS3 player and in IFrame embeds, which could load either an AS3 or HTML player. Currently, theloop
parameter only works in the AS3 player when used in conjunction with theplaylist
parameter. To loop a single video, set theloop
parameter to1
and set theplaylist
parameter value to the same video ID already specified in the Player API URL:https://www.youtube.com/v/VIDEO_ID?version=3&loop=1&playlist=VIDEO_ID
Similarly, the
controls
andplaylist
parameters are supported in the AS3 and HTML5 players but are not and will not be supported in the AS2 player.As noted above, IFrame embeds can load either an AS3 or HTML5 player. Though some parameters are not supported in both players, an IFrame embed that loads the AS3 player will support all parameters that work with that player and ignore all other parameters. Similarly, an IFrame embed that loads the HTML5 player will support all parameters that work with that player while ignoring all other parameters.
-
The parameter list has been updated to include the
autohide
parameter, which indicates whether the player's video controls will automatically hide after a video begins playing. -
The parameter list has been updated to include the
controls
parameter, which indicates whether the player's video controls will display at all. (Player controls do display by default.) -
The parameter list has been updated to include the
playlist
parameter, which specifies a comma-separated list of video IDs to play. -
The definition of the
fs
has been updated to note that the fullscreen option will not work if you load the YouTube player into another SWF. -
The example at the end of the document has been updated to use the embedded AS3 player instead of the embedded AS2 player. The parameters used in the example have also been updated to only include parameters that the AS3 player supports.
In addition, the instructions for constructing the URLs that contain player parameters have been updated to reflect the URL formats used by the AS3 and AS2 embedded and chromeless players as well as by the HTML5 player.