Subscriptions

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

วิธีการ

API รองรับวิธีต่อไปนี้สําหรับทรัพยากร subscriptions รายการ

list
แสดงทรัพยากรการสมัครใช้บริการที่ตรงกับเกณฑ์คําขอ API ลองใช้เลย
แทรก
เพิ่มการสมัครใช้บริการให้ช่องของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ลองใช้เลย
ลบ
ลบการสมัครใช้บริการ ลองใช้เลย

การนําเสนอแหล่งข้อมูล

โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบทรัพยากร subscriptions

{
  "kind": "youtube#subscription",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelTitle": string,
    "title": string,
    "description": string,
    "resourceId": {
      "kind": string,
      "channelId": string,
    },
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "totalItemCount": unsigned integer,
    "newItemCount": unsigned integer,
    "activityType": string
  },
  "subscriberSnippet": {
    "title": string,
    "description": string,
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  }
}

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

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

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่านี้จะเป็น youtube#subscription
etag etag
Etag ของทรัพยากรนี้
id string
รหัสที่ YouTube ใช้ในการระบุการติดตามแบบไม่ซ้ํา
snippet object
ออบเจ็กต์ snippet มีรายละเอียดพื้นฐานเกี่ยวกับการสมัครใช้บริการ รวมถึงชื่อและช่องที่ผู้ใช้สมัครใช้บริการ
snippet.publishedAt datetime
วันที่และเวลาที่สร้างการสมัครใช้บริการ ค่านี้ระบุในรูปแบบ ISO 8601
snippet.channelTitle string
ชื่อช่องของการสมัครใช้บริการ
snippet.title string
ชื่อของการสมัครใช้บริการ
snippet.description string
รายละเอียดของการสมัครใช้บริการ
snippet.resourceId object
ออบเจ็กต์ id มีข้อมูลเกี่ยวกับช่องที่ผู้ใช้ติดตาม
snippet.resourceId.kind string
ประเภทของทรัพยากร API
snippet.resourceId.channelId string
ค่าที่ YouTube ใช้เพื่อระบุช่องที่ไม่ซ้ํากันซึ่งผู้ใช้ติดตาม
snippet.channelId string
รหัสที่ YouTube ใช้เพื่อระบุช่องของผู้ติดตามที่ไม่ซ้ํากัน ออบเจ็กต์ resource_id ระบุช่องที่ผู้ใช้ติดตาม
snippet.thumbnails object
แผนที่ภาพขนาดย่อที่เชื่อมโยงกับการสมัครใช้บริการ สําหรับแต่ละออบเจ็กต์ในแผนที่ คีย์คือชื่อของภาพขนาดย่อ และค่าจะเป็นออบเจ็กต์ที่มีข้อมูลอื่นๆ เกี่ยวกับภาพขนาดย่อ
snippet.thumbnails.(key) object
ค่าคีย์ที่ถูกต้องคือ
  • default – ภาพขนาดย่อเริ่มต้นสําหรับทรัพยากรนี้ ภาพขนาดย่อเริ่มต้นสําหรับวิดีโอหรือทรัพยากรที่อ้างอิงถึงวิดีโอ เช่น รายการเพลย์ลิสต์หรือผลการค้นหา มีความกว้าง 120 พิกเซลและสูง 90 พิกเซล ภาพขนาดย่อเริ่มต้นของช่องมีความกว้าง 88 พิกเซลและสูง 88 พิกเซล
  • medium – ภาพขนาดย่อที่มีความละเอียดสูงกว่า สําหรับวิดีโอ (หรือทรัพยากรที่อ้างอิงถึงวิดีโอ) รูปภาพนี้จะมีความกว้าง 320 พิกเซลและสูง 180 พิกเซล สําหรับช่อง รูปภาพนี้จะมีความกว้าง 240 พิกเซลและสูง 240 พิกเซล
  • high – ภาพขนาดย่อที่มีความละเอียดสูง สําหรับวิดีโอ (หรือทรัพยากรที่อ้างอิงถึงวิดีโอ) รูปภาพนี้กว้าง 480 พิกเซลและสูง 360 พิกเซล สําหรับช่องหนึ่งๆ รูปภาพนี้จะมีความกว้าง 800 พิกเซลและสูง 800 พิกเซล
snippet.thumbnails.(key).url string
URL ของรูปภาพ
snippet.thumbnails.(key).width unsigned integer
ความกว้างของรูปภาพ
snippet.thumbnails.(key).height unsigned integer
ความสูงของรูปภาพ
contentDetails object
ออบเจ็กต์ contentDetails มีสถิติพื้นฐานเกี่ยวกับการสมัครใช้บริการ
contentDetails.totalItemCount unsigned integer
จํานวนรายการโดยประมาณที่การสมัครใช้บริการชี้ไป
contentDetails.newItemCount unsigned integer
จํานวนรายการใหม่ในการสมัครใช้บริการนับตั้งแต่การอ่านเนื้อหาครั้งล่าสุด
contentDetails.activityType string
ประเภทของกิจกรรมการสมัครใช้บริการนี้มีไว้สําหรับ (การอัปโหลดทุกอย่างเท่านั้น)

ค่าที่ถูกต้องสําหรับพร็อพเพอร์ตี้นี้คือ
  • all
  • uploads
subscriberSnippet object
ออบเจ็กต์ subscriberSnippet มีรายละเอียดพื้นฐานเกี่ยวกับผู้ติดตาม
subscriberSnippet.title string
ชื่อช่องของสมาชิก
subscriberSnippet.description string
คําอธิบายของช่องของผู้ติดตาม
subscriberSnippet.channelId string
รหัสที่ YouTube กําหนดเพื่อระบุช่องของผู้ติดตามที่ไม่ซ้ํากัน
subscriberSnippet.thumbnails object
ภาพขนาดย่อสําหรับช่องของผู้ติดตาม
subscriberSnippet.thumbnails.(key) object
ค่าคีย์ที่ถูกต้องคือ
  • default – ภาพขนาดย่อเริ่มต้นสําหรับทรัพยากรนี้ ภาพขนาดย่อเริ่มต้นสําหรับวิดีโอหรือทรัพยากรที่อ้างอิงถึงวิดีโอ เช่น รายการเพลย์ลิสต์หรือผลการค้นหา มีความกว้าง 120 พิกเซลและสูง 90 พิกเซล ภาพขนาดย่อเริ่มต้นของช่องมีความกว้าง 88 พิกเซลและสูง 88 พิกเซล
  • medium – ภาพขนาดย่อที่มีความละเอียดสูงกว่า สําหรับวิดีโอ (หรือทรัพยากรที่อ้างอิงถึงวิดีโอ) รูปภาพนี้จะมีความกว้าง 320 พิกเซลและสูง 180 พิกเซล สําหรับช่อง รูปภาพนี้จะมีความกว้าง 240 พิกเซลและสูง 240 พิกเซล
  • high – ภาพขนาดย่อที่มีความละเอียดสูง สําหรับวิดีโอ (หรือทรัพยากรที่อ้างอิงถึงวิดีโอ) รูปภาพนี้กว้าง 480 พิกเซลและสูง 360 พิกเซล สําหรับช่องหนึ่งๆ รูปภาพนี้จะมีความกว้าง 800 พิกเซลและสูง 800 พิกเซล
subscriberSnippet.thumbnails.(key).url string
URL ของรูปภาพ
subscriberSnippet.thumbnails.(key).width unsigned integer
ความกว้างของรูปภาพ
subscriberSnippet.thumbnails.(key).height unsigned integer
ความสูงของรูปภาพ