taskType SOCIAL に platform youtube を指定し、action で読み取る対象を選びます。完了したリクエスト 1 件につき 0.5 クレジットです。
リクエスト
GET /v1/async/task/{id} をポーリングするか Webhook で受け取ります。非同期タスクを参照してください。
アクション
videoId には動画 ID か YouTube 動画の URL (視聴ページ、youtu.be、ショート、埋め込み) を指定します。channel にはチャンネル ID (UC...)、@handle、チャンネル URL を指定します。
パラメータ
search と recent:
query: 必須。検索語句です。limit: 任意の整数、1-50。デフォルトは 10 です。type:video(デフォルト)、all、shorts、channel、playlist、movieのいずれかです。order:relevance(デフォルト)、viewCount、date、ratingのいずれかです。dateはrecentと同じく新しいアップロードから並べます。ratingは YouTube の再生回数上位の結果を高評価数で並べ替えます。channelとplaylistの検索はrelevanceかviewCountを受け付けます。publishedAfter:2026-11-01T00:00:00Zのような ISO 8601 の日時です。この日時より後に公開された動画を返します。videoDuration:short(3 分未満)、medium(3-20 分)、long(20 分超) のいずれかです。features:live、4k、hd、subtitles、creative_commons、360、vr180、3d、hdr、location、purchasedから任意の値を、配列かカンマ区切りの文字列で指定します。exactSpelling:trueにすると、YouTube のスペル補正なしで入力どおりに検索します。pageToken: 前のページのnextPageTokenです。publishedAfterなしでrelevanceかviewCountで並べた動画検索がこの値を返し、各ページはそれまでのページが返した動画をすべて飛ばします。regionCodeとlanguageCode: 検索する YouTube の地域 (US、KR、JP) と表示言語 (en、ko、ja) です。
comments:
limit: 任意の整数、1-500。デフォルトは 100 です。返信も件数に含まれます。order:relevance(デフォルト、YouTube の評価順) かtime(新しい順) です。includeReplies: 任意。デフォルトはtrueです。
channel_videos:
tab:videos(デフォルト)、shorts、streamsのいずれかです。sort:latest(デフォルト)、popular、oldestのいずれかです。limit: 任意の整数、1-50。デフォルトは 20 です。
transcript:
languages:["en", "ko"]のように優先順に並べた字幕の言語です。指定しない場合は、動画のデフォルト字幕、英語、最初のトラックの順に読み取ります。isGenerated:trueは自動生成字幕だけを、falseはアップロード者の字幕だけを読み取ります。trackName: 読み取る字幕トラックの名前です。translateTo: 言語コードです。YouTube が字幕をその言語に翻訳します。maxSegments: 任意の整数、1-5,000。デフォルトは 2,000 です。
レスポンス例
結果フィールド
- すべてのレスポンスは
platformとactionをそのまま返します。一覧にはreturnedCountがあります。 searchとrecentはvideosを返します。各動画にはposition、videoId、url、title、description、チャンネルのchannelId、channelTitle、channelHandle、channelUrl、channelThumbnail、channelIsVerified、publishedAt、publishedTimeText、duration(ISO 8601)、durationSeconds、viewCount、likeCount、category、thumbnails、richThumbnail(動くプレビュー)、badges、isFamilySafeがあります。映画にはポスター、ジャンル、公開年、出演者、監督を含むmovieが加わります。- 検索は、結果ページに表示される
channels、playlists、shorts、shelvesとtotalResults(YouTube の推定値) も返し、YouTube が検索語句を補正したときはdidYouMeanかshowingResultsForを返します。 videoはtags、commentCount、subscriberCount、hasCaptions、chapters、mostReplayed、music、descriptionLinks、relatedVideosを加えます。アップロード者のチャプターが先に来て、自動チャプターにはautoGenerated: trueが付きます。commentsはcommentsを返します。各コメントにはcommentId、parentId(トップレベルのコメントではnull)、text、authorDisplayName、authorChannelId、authorProfileImageUrl、authorIsVerified、authorIsChannelOwner、isPinned、isHearted、likeCount、replyCount、publishedAt、updatedAtがあります。totalCountは YouTube が表示する件数で、topLevelCountとreplyCountはreturnedCountの内訳です。channelはchannelId、title、handle、description、country、publishedAt、subscriberCount、videoCount、viewCount、isVerified、keywords、links、thumbnails、bannerUrl、rssUrl、uploadsPlaylistIdを返します。channel_videosはsortの順に並んだvideosと、チャンネルのchannelId、channelTitleを返します。transcriptは字幕のtext、時刻付きのsegments(startとduration、秒単位)、読み取ったlanguage、availableLanguagesを返します。truncated: trueはmaxSegmentsで切り詰めた字幕を示します。- 高評価数を非表示にした動画には
likesHidden: true、コメントをオフにした動画にはcommentsDisabled: trueが付きます。メンバー限定動画にはmembersOnly: trueが付き、viewCountはありません。 - 存在しない動画、チャンネル、字幕トラックや、年齢制限付き動画のようにログインした視聴者にしか表示されないものは、タスクを
PAGE_UNAVAILABLEで終了させます。組み合わせられないパラメータはタスクをBAD_PAYLOADで終了させます。課金されるのは完了したリクエストだけです。