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
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียง 1 รายการ)
channelId string
พารามิเตอร์ channelId ระบุรหัสช่อง YouTube API จะแสดงผลการสมัครรับข้อมูลของช่องนั้นเท่านั้น
id string
พารามิเตอร์ id ระบุรายการที่คั่นด้วยคอมมาของรหัสการสมัครรับข้อมูล YouTube อย่างน้อย 1 รายการสำหรับทรัพยากรที่จะดึงข้อมูล ในทรัพยากร 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