カスタム検索入力フィールドと以下に示すパラメータを使用して、完全にカスタムな検索クエリを作成できます。
カスタム検索のフォーマット
追加する各パラメータは、アンパサンド"&"で始まり、パラメータのキー(例:"order")、等号"="、受け入れられる値(例:"date")の順に記述します。プラグインが最終的な検索クエリを適切にエンコードするので、URLエンコーディングは追加しないでください。
例
&q=Funny Cat Videos&order=viewCount
&channelId=UClwg08ECyHnm_RzY1wnZC1A&publishedAfter=2019-06-30T00:00:00Z&publishedBefore=2020-01-30T00:00:00Z
&q=Gooseberry Falls&videoDuration=short
| パラメーター・キー | 許容値 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedToVideoId |
stringについて relatedToVideoId パラメータは、パラメータ値で指定した動画に関連する動画のリストを取得します。パラメータ値には、YouTube の動画 ID を設定する必要があります。注: relatedToVideoIdパラメータが設定されている場合、他にサポートされているパラメータは以下のとおりです。 regionCode, relevanceLanguage, safeSearchそして fields. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channelId |
stringについて channelId パラメータは、APIレスポンスがチャネルによって作成されたリソースのみを含むべきであることを示します。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
eventType |
stringについて eventType パラメータは、検索対象をブロードキャスト・イベントに限定する。許容される値は以下の通り:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location |
stringについて location パラメーターは locationRadius パラメータは、円形の地理的領域を定義し、その領域内にある地理的位置をメタデータで指定した動画に検索を制限します。パラメータ値は、緯度経度座標を指定する文字列である。37.).
リクエストで |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locationRadius |
stringについて locationRadius パラメーターは location パラメータ値は浮動小数点数で、その後に測定単位が続く必要があります。有効な測定単位は m, km, ftそして mi.例えば、有効なパラメータ値には次のようなものがあります。 1500m, 5km, 10000ftそして 0..APIは以下をサポートしていません。 locationRadius パラメータの値が1000kmより大きい。注: の定義を参照のこと。 location パラメータを使用する。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order |
stringについて order パラメータは、API レスポンスのリソースの順序付けに使用するメソッドを指定します。デフォルト値は relevance使用可能な値は以下の通り:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publishedAfter |
datetimeについて publishedAfter パラメータは、APIレスポンスが指定された時刻以降に作成されたリソースのみを含むべきであることを示します。値はRFC 3339形式の日付-時刻値(1970-01-01T00:00:00Z)です。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publishedBefore |
datetimeについて publishedBefore パラメータは、APIレスポンスが指定された時刻以前または時刻に作成されたリソースのみを含むべきであることを示します。値はRFC 3339形式の日付-時刻値(1970-01-01T00:00:00Z)です。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q |
stringについて q パラメータは、検索するクエリー用語を指定します。リクエストには、ブール演算子 NOT (-)とOR(|)演算子で動画を除外したり、複数の検索語のいずれかに関連する動画を検索したりすることができます。たとえば、"boating" または "sailing" のどちらかに一致する動画を検索するには q パラメータ値を boating|.同様に、"fishing" ではなく、"boating" または "sailing" のどちらかにマッチするビデオを検索するには、次のように設定します。 q パラメータ値を boating|. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
regionCode |
stringについて regionCode パラメータは、指定した国で視聴可能な動画の検索結果を返すよう API に指示します。パラメータ値は ISO 3166-1 alpha-2 国番号 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relevanceLanguage |
stringについて relevanceLanguage パラメータは、指定された言語に最も関連する検索結果を返すようにAPIに指示します。パラメータ値は通常 ISO 639-1 2文字の言語コード.ただし zh-Hans 簡体字中国語と zh-Hant 繁体字中国語他の言語の検索結果も、検索キーワードとの関連性が高ければ表示されます。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
safeSearch |
stringについて safeSearch パラメータは、検索結果に標準的なコンテンツだけでなく、制限されたコンテンツを含めるかどうかを示します:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
topicId |
stringについて topicId パラメータは、API レスポンスが指定されたトピックに関連するリソースのみを含むべきであることを示します。値は Freebase のトピック ID を表します。重要だ: FreebaseとFreebase APIが廃止されたため topicId パラメータは、2017年2月27日から異なる動作をするようになりました。その時点で、YouTubeはキュレーションされたトピックIDの小さなセットをサポートし始め、あなたはこのパラメータの値としてその小さなIDセットのみを使用することができます。2017年2月15日現在サポートされているトピックIDを見る
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoCaption |
stringについて videoCaption パラメータは、API が動画検索結果をキャプションの有無に基づいてフィルタリングするかどうかを指定する:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoCategoryId |
stringについて videoCategoryId パラメータは、動画の検索結果をその検索結果に基づいてフィルタリングします。 カテゴリー. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoDefinition |
stringについて videoDefinition パラメータを使用すると、高解像度(HD)または標準解像度(SD)のビデオのみを含むように検索を制限することができます。HDビデオは少なくとも720pで再生可能ですが、1080pのような高解像度も可能な場合があります:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoDimension |
stringについて videoDimension パラメータを使用すると、2Dまたは3Dビデオのみを検索するように検索を制限することができます:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoDuration |
stringについて videoDuration パラメータは、ビデオの検索結果を継続時間に基づいてフィルタリングします:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoEmbeddable |
stringについて videoEmbeddable パラメータを使用すると、ウェブページに埋め込むことができるビデオのみに検索を制限することができます:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoLicense |
stringについて videoLicense パラメータは、検索結果に特定のライセンスの動画のみを含めるようにフィルタリングします。YouTube では、動画アップロード者が動画にクリエイティブ・コモンズ・ライセンスまたは標準 YouTube ライセンスのいずれかを選択できます:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoSyndicated |
stringについて videoSyndicated パラメータを使用すると、youtube.com以外で再生可能なビデオのみに検索を制限することができます:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoType |
stringについて videoType パラメータを使用すると、特定のタイプのビデオに検索を制限することができます:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||