GuideCategories: list

หมายเหตุ: นี่คือประกาศการเลิกใช้งาน

guideCategories resource และguideCategories.list method ได้เลิกใช้งานแล้วตั้งแต่วันที่ 9 กันยายน 2020

แสดงรายการหมวดหมู่ที่เชื่อมโยงกับช่อง YouTube ได้

ผลกระทบต่อโควต้า: การเรียกใช้เมธอดนี้มีต้นทุนโควต้า 1 หน่วย

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/youtube/v3/guideCategories

พารามิเตอร์

ตารางด้านล่างแสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part ระบุพร็อพเพอร์ตี้ทรัพยากร guideCategory ที่การตอบกลับของ API จะรวมไว้ ตั้งค่าพารามิเตอร์เป็น snippet
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้ 1 รายการเท่านั้น)
id string
พารามิเตอร์ id ระบุรายการรหัสหมวดหมู่ของช่อง YouTube ที่คั่นด้วยคอมมาสำหรับแหล่งข้อมูลที่กำลังดึงข้อมูล ในทรัพยากร guideCategory พร็อพเพอร์ตี้ id จะระบุรหัสหมวดหมู่ของช่อง YouTube
regionCode string
พารามิเตอร์ regionCode จะสั่งให้ API แสดงรายการหมวดหมู่คำแนะนำที่พร้อมใช้งานในประเทศที่ระบุ ค่าพารามิเตอร์คือรหัสประเทศ ISO 3166-1 Alpha-2
พารามิเตอร์ที่ไม่บังคับ
hl string
พารามิเตอร์ hl จะระบุภาษาที่จะใช้สำหรับค่าข้อความในการตอบกลับของ API ค่าเริ่มต้นคือ en-US

เนื้อความของคำขอ

อย่าระบุเนื้อหาคำขอเมื่อเรียกใช้เมธอดนี้

การตอบกลับ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับที่มีโครงสร้างดังนี้

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้กำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#guideCategoryListResponse
etag etag
Etag ของทรัพยากรนี้
nextPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าถัดไปในชุดผลลัพธ์ได้
prevPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าก่อนหน้าในชุดผลลัพธ์ได้
pageInfo object
ออบเจ็กต์ pageInfo จะห่อหุ้มข้อมูลการแบ่งหน้าสำหรับชุดผลลัพธ์
pageInfo.totalResults integer
จํานวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์
pageInfo.resultsPerPage integer
จำนวนผลลัพธ์ที่รวมอยู่ในการตอบกลับของ API
items[] list
รายการหมวดหมู่ที่เชื่อมโยงกับช่อง YouTube ได้ ในแผนที่นี้ รหัสหมวดหมู่คือคีย์ของแผนที่ และค่าของรหัสหมวดหมู่คือทรัพยากร guideCategory ที่เกี่ยวข้อง

ข้อผิดพลาด

ตารางด้านล่างระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเพื่อตอบสนองต่อการเรียกใช้เมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
notFound (404) notFound ไม่พบหมวดหมู่คำแนะนำที่ระบุโดยพารามิเตอร์ id ใช้วิธี guideCategories.list เพื่อดึงรายการค่าที่ถูกต้อง

ลองใช้งาน

ใช้ APIs Explorer เพื่อเรียก API นี้และดูคำขอและการตอบกลับของ API