ข้ามไปยังเนื้อหา
TH
รับคีย์ API
เรียกดูเอกสาร

เอกสารอ้างอิง API

YouTube ขยายการค้นหาแล้ว API

รับคีย์ API

รับข้อมูลถึง 700 YouTube ผลการค้นหาต่อความต้องการ โดยมีรายละเอียดวิดีโอ, ภาพตัวอย่าง และตัวกรองการค้นหา

สร้างคำขอ

จํานวนสูงสุดของผลการค้นหาที่จะกลับมา

พารามิเตอร์ขั้นสูง
คุณสมบัติ
POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_search_extended",
    "query": "python",
    "params": {
        "max_results": 20,
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
ผลในการตอบสนอง HTTPX-API-Key ยืนยัน

พารามิเตอร์

ส่ง source ถึง query ที่ระดับบนสุด ตัวเลือกของแหล่งอยู่ใน params. ช่องข้อมูลทางเลือกสามารถยกเลิกได้

เนื้อหาคำขอ

sourcestring / จำเป็น
กําหนดเป็น youtube_search_extended
querystring / จำเป็น
สืบค้น
1 ถึง 2,000 ตัวอักษรค่าปริยาย: ยังไม่ได้ตั้งค่า
paramsobject / ไม่บังคับ
Settings สําหรับการร้องขอนี้
ค่าปริยาย: {}
callback_urlstring · nullable / ไม่บังคับ
Async และชุดเท่านั้น สาธารณะ HTTPS เสร็จสมบูรณ์แล้ว URL บนพอร์ต 443ถึง 2,048 ตัวละคร ไม่มีเอกสารรับรองผู้ใช้หรือส่วน URL Omit, ใช้ null หรือข้อความเปล่าสําหรับไม่ให้แจ้งเตือน ในชุดนี้ กําหนดให้แต่ละคําถาม ภายนอกพม่า
ค่าปริยาย: ยังไม่ได้ตั้งค่า

จํานวนผลลัพธ์

params.max_resultsinteger / ไม่บังคับ
ร้องขอผลนับ อาจ มี ผล เพียง ไม่ กี่ อย่าง.
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 / ไม่บังคับ
ผลการสั่งซื้อ ใช้ Omit YouTubeการเรียงลําดับปริยาย
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 เพื่อต้องการลักษณะ vir180
true หรือ falseค่าปริยาย: ยังไม่ได้ตั้งค่า

คำตอบ

Realtime กลับค่า status: done. อ่านผลลัพธ์ที่ส่งมาจากแหล่ง results[0].results; usage.credits บันทึกค่าใช้จ่าย.

การค้นหาผลลัพธ์ที่แสดงออกมา มีการค้นหาอยู่ totalResults และของที่นํามาคืน totalResults นับรายการของการตอบสนองนี้; มันไม่ใช่จํานวนวิดีโอที่เข้าคู่กันทั้งหมด YouTube.

อ่านผลที่ออกมา

บันทึกความสําเร็จ JSON ตอบกลับเป็น response.json. บันทึกนี้เป็น read-response.py และเรียกไพธอน read-response.py. มันใช้เฉพาะ Pythonห้องสมุดมาตรฐาน และไม่มีการร้องขอใหม่

read-response.py
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 แยกกันทํางาน การร้องขอที่มีขนาดใหญ่กว่านี้ อาจใช้เวลานานกว่านั้น แอซิงค์หลีกเลี่ยงการเชื่อมต่อของผู้ส่งได้

ตัวกรองอยู่ใน params.filters อาจ มี ผล เพียง ไม่ กี่ อย่าง และ สิ่ง ของ ที่ อุดม สมบูรณ์ ก็ สามารถ หา ได้ null หรือขาดเรียน การค้นหาที่ขยายแล้ว มีอัตราการใช้งานของมันเอง

ช่องข้อมูลทั้งหมด
ช่องข้อมูลคําอธิบาย
sourcestringสิ่งที่ร้องขอมา API แหล่งข่าว
statusstringเสร็จสิ้นเมื่อการร้องขอจริง สําเร็จ
created_atstringช่วงเวลาการสร้างแบบ ISO 8601
usage.creditsnumberบัตรเครดิตตามที่ขอ จากแผนของคุณ
results[0].querystringสืบค้นดู
results[0].totalResultsintegerจํานวนของผลลัพธ์ที่ได้กลับมา
results[0].resultsarrayสืบค้นผลในลําดับที่ส่งกลับมา
results[0].results[].videoIdstringYouTube วิดีโอ 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ภาพตัวอย่าง URLs และขนาด

ช่องข้อมูลด้านบน จะใช้อธิบายค่าปริยาย JSON ตอบสนอง JSONข้อความธรรมดาและ Markdown รูปแบบ.

Async คืนค่าเป็นใบเสร็จงานหนึ่งตัว; จํานวนครั้งจะคืนค่ากลับมาเป็นหนึ่งตัว สืบค้น. โปรดตรวจสอบสถานะงานพิมพ์แต่ละงาน และรับผลของมันโดยใช้ที่อยู่เชื่อมโยงที่ส่งกลับ

Async วงจรชีวิตแบบชุด

การรับช่วงนําใบเสร็จกลับมา ไม่ใช่ผลลัพธ์ Async สร้างงานหนึ่งงาน; กลุ่มต่าง ๆ จะคืนค่ากลับมาเป็นงานที่แยกไว้ queries[] สําหรับทุก ๆ คนที่สอบถามเจ้า ติดตามและรับงานแต่ละงานเป็นอิสระ

ส่งข้อมูลไปยัง data.flashdata.dev; สืบค้นสถานะงานและผลลัพธ์จาก api.flashdata.dev กับ X-API-Key แบบเดียวกัน ความ เกี่ยว พัน API ตัวอย่างพื้นฐานที่ใช้ Python ถึง cURL.

  1. 1. บันทึกงาน IDs

    เก็บรายการที่ต้องการของแหล่งนี้เมื่อสลับไปยัง Async สําหรับ Batchใส่การร้องขอแต่ละในลําดับของ JSON วัตถุ บันทึกงานที่ส่งกลับทั้งหมด ID

    Async ร้องขอและใบเสร็จ · Batch ต้องการตัวบุคคล

  2. 2. ตรวจสอบสถานะ

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: โพลด้วยความล่าช้าและความเคารพ Retry-After เมื่อถึงวันนี้ completed: รับผล failed: สืบค้นเมื่อ job.error.

    อ่าน job.status ไม่ใช่สถานะใบเสร็จรับส่ง

    ตรวจสอบสถานะที่: Python ถึง cURL

    สถานะงาน API อ้างอิง
  3. 3. ดึงข้อมูลผลลัพธ์

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    หลังจากเติมให้สมบูรณ์แล้ว ให้ยืนยันการอ่านผลที่อ่านแล้ว 302 คลังสื่อ URL # หากไม่มีเธอ # API กุญแจ บันทึก JSON ภายใน 24 ชั่วโมงของการเติมให้สมบูรณ์

    ดึงข้อมูลผลลัพธ์ที่ออกมา Python ถึง cURL · รูปแบบคำตอบ

    ดาวน์โหลดผลลัพธ์ API อ้างอิง

การ สํารวจ และ ได้ ผล ที่ มี อยู่ แล้ว ไม่ ได้ ใช้ เงิน เครดิต ที่ สอบ ถาม. จับเวลาแบบสํารวจไม่ได้ยกเลิกงาน: ให้ ID แทนการส่งงานที่ซ้ํากัน % 1 ไม่ถูกต้อง!.

Webhook เมื่อเสร็จสิ้น

บอกรับต่อคําค้น

ตั้งค่า callback_url ที่ระดับบนสุดของการร้องขอ Asinc หรือ ภายในแต่ละคําถาม ในชุดที่อยู่นอก params. ไม่มีความต้องการการแยกเว็บฮุค- regressing Realtime ร้องขอไม่ให้ส่งการเรียกกลับ

ใช้สาธารณะชน HTTPS URL บนพอร์ต 443. FlashDataPOSTS แจ้งเตือนสําหรับแต่ละงานพิมพ์ที่ไปถึง completed หรือ failed; เหตุการณ์ที่บรรจุลิงก์ ไม่ใช่ผลลัพธ์เอง

การยอมรับและตรวจสอบ

กลับค่า 2xx หลังจากยอมรับเหตุการณ์นั้น บิดเบี้ยวโดย delivery_id, ยังถูกส่งมาเป็น X-Delivery-Id. ไม่ ปฏิบัติ ตาม การ ชี้ นํา.

การส่งล้มเหลว การลองใหม่ด้วยการกลับแบบเอกซ์โปเนนเชียลขึ้นไป 8 พยายามรวมทั้งหมด และที่มากที่สุด 24 ชั่วโมงหลังจากเติมให้สมบูรณ์แล้ว. ให้การวินิจฉัยเป็น การผิดพลาด

การเรียกตัวยังไม่แน่ชัด ยืนยันงาน IDแหล่งที่มาและสถานะปลายทางผ่าน สถานะที่ยืนยันแล้ว ก่อนที่จะประมวลผลการแจ้งเตือน การส่งมอบ ID สําหรับ deduction, ไม่ใช่ข้อพิสูจน์ของความเป็นจริง

ตัวอย่าง Hook เหตุการณ์และช่องข้อมูล
แจ้งเตือนการเติมให้สมบูรณ์
{
  "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 ส่วนหัว
idstringJoob ID.
sourcestringต้องการแหล่งข้อมูล
statusstringเสร็จสมบูรณ์หรือล้มเหลว
linksarrayสถานะและการเชื่อมโยงผลลัพธ์ การแจ้งให้ทราบไม่รวมเนื้อหาหรือรายการที่มีผล API กุญแจ
links[].relstringตัวตนหรือผลลัพธ์
links[].hrefstringการจัดการสัมบูรณ์ API URL2; ยืนยันตัวด้วย API กุญแจ
links[].methodstringGET.

สัญญาเว็บฮุคแบบเต็มและ URL จํากัด

การกู้คืนผิดพลาด

หาก มี การ ขอ เวลา อย่าง แท้ จริง มาก มาย การ ยอม รับ อาจ ไม่ แน่นอน. ตรวจสอบประวัติงานก่อนที่จะเปลี่ยน สําหรับการค้นหาขนาดใหญ่ภายหลัง ให้เลือก Async และติดตามการส่งกลับ ID

สําหรับการตรวจสอบสิทธิ์, ดุลยภาพ, ร้องขอunit-format และอัตราการสิ้นสุดของอัตรา - การอ้างอิงข้อผิดพลาดร่วมกัน เวลา ที่ ใช้ ไป แล้ว อาจ ยัง คง สร้าง งาน อยู่; ตรวจ สอบ งาน ที่ มี อยู่ ก่อน จะ ลอง ทํา ใหม่.

ข้อผิดพลาดและรหัสสถานะ · เมื่อต้องการลองใหม่ · ข้อจํากัดของอัตรา

ไกด์ทีละขั้น: วางแผนการค้นหาผู้สมัครที่มีขนาดใหญ่

ราคา

ราคาและแผนจํากัดในปัจจุบัน