カスタム検索作成ガイド

カスタム検索入力フィールドと以下に示すパラメータを使用して、完全にカスタムな検索クエリを作成できます。

カスタム検索のフォーマット
追加する各パラメータは、アンパサンド"&"で始まり、パラメータのキー(例:"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 パラメータは、検索対象をブロードキャスト・イベントに限定する。
許容される値は以下の通り:

  • completed - 完了した放送のみを含む。
  • live - アクティブな放送のみを含める。
  • upcoming - 今後放送されるもののみ。
location string
について location パラメーターは locationRadius パラメータは、円形の地理的領域を定義し、その領域内にある地理的位置をメタデータで指定した動画に検索を制限します。パラメータ値は、緯度経度座標を指定する文字列である。37.42307,-122.08427).

  • について location パラメータ値は、領域の中心点を特定する。
  • について locationRadius パラメータは、動画が検索結果に含まれるために、動画に関連付けられた場所がその地点から最大距離を指定します。

リクエストで location パラメータの値も指定しない。 locationRadius パラメータが必要だ。

locationRadius string
について locationRadius パラメーターは location パラメータ値は浮動小数点数で、その後に測定単位が続く必要があります。有効な測定単位は m, km, ftそして mi.例えば、有効なパラメータ値には次のようなものがあります。 1500m, 5km, 10000ftそして 0.75mi.APIは以下をサポートしていません。 locationRadius パラメータの値が1000kmより大きい。注: の定義を参照のこと。 location パラメータを使用する。
order string
について order パラメータは、API レスポンスのリソースの順序付けに使用するメソッドを指定します。デフォルト値は relevance使用可能な値は以下の通り:

  • date - リソースは、作成された日付に基づいて逆年代順にソートされます。
  • rating - リソースは、評価の高いものから低いものへとソートされている。
  • relevance - リソースは、検索クエリとの関連性に基づいてソートされます。これがこのパラメータのデフォルト値です。
  • title - リソースはタイトル順にアルファベット順に並んでいます。
  • viewCount - リソースは、再生回数の多いものから少ないものへとソートされます。ライブ放送の場合、ビデオは放送中の同時視聴者数でソートされます。
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|sailing.同様に、"fishing" ではなく、"boating" または "sailing" のどちらかにマッチするビデオを検索するには、次のように設定します。 q パラメータ値を boating|sailing -fishing.
regionCode string
について regionCode パラメータは、指定した国で視聴可能な動画の検索結果を返すよう API に指示します。パラメータ値は ISO 3166-1 alpha-2 国番号
relevanceLanguage string
について relevanceLanguage パラメータは、指定された言語に最も関連する検索結果を返すようにAPIに指示します。パラメータ値は通常 ISO 639-1 2文字の言語コード.ただし zh-Hans 簡体字中国語と zh-Hant 繁体字中国語他の言語の検索結果も、検索キーワードとの関連性が高ければ表示されます。
safeSearch string
について safeSearch パラメータは、検索結果に標準的なコンテンツだけでなく、制限されたコンテンツを含めるかどうかを示します:

  • moderate - YouTubeは検索結果からいくつかのコンテンツをフィルタリングし、少なくとも、あなたのロケールで制限されているコンテンツをフィルタリングする。そのコンテンツに基づいて、検索結果が検索結果から削除されたり、検索結果で降格されたりする可能性があります。これはデフォルトのパラメータ値です。
  • none - YouTubeは検索結果をフィルタリングしない。
  • strict - YouTubeは、検索結果セットからすべての制限されたコンテンツを除外しようとします。そのコンテンツに基づいて、検索結果が検索結果から削除されたり、検索結果で降格されたりする可能性がある。
topicId string
について topicId パラメータは、API レスポンスが指定されたトピックに関連するリソースのみを含むべきであることを示します。値は Freebase のトピック ID を表します。重要だ: FreebaseとFreebase APIが廃止されたため topicId パラメータは、2017年2月27日から異なる動作をするようになりました。その時点で、YouTubeはキュレーションされたトピックIDの小さなセットをサポートし始め、あなたはこのパラメータの値としてその小さなIDセットのみを使用することができます。

