Subscriptions: list

แสดงผลทรัพยากรการสมัครใช้บริการที่ตรงกับเกณฑ์คำขอ API

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part ระบุรายการที่คั่นด้วยคอมมาของพร็อพเพอร์ตี้ทรัพยากร subscription อย่างน้อย 1 รายการซึ่งการตอบกลับจาก API จะรวมไว้ด้วย

หากพารามิเตอร์ระบุพร็อพเพอร์ตี้ที่มีพร็อพเพอร์ตี้ย่อย พร็อพเพอร์ตี้ย่อยจะรวมอยู่ในการตอบกลับ ตัวอย่างเช่น ในทรัพยากร subscription พร็อพเพอร์ตี้ snippet จะมีพร็อพเพอร์ตี้อื่นๆ เช่น ชื่อที่แสดงสำหรับการสมัครใช้บริการ หากคุณตั้งค่า part=snippet การตอบกลับจาก API จะมีพร็อพเพอร์ตี้ที่ฝังอยู่ทั้งหมด

รายการต่อไปนี้มีชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
ตัวกรอง (ระบุพารามิเตอร์รายการใดรายการหนึ่งต่อไปนี้เท่านั้น)
channelId string
พารามิเตอร์ channelId จะระบุรหัสช่อง YouTube API จะส่งคืนการติดตามของช่องดังกล่าวเท่านั้น
id string
พารามิเตอร์ id ระบุรายการรหัสการติดตาม YouTube ที่คั่นด้วยคอมมาสำหรับทรัพยากรที่กำลังเรียกข้อมูล ในทรัพยากร subscription พร็อพเพอร์ตี้ id จะระบุรหัสการติดตามของ YouTube
mine boolean
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อเรียกฟีดการสมัครใช้บริการของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
myRecentSubscribers boolean
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อเรียกฟีดของผู้สมัครใช้บริการของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ตามลำดับเวลาแบบย้อนกลับ (ใหม่สุดก่อน)

โปรดทราบว่าระบบอาจจำกัดจำนวนสมาชิกที่แสดงผลผ่าน API นี้
mySubscribers boolean
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อเรียกฟีดของสมาชิกของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วโดยไม่เรียงตามลำดับเฉพาะ โปรดทราบว่าระบบอาจจำกัดจำนวนสมาชิกที่ส่งคืนผ่าน API นี้
พารามิเตอร์ที่ไม่บังคับ
forChannelId string
พารามิเตอร์ forChannelId จะระบุรายการรหัสแชแนลที่คั่นด้วยคอมมา การตอบสนองของ API จะมีเฉพาะการติดตามที่ตรงกับช่องเหล่านั้นเท่านั้น
maxResults unsigned integer
พารามิเตอร์ maxResults จะระบุจำนวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับได้คือ 0 ถึง 50 ค่าเริ่มต้นคือ 5
onBehalfOfContentOwner string
หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube โดยเฉพาะ

พารามิเตอร์ onBehalfOfContentOwner บ่งชี้ว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube CMS ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่อง ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์เพียงครั้งเดียวและมีสิทธิ์เข้าถึงข้อมูลวิดีโอและช่องทั้งหมดของตนโดยไม่ต้องระบุข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์จะต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ
onBehalfOfContentOwnerChannel string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwnerChannel จะระบุรหัสช่อง YouTube ของช่องที่มีการเพิ่มวิดีโอ ต้องระบุพารามิเตอร์นี้เมื่อคำขอระบุค่าสำหรับพารามิเตอร์ onBehalfOfContentOwner และสามารถใช้ร่วมกับพารามิเตอร์ดังกล่าวเท่านั้น นอกจากนี้ คำขอจะต้องได้รับอนุญาตโดยใช้บัญชี CMS ที่ลิงก์กับเจ้าของเนื้อหาที่พารามิเตอร์ onBehalfOfContentOwner ระบุไว้ สุดท้าย ช่องที่ค่าพารามิเตอร์ onBehalfOfContentOwnerChannel ระบุจะต้องลิงก์กับเจ้าของเนื้อหาที่พารามิเตอร์ onBehalfOfContentOwner ระบุไว้

พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ หลายช่อง ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์เพียงครั้งเดียวและดำเนินการต่างๆ ในนามของช่องที่ระบุในค่าพารามิเตอร์ได้โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบสำหรับการตรวจสอบสิทธิ์แต่ละช่องแยกกัน
order string
พารามิเตอร์ order ระบุเมธอดที่จะใช้ในการจัดเรียงทรัพยากรในการตอบกลับของ API ค่าเริ่มต้นคือ SUBSCRIPTION_ORDER_RELEVANCE

ค่าที่ยอมรับได้มีดังนี้
  • alphabetical – จัดเรียงตามตัวอักษร
  • relevance – จัดเรียงตามความเกี่ยวข้อง
  • unread – จัดเรียงตามลำดับกิจกรรม
pageToken string
พารามิเตอร์ pageToken จะระบุหน้าเว็บที่เฉพาะเจาะจงในชุดผลลัพธ์ที่ควรแสดง ในการตอบกลับของ API พร็อพเพอร์ตี้ nextPageToken และ prevPageToken จะระบุหน้าอื่นๆ ที่ดึงได้

เนื้อหาของคำขอ

ไม่ต้องระบุเนื้อหาคำขอเมื่อเรียกใช้วิธีการนี้

คำตอบ

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

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

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

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

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) accountClosed ดึงข้อมูลการติดตามไม่ได้เนื่องจากบัญชีของสมาชิกถูกปิด
forbidden (403) accountSuspended เรียกข้อมูลการติดตามไม่ได้เนื่องจากบัญชีของสมาชิกถูกระงับ
forbidden (403) subscriptionForbidden ผู้ขอไม่ได้รับอนุญาตให้เข้าถึงการสมัครใช้บริการที่ขอ
notFound (404) subscriberNotFound ไม่พบสมาชิกที่ระบุในคำขอ

ลองใช้เลย

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