Subscriptions: list

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

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

กรณีการใช้งานทั่วไป

ส่งคำขอ

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

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

พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหา YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จํานวนมาก ช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้ 1 ครั้งและดําเนินการในนามของช่องที่ระบุไว้ในค่าพารามิเตอร์ โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบของแต่ละช่อง
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