トピックス
音楽トピックス
/m/04rlf 音楽(親トピック)
/m/02mscn クリスチャン・ミュージック
/m/0ggq0m クラシック音楽
/m/01lyv 国名
/m/02lkt 電子音楽
/m/0glt670 ヒップホップ・ミュージック
/m/05rwpb インディペンデント音楽
/m/03_d0 ジャズ
/m/028sqc アジアの音楽
/m/0g293 ラテンアメリカの音楽
/m/064t9 ポップミュージック
/m/06cqb レゲエ
/m/06j6l リズム・アンド・ブルース
/m/06by7 ロック・ミュージック
/m/0gywn ソウル・ミュージック
ゲームのトピック
/m/0bzvm2 ゲーム (親トピック)
/m/025zzc アクションゲーム
/m/02ntfj アクションアドベンチャーゲーム
/m/0b1vjn カジュアルゲーム
/m/02hygl 音楽ビデオゲーム
/m/04q1x3q パズル・ビデオゲーム
/m/01sjng レースゲーム
/m/0403l3g ロールプレイング・ビデオゲーム
/m/021bp2 シミュレーション・ビデオゲーム
/m/022dc6 スポーツゲーム
/m/03hf_rm 戦略ビデオゲーム
スポーツ・トピックス
/m/06ntj スポーツ(親トピック)
/m/0jm_ アメリカンフットボール
/m/018jz 野球
/m/018w8 バスケットボール
/m/01cgz ボクシング
/m/09xp_ クリケット
/m/02vx4 サッカー
/m/037hz ゴルフ
/m/03tmr アイスホッケー
/m/01h7lh 総合格闘技
/m/0410tth モータースポーツ
/m/07bs0 テニス
/m/07_53 バレーボール
エンターテインメント・トピックス
/m/02jjt エンターテインメント(親トピック)
/m/09kqc ユーモア
/m/02vxn 映画
/m/05qjc 舞台芸術
/m/066wd プロレス
/m/0f2f9 テレビ番組
ライフスタイル・トピック
/m/019_rr ライフスタイル(親トピック)
/m/032tl ファッション
/m/027x7n フィットネス
/m/02wbm フード
/m/03glg 趣味
/m/068hy ペット
/m/041xxh 肉体的魅力【ビューティー
/m/07c1v テクノロジー
/m/07bxq 観光
/m/07yv9 車両
社会トピックス
/m/098wr 社会(親トピック)
/m/09s1f ビジネス
/m/0kt51 健康
/m/01h6rj ミリタリー
/m/05qt0 政治
/m/06bvp 宗教
その他のトピック
/m/01k8wb 知識

 

videoCaption string
について videoCaption パラメータは、API が動画検索結果をキャプションの有無に基づいてフィルタリングするかどうかを指定する:

  • any - キャプションの有無で結果をフィルタリングしない。
  • closedCaption - キャプションのあるビデオのみを含める。
  • none - キャプションのないビデオのみを含める。
videoCategoryId string
について videoCategoryId パラメータは、動画の検索結果をその検索結果に基づいてフィルタリングします。 カテゴリー.
videoDefinition string
について videoDefinition パラメータを使用すると、高解像度(HD)または標準解像度(SD)のビデオのみを含むように検索を制限することができます。HDビデオは少なくとも720pで再生可能ですが、1080pのような高解像度も可能な場合があります:

  • any - 解像度に関係なく、すべてのビデオを返す。
  • high - HDビデオだけを取り出す。
  • standard - 標準画質のビデオのみを検索します。
videoDimension string
について videoDimension パラメータを使用すると、2Dまたは3Dビデオのみを検索するように検索を制限することができます:

  • 2d - 3Dビデオを除外するために検索結果を制限する。
  • 3d - 検索結果を3Dビデオのみに制限する。
  • any - 3D動画と非3D動画の両方を検索結果に含める。これはデフォルト値です。
videoDuration string
について videoDuration パラメータは、ビデオの検索結果を継続時間に基づいてフィルタリングします:

  • any - 動画の検索結果を再生時間に基づいてフィルタリングしない。これはデフォルト値です。
  • long - 20分以上の動画に限ります。
  • medium - 4分以上20分以内のビデオに限ります。
  • short - 長さ4分以内のビデオのみを含めること。
videoEmbeddable string
について videoEmbeddable パラメータを使用すると、ウェブページに埋め込むことができるビデオのみに検索を制限することができます:

  • any - 埋め込み可能かどうかにかかわらず、すべての動画を返す。
  • true - 埋め込み可能な動画のみを取得する。
videoLicense string
について videoLicense パラメータは、検索結果に特定のライセンスの動画のみを含めるようにフィルタリングします。YouTube では、動画アップロード者が動画にクリエイティブ・コモンズ・ライセンスまたは標準 YouTube ライセンスのいずれかを選択できます:

  • any - クエリパラメータに一致する動画を、ライセンスに関係なくすべて返します。
  • creativeCommon - クリエイティブ・コモンズ・ライセンスを持つ動画のみを返します。ユーザーは、このライセンスを持つ動画を、作成した他の動画で再利用することができます。 さらに詳しく.
  • youtube - YouTubeの標準ライセンスを持つ動画のみを返します。
videoSyndicated string
について videoSyndicated パラメータを使用すると、youtube.com以外で再生可能なビデオのみに検索を制限することができます:

  • any - シンジケートの有無にかかわらず、すべてのビデオを返す。
  • true - シンジケートされたビデオのみを取得する。
videoType string
について videoType パラメータを使用すると、特定のタイプのビデオに検索を制限することができます:

  • any - すべてのビデオを返す。
  • episode - 番組のエピソードだけを取り出す。
  • movie - 映画だけを取り出す。
サポート

ドキュメントに答えが見つからない?

サポート

この記事は役に立ちましたか?