このエンドポイントが役立つこと
レスポンスには、一致する 検索、公開されているコンテキスト、さらに結果がある場合のページネーションデータが含まれます。
使用に適した場面
オブジェクトの正確な ID がわからず、まず関連する候補を見つける必要がある場合に「Shorts By Country」を使用します。
まず結果と一般的なワークフローを確認し、次にパラメーターと動作するリクエスト例に進んでください。
レスポンスには、一致する 検索、公開されているコンテキスト、さらに結果がある場合のページネーションデータが含まれます。
オブジェクトの正確な ID がわからず、まず関連する候補を見つける必要がある場合に「Shorts By Country」を使用します。
顧客向けおよび社内の画面に、YouTube のデータ検索を追加します。
クエリで候補を見つけ、関連するオブジェクトを保存して後でエンリッチします。
トピック、クリエイター、競合の分析のために結果セットを収集します。
どちらのバージョンも同じタスクを解決し、同じパラメーターを受け付けます。切り替えを使ってレスポンス構造を比較し、クライアントが想定するバージョンを選んでください。
このページでバージョンを切り替えると、同じドキュメント URL でレスポンス構造を比較できます。
認証、必須パラメーター、リクエストの形は V1 と V2 で同じです。実際には、エンドポイントのパスを組み立てるときとレスポンスを読み取るときにバージョンを選びます。
主な違いはレスポンスのエンベロープです。新しい連携では V2 を使用し、既存のクライアント契約との互換性が必要な場合にのみ V1 を残してください。
どちらのバージョンでも、同じ API キーのヘッダーと同じクエリパラメーターを使用します。このドキュメントでは、まず共通のパラメーターを示し、次に各バージョンのパスとコードスニペットを示します。
| パラメーター | 必須 | 型 | 例 | 説明 |
|---|---|---|---|---|
country_code |
はい | str |
US |
Two-letter ISO 3166-1 alpha-2 country code used for YouTube localization. Example: US. |
query |
はい | str |
technology review |
ユーザーが入力した検索クエリ。 |
cursor |
いいえ | str | None |
cursor-next-page |
前のレスポンスで返された次のページのカーソル。最初のページでは省略します。 |
エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。
GET /api/v2/youtube.com/search/shorts-by-countrycurl --request GET \
--url "https://www.scrapestorm.net/api/v2/youtube.com/search/shorts-by-country" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'country_code=US' \
--get --data-urlencode 'query=technology review' \
# Optional parameters:
# --data-urlencode 'cursor=cursor-next-page'
from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/youtube.com/search/shorts-by-country"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"country_code": "US",
"query": "technology review",
}
# Optional parameters
# params["cursor"] = "cursor-next-page"
with requests.Session() as session:
response = session.request(
method="GET",
url=urljoin(BASE_URL, ENDPOINT),
headers=HEADERS,
params=params,
timeout=30,
)
response.raise_for_status()
payload = response.json()
print(payload)
const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v2/youtube.com/search/shorts-by-country";
const params = new URLSearchParams({
country_code: "US",
query: "technology review",
});
// Optional parameters
// params.set("cursor", "cursor-next-page");
const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
method: "GET",
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
if (!response.ok) {
throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}
const payload = await response.json();
console.log(payload);
import axios from "axios";
const client = axios.create({
baseURL: "https://www.scrapestorm.net",
timeout: 30000,
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
const params = {
country_code: "US",
query: "technology review",
};
// Optional parameters
// params.cursor = "cursor-next-page";
const { data: payload } = await client.request({
method: "GET",
url: endpoint,
params,
});
console.log(payload);
<?php
declare(strict_types=1);
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
$client = new Client([
'base_uri' => "https://www.scrapestorm.net",
'timeout' => 30.0,
'headers' => [
'Accept' => 'application/json',
'X-API-Key' => "00000000-0000-4000-8000-000000000000",
],
]);
$query = [
"country_code" => "US",
"query" => "technology review",
];
// Optional parameters
// $query["cursor"] = "cursor-next-page";
try {
$response = $client->request("GET", "/api/v2/youtube.com/search/shorts-by-country", [
'query' => $query,
]);
$payload = json_decode(
(string) $response->getBody(),
true,
512,
JSON_THROW_ON_ERROR
);
var_dump($payload);
} catch (GuzzleException $e) {
throw $e;
}
package main
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
"time"
)
func main() {
baseURL := "https://www.scrapestorm.net"
endpoint := "/api/v2/youtube.com/search/shorts-by-country"
params := url.Values{}
params.Set("country_code", "US")
params.Set("query", "technology review")
// Optional parameters
// params.Set("cursor", "cursor-next-page")
req, err := http.NewRequest(
"GET",
fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Accept", "application/json")
req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")
client := &http.Client{Timeout: 30 * time.Second}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var payload any
if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
panic(err)
}
fmt.Printf("%+v\n", payload)
}
エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。
GET /api/v1/youtube.com/search/shorts-by-countrycurl --request GET \
--url "https://www.scrapestorm.net/api/v1/youtube.com/search/shorts-by-country" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'country_code=US' \
--get --data-urlencode 'query=technology review' \
# Optional parameters:
# --data-urlencode 'cursor=cursor-next-page'
from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/youtube.com/search/shorts-by-country"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"country_code": "US",
"query": "technology review",
}
# Optional parameters
# params["cursor"] = "cursor-next-page"
with requests.Session() as session:
response = session.request(
method="GET",
url=urljoin(BASE_URL, ENDPOINT),
headers=HEADERS,
params=params,
timeout=30,
)
response.raise_for_status()
payload = response.json()
print(payload)
const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v1/youtube.com/search/shorts-by-country";
const params = new URLSearchParams({
country_code: "US",
query: "technology review",
});
// Optional parameters
// params.set("cursor", "cursor-next-page");
const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
method: "GET",
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
if (!response.ok) {
throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}
const payload = await response.json();
console.log(payload);
import axios from "axios";
const client = axios.create({
baseURL: "https://www.scrapestorm.net",
timeout: 30000,
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
const params = {
country_code: "US",
query: "technology review",
};
// Optional parameters
// params.cursor = "cursor-next-page";
const { data: payload } = await client.request({
method: "GET",
url: endpoint,
params,
});
console.log(payload);
<?php
declare(strict_types=1);
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
$client = new Client([
'base_uri' => "https://www.scrapestorm.net",
'timeout' => 30.0,
'headers' => [
'Accept' => 'application/json',
'X-API-Key' => "00000000-0000-4000-8000-000000000000",
],
]);
$query = [
"country_code" => "US",
"query" => "technology review",
];
// Optional parameters
// $query["cursor"] = "cursor-next-page";
try {
$response = $client->request("GET", "/api/v1/youtube.com/search/shorts-by-country", [
'query' => $query,
]);
$payload = json_decode(
(string) $response->getBody(),
true,
512,
JSON_THROW_ON_ERROR
);
var_dump($payload);
} catch (GuzzleException $e) {
throw $e;
}
package main
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
"time"
)
func main() {
baseURL := "https://www.scrapestorm.net"
endpoint := "/api/v1/youtube.com/search/shorts-by-country"
params := url.Values{}
params.Set("country_code", "US")
params.Set("query", "technology review")
// Optional parameters
// params.Set("cursor", "cursor-next-page")
req, err := http.NewRequest(
"GET",
fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Accept", "application/json")
req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")
client := &http.Client{Timeout: 30 * time.Second}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var payload any
if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
panic(err)
}
fmt.Printf("%+v\n", payload)
}
プレビューには主要なフィールドとコレクションの最初の要素が含まれているため、レスポンスの形をすばやく確認できます。バージョンを切り替えると JSON の形式が変わります。
このコンパクトな JSON の例は、V2 の直近の成功した検証実行から取得したものです。
{
"success": true,
"status": "ok",
"pagination": {
"cursor": "QVFB...",
"has_more": true
},
"search_context": {
"query": "technology review",
"country_code": "US"
},
"data": {
"videos": {
"count": 25,
"items": [
{
"url": "https://www.youtube.com/shorts/KUVWYgTHAr8",
"video_id": "KUVWYgTHAr8",
"title": "$10 vs $1,000 Air Purifier",
"view_count": 75000000,
"thumbnail_url": "https://example.com/image.jpg",
"thumbnails": [
{
"url": "https://i.ytimg.com/vi/KUVWYgTHAr8/oardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLC_VRym-mKf11NqnKh9sz5BYvpY8A&usqp=CCk",
"width": 405,
"height": 720
},
{
"url": "https://i.ytimg.com/vi/KUVWYgTHAr8/oardefault.jpg?sqp=-oaymwEgCJUDEOAESFWQAgHyq4qpAw8IARUAAIhCcAHAAQbIAQE=&rs=AOn4CLCGFN94cum5PVhsyoOXWOBkrB8naA&usqp=CCk",
"width": 405,
"height": 608
}
],
"is_short": true
},
{
"url": "https://www.youtube.com/shorts/LZYfSYXY-go",
"video_id": "LZYfSYXY-go",
"title": "Apple’s THINNEST ever device is RIDICULOUS!",
"view_count": 19000000,
"thumbnail_url": "https://example.com/image.jpg",
"thumbnails": [
{
"url": "https://i.ytimg.com/vi/LZYfSYXY-go/oardefault.jpg?sqp=-oaymwEdCJUDENAFSFWQAgHyq4qpAwwIARUAAIhCcAHAAQY=&rs=AOn4CLD7IJ33pa04MtnihdaRtj7XdiqeZQ&usqp=CCk",
"width": 405,
"height": 720
},
{
"url": "https://i.ytimg.com/vi/LZYfSYXY-go/oardefault.jpg?sqp=-oaymwEgCJUDEOAESFWQAgHyq4qpAw8IARUAAIhCcAHAAQbIAQE=&rs=AOn4CLDzee_rR0TwGV4Z_zdqCm59X6eBhw&usqp=CCk",
"width": 405,
"height": 608
}
],
"is_short": true
},
{
"_more_items": 23
}
]
}
}
}
このコンパクトな JSON の例は、V1 の直近の成功した検証実行から取得したものです。
{
"success": true,
"status": "ok",
"pagination": {
"cursor": "QVFB...",
"has_more": true
},
"search_context": {
"query": "technology review",
"country_code": "US"
},
"data": {
"responseContext": {
"serviceTrackingParams": [
{
"service": "GUIDED_HELP",
"params": [
{
"key": "context",
"value": "yt_web_search"
},
{
"key": "logged_in",
"value": "0"
}
]
},
{
"service": "GFEEDBACK",
"params": [
{
"key": "has_unlimited_entitlement",
"value": "False"
},
{
"key": "has_premium_lite_entitlement",
"value": "False"
},
{
"_more_items": 2
}
]
},
{
"_more_items": 2
}
],
"mainAppWebResponseContext": {
"loggedOut": true,
"trackingParam": "k5_fmPxhoXZRWu60JfG7xEzA0B66M9M_CQDeoijGPbNb5rSiZUqgQmAbpzRMkuMESLBwOcCw59TLtslLKPQGSS"
},
"responseId": "IhMIttfpmNXflQMV6-jOAB2VKhGZ",
"webResponseContextExtensionData": {
"webResponseContextPreloadData": {
"preloadMessageNames": [
"twoColumnSearchResultsRenderer",
"sectionListRenderer",
{
"_more_items": 34
}
]
},
"hasDecorated": true
}
},
"estimatedResults": "7424362",
"contents": {
"twoColumnSearchResultsRenderer": {
"primaryContents": {
"sectionListRenderer": {
"contents": [
"…",
"…"
],
"trackingParams": "CDwQui8iEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"subMenu": {
"searchSubMenuRenderer": "…"
},
"hideBottomSeparator": true,
"targetId": "search-feed"
}
}
}
},
"trackingParams": "CAAQvGkiEwi21-mY1d-VAxXr6M4AHZUqEZnKAQRetfVv",
"header": {
"searchHeaderRenderer": {
"chipBar": {
"chipCloudRenderer": {
"chips": [
"…",
"…",
{
"_more_items": 5
}
],
"trackingParams": "CDIQkVoiEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"nextButton": {
"buttonRenderer": "…"
},
"previousButton": {
"buttonRenderer": "…"
}
}
},
"searchFilterButton": {
"buttonRenderer": {
"style": "STYLE_TEXT",
"size": "SIZE_DEFAULT",
"isDisabled": false,
"text": {
"runs": "…"
},
"icon": {
"iconType": "TUNE"
},
"tooltip": "Search filters",
"trackingParams": "CBMQ8FsiEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"accessibilityData": {
"accessibilityData": "…"
},
"command": {
"clickTrackingParams": "CBMQ8FsiEwi21-mY1d-VAxXr6M4AHZUqEZnKAQRetfVv",
"openPopupAction": "…"
},
"iconPosition": "BUTTON_ICON_POSITION_TYPE_RIGHT_OF_TEXT"
}
},
"trackingParams": "CBIQiOoKIhMIttfpmNXflQMV6-jOAB2VKhGZ"
}
},
"topbar": {
"desktopTopbarRenderer": {
"logo": {
"topbarLogoRenderer": {
"iconImage": {
"iconType": "YOUTUBE_LOGO"
},
"tooltipText": {
"runs": "…"
},
"endpoint": {
"clickTrackingParams": "CBEQsV4iEwi21-mY1d-VAxXr6M4AHZUqEZnKAQRetfVv",
"commandMetadata": "…",
"browseEndpoint": "…"
},
"trackingParams": "CBEQsV4iEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"overrideEntityKey": "EgZ0b3BiYXIg9QEoAQ%3D%3D"
}
},
"searchbox": {
"fusionSearchboxRenderer": {
"icon": {
"iconType": "SEARCH"
},
"placeholderText": {
"runs": "…"
},
"config": {
"webSearchboxConfig": "…"
},
"trackingParams": "CA0Q7VAiEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"searchEndpoint": {
"clickTrackingParams": "CA0Q7VAiEwi21-mY1d-VAxXr6M4AHZUqEZnKAQRetfVv",
"commandMetadata": "…",
"searchEndpoint": "…"
},
"clearButton": {
"buttonRenderer": "…"
},
"showImageSourceDialog": {
"clickTrackingParams": "CA0Q7VAiEwi21-mY1d-VAxXr6M4AHZUqEZnKAQRetfVv",
"showDialogCommand": "…"
},
"disableAiAppearance": true
}
},
"trackingParams": "CAEQq6wBIhMIttfpmNXflQMV6-jOAB2VKhGZ",
"topbarButtons": [
{
"topbarMenuButtonRenderer": {
"icon": "…",
"menuRequest": "…",
"trackingParams": "CAsQ_qsBGAAiEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"accessibility": "…",
"tooltip": "Settings",
"style": "STYLE_DEFAULT"
}
},
{
"buttonRenderer": {
"style": "STYLE_SUGGESTIVE",
"size": "SIZE_SMALL",
"text": "…",
"icon": "…",
"navigationEndpoint": "…",
"trackingParams": "CAoQ1IAEGAEiEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"targetId": "topbar-signin"
}
}
],
"hotkeyDialog": {
"hotkeyDialogRenderer": {
"title": {
"runs": "…"
},
"sections": [
"…",
"…",
{
"_more_items": 2
}
],
"dismissButton": {
"buttonRenderer": "…"
},
"trackingParams": "CAgQteYDIhMIttfpmNXflQMV6-jOAB2VKhGZ"
}
},
"backButton": {
"buttonRenderer": {
"trackingParams": "CAcQvIYDIhMIttfpmNXflQMV6-jOAB2VKhGZ",
"command": {
"clickTrackingParams": "CAcQvIYDIhMIttfpmNXflQMV6-jOAB2VKhGZygEEXrX1bw==",
"commandMetadata": "…",
"signalServiceEndpoint": "…"
}
}
},
"forwardButton": {
"buttonRenderer": {
"trackingParams": "CAYQvYYDIhMIttfpmNXflQMV6-jOAB2VKhGZ",
"command": {
"clickTrackingParams": "CAYQvYYDIhMIttfpmNXflQMV6-jOAB2VKhGZygEEXrX1bw==",
"commandMetadata": "…",
"signalServiceEndpoint": "…"
}
}
},
"a11ySkipNavigationButton": {
"buttonRenderer": {
"style": "STYLE_DEFAULT",
"size": "SIZE_DEFAULT",
"isDisabled": false,
"text": {
"runs": "…"
},
"trackingParams": "CAUQ8FsiEwi21-mY1d-VAxXr6M4AHZUqEZk=",
"command": {
"clickTrackingParams": "CAUQ8FsiEwi21-mY1d-VAxXr6M4AHZUqEZnKAQRetfVv",
"commandMetadata": "…",
"signalServiceEndpoint": "…"
}
}
},
"voiceSearchButton": {
"buttonRenderer": {
"style": "STYLE_DEFAULT",
"size": "SIZE_DEFAULT",
"isDisabled": false,
"serviceEndpoint": {
"clickTrackingParams": "CAIQ7a8FIhMIttfpmNXflQMV6-jOAB2VKhGZygEEXrX1bw==",
"commandMetadata": "…",
"signalServiceEndpoint": "…"
},
"icon": {
"iconType": "MICROPHONE_ON"
},
"tooltip": "Search with your voice",
"trackingParams": "CAIQ7a8FIhMIttfpmNXflQMV6-jOAB2VKhGZ",
"accessibilityData": {
"accessibilityData": "…"
}
}
}
}
},
"targetId": "search-page"
}
}
このドキュメントを最初の判断材料とし、継続的な利用のためにエンドポイントを接続する前に、料金、プラットフォームのカバー範囲、連携ルールを確認してください。
これらの回答を参考に、この API メソッドがワークフロー、バージョンの選択、導入計画に合うかどうかを判断してください。
このメソッドは 検索 に対して「Shorts By Country」を実行します。以下のコンパクトなレスポンス例で、フィールドの正確な構造を確認できます。
新しい連携では、正規化された構造を提供する V2 を選んでください。V1 は、既にプラットフォーム固有の形式を処理しているクライアントとの互換性のためにのみ使用してください。
API キーを作成し、リクエストヘッダーで送信し、表の必須パラメーターを指定してください。コード例には、正しいパスとリクエスト構造が既に含まれています。