문서 둘러보기
API 참조
YouTube 확장 검색 API
최대 700 YouTube 검색 결과 요청 당, 비디오 세부 사항, 썸네일 및 검색 필터.
요청 구성
검색 결과의 최대 수를 반환합니다.
고급 매개변수
https://data.flashdata.dev/v1/queries/realtime제품 설명
제품 정보 source 으로 query 최고 수준에서. Source 옵션은 params. 선택적인 분야는 omitted 일 수 있습니다.
요청 본문
sourcestring / 필수- youtube_search_extended로 설정.
querystring / 필수- 자주 묻는 질문1 으로 2,000 이름 *기본 정보:
설정하기 paramsobject / 선택 사항- 이 요구를 위한 Settings.기본 정보:
{} callback_urlstring · nullable / 선택 사항- Async 및 배치만. 공공 HTTPS 완료 URL 포트에 443, 최대 2,048 문자. 사용자 자격 또는 URL 파편이 없습니다. Omit, null 또는 알림이 없는 빈 문자열을 사용하십시오. 일괄 처리에서, 각 쿼리에 설정, 외부 params.기본 정보:
설정하기
결과 수
params.max_resultsinteger / 선택 사항- 요청된 결과 수. Fewer 결과는 사용할 수 있습니다.1 으로 700, 전체 번호기본 정보:
20
검색 필터
params.filtersobject · nullable / 선택 사항- 옵션 업로드 날짜, 결과 유형, 기간, 정렬 및 기능 필터. Omit 또는 필터가 없는 null를 사용하십시오.기본 정보:
설정하기 params.filters.upload_datestring / 선택 사항- 업로드 날짜에 의해 필터.1 으로 2,000 이름 *가치:
today / last_hour / this_week / this_month / this_year기본 정보:설정하기 params.filters.typestring / 선택 사항- 결과 유형에 의한 필터.1 으로 2,000 이름 *가치:
video / channel / playlist / movie기본 정보:설정하기 params.filters.durationstring / 선택 사항- 몇 분 안에 비디오 시간 동안 필터.1 으로 2,000 이름 *가치:
<4 / 4-20 / >20기본 정보:설정하기 params.filters.sort_bystring / 선택 사항- 결과 주문. YouTube의 기본 주문을 사용하려면 Omit.1 으로 2,000 이름 *가치:
rating / relevance / view_count / upload_date기본 정보:설정하기 params.filters.360boolean / 선택 사항- true를 설정하여 360 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.3dboolean / 선택 사항- true를 설정하여 3D 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.4kboolean / 선택 사항- true를 설정하여 4k 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.creative_commonsboolean / 선택 사항- true를 설정하여 크리에이티브 커먼즈 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.hdboolean / 선택 사항- true를 설정하여 HD 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.hdrboolean / 선택 사항- true를 설정하여 hdr 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.liveboolean / 선택 사항- true를 설정하여 라이브 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.locationboolean / 선택 사항- 위치 기능을 필요로 하는 true를 설정합니다.
true또는false기본 정보:설정하기 params.filters.purchasedboolean / 선택 사항- true를 설정하여 구매한 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.subtitlesboolean / 선택 사항- true를 설정하여 자막 기능을 필요로 합니다.
true또는false기본 정보:설정하기 params.filters.vr180boolean / 선택 사항- true를 설정하여 vr180 기능을 필요로 합니다.
true또는false기본 정보:설정하기
응답
Realtime 반환 status: done. 소스 출력을 읽으십시오 results[0].results; usage.credits 책임의 기록.
검색 출력은 쿼리, totalResults 및 반환 항목이 포함되어 있습니다. totalResults는이 응답의 항목이 계산합니다. YouTube에 일치하는 동영상의 총 수는 없습니다.
결과보기
response.json로 성공적인 JSON 응답을 저장하십시오. read-response.py로 저장하고 python read-response.py를 실행하십시오. Python의 표준 라이브러리를 사용하고 새로운 요청을 만들 수 있습니다.
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = [
{"videoId": item.get("videoId"), "title": item.get("title"), "channel": item.get("channel")}
for item in result.get("results", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))max_results는 20에 기본적으로 1를 700로 받아들입니다. 이것은 700 별도의 일괄 작업이 아닌 하나의 더 큰 검색 요청입니다. 더 큰 요청은 더 오래 걸릴 수 있습니다; async는 submitter의 연결이 열립니다.
필터는 params.filters에 속합니다. Fewer 결과는 유효하골, 부유한 품목 분야는 null 또는 absent일 수 있습니다. 확장된 검색에는 자체 사용률이 있습니다.
모든 응답 분야
| - 연혁 | 의 특징 |
|---|---|
sourcestring | 요청된 API 소스. |
statusstring | 실시간 요청이 성공할 때 완료됩니다. |
created_atstring | ISO 8601 형식의 응답 생성 시간. |
usage.creditsnumber | 요청시 크레딧이 청구되며, 플랜을 기준으로 합니다. |
results[0].querystring | 검색 쿼리. |
results[0].totalResultsinteger | 반환된 결과의 수. |
results[0].resultsarray | 반환된 순서에 결과를 검색합니다. |
results[0].results[].videoIdstring | YouTube 비디오 ID. |
results[0].results[].titlestring | 비디오 제목. |
results[0].results[].channelstring | 채널 이름. |
results[0].results[].channelIdstring · nullable | 유효한 때 채널 ID. |
results[0].results[].channelUrlstring · nullable | 유효한 때 채널 URL. |
results[0].results[].durationnumber · nullable | 몇 초 안에 비디오 지속. |
results[0].results[].durationStringstring · nullable | 사용할 때 포맷 된 비디오 시간. |
results[0].results[].viewCountnumber · nullable | 사용할 때 카운트보기. |
results[0].results[].uploadDatestring · nullable | 업로드 날짜 |
results[0].results[].descriptionstring · nullable | 500 문자, 또는 null를 사용할 수 없을 때 설명 발췌. |
results[0].results[].thumbnailsarray | Thumbnail URLs 및 치수. |
위의 필드는 기본 JSON 응답을 설명합니다. JSON, 일반 텍스트 및 Markdown 형식.
Async는 1개의 일 영수증을 돌려보냅니다; 배치는 당 1개를 돌려보냅니다 의논하기. 각 업무의 상태를 확인하고 반환된 링크를 사용하여 결과를 검색하십시오.
Async 및 배치 수명주기
제출은 영수증을 반환, 결과가 아닙니다. Async는 한 일을 만듭니다; 배치는 분리된 일을 안으로 돌려보냅니다 queries[] 모든 허용된 쿼리에 대 한. 각 직무를 독립적으로 추적하고 검색합니다.
제출하기 data.flashdata.dev; 작업 상태 및 결과 읽기 api.flashdata.dev 동일한 X-API-Key로. API 기본 예제는 Python 및 cURL를 사용합니다.
1. 작업 IDs 저장
Async로 전환 할 때이 소스 요청 필드를 유지하십시오. Batch의 경우, JSON 객체의 쿼리 배열 내부에 각 요청을 넣어. 모든 반환 작업 ID 저장.
2. 본문 바로가기
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: 지연 및 존경을 가진 오염Retry-After현재 위치completed: fetch 결과.failed: 검사job.error.job.status를 읽으십시오, 제출 영수증의 상태는 아닙니다.
일 상태 API 참고3. Fetch 결과
GET https://api.flashdata.dev/v2/jobs/{jobId}/results완료 후 결과를 확인한 다음 302 저장 URL 키를 사용하지 않고 API 저장을 읽습니다. 24 시간 내에 JSON를 저장하십시오.
결과 다운로드 API 참조
오염 및 기존 결과를 fetching하는 것은 쿼리 크레딧을 사용하지 않습니다. 퇴직시간은 업무 취소를 하지 않습니다. ID 대신 중복 청구 가능한 작업을 제출합니다. 오류 코드 및 재시동 행동.
완료 웹훅
자주 묻는 질문
설치하기 callback_url async 요청의 최고 수준에서, 또는 각 질의 안 배치에서, 밖에 params. 별도의 webhook-registration 요청이 필요하지 않습니다. Realtime 요청은 콜백을 보내지 않습니다.
포트 443에 공공 HTTPS URL를 사용하십시오. FlashData POSTs 각 작업에 대한 알림 completed 또는 failed; 이벤트 포함 링크, 그 결과 자체.
Acknowledge 및 검증
을 읽다 2xx 이벤트를 수락 한 후. 으로 Deduplicate delivery_id, 또한 보내진 것과 같이 X-Delivery-Id. Redirects는 다음과 같습니다.
실패한 납품은 exponential backoff, 까지 재기합니다 8는 총 시도 가장 많이 완료 후 24 시간. 추락으로 오염을 지키십시오.
Callbacks는 할당되지 않습니다. ID, 소스 및 터미널 상태를 확인 인증된 상태 endpoint 알림을 처리하기 전에. 납품 ID는 deduplication를 위해, 정정성의 증거 아닙니다.
webhook 이벤트 및 필드 보기
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_search_extended",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| - 연혁 | 의 특징 |
|---|---|
delivery_idstring | 안정적인 납품 식별자. 이 값을 사용하여 알림을 삭제; 또한 X-Delivery-Id 헤더에 보내집니다. |
idstring | 작업 ID. |
sourcestring | 요청된 데이터 소스. |
statusstring | 완료 또는 실패. |
linksarray | 상태 및 결과 링크. 알림은 결과 내용이나 API 키가 포함되지 않습니다. |
links[].relstring | 자기 또는 결과. |
links[].hrefstring | 절대 관리 API URL; 당신의 API 열쇠로 정정. |
links[].methodstring | GET. |
오류 복구
큰 실시간 요청 시간이 아웃되면, 합격은 불확실 할 수 있습니다. resubmitting 전에 작업 내역을 확인하십시오. 후속 큰 검색을 위해, 동기화를 선택하고 반환 ID를 추적.
인증, 균형, 요청 정보 및 속도 제한 실패를 위해, 공유 오류 참조를 사용합니다. 제출 시간표는 여전히 일자리를 만들 수 있습니다; 재발하기 전에 기존 작업을 확인하십시오.
단계별 가이드: 더 큰 후보 검색 계획