activities.list
ยังคงไม่แสดงกระดานข่าวสารของช่อง และไม่รองรับเมธอด activities.insert
อีกต่อไป ดูรายละเอียดเพิ่มเติมได้ที่ศูนย์ช่วยเหลือของ YouTube
แสดงผลรายการกิจกรรมของช่องที่ตรงกับเกณฑ์คําขอ ตัวอย่างเช่น คุณเรียกดูเหตุการณ์ที่เชื่อมโยงกับช่องใดช่องหนึ่งหรือกับช่องของผู้ใช้ได้
ผลกระทบต่อโควต้า: การเรียกใช้วิธีการนี้มีโควต้า ซึ่งมี 1 หน่วย
กรณีการใช้งานทั่วไป
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/youtube/v3/activities
พารามิเตอร์
ตารางต่อไปนี้จะแสดงพารามิเตอร์ที่คําค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จําเป็น | ||
part |
string พารามิเตอร์ part ระบุรายการที่คั่นด้วยคอมมาของพร็อพเพอร์ตี้ทรัพยากร activity อย่างน้อย 1 รายการที่จะตอบกลับ APIหากพารามิเตอร์ระบุพร็อพเพอร์ตี้ที่มีพร็อพเพอร์ตี้ย่อย พร็อพเพอร์ตี้ย่อยจะรวมอยู่ในการตอบกลับ ตัวอย่างเช่น ในทรัพยากร activity พร็อพเพอร์ตี้ snippet มีพร็อพเพอร์ตี้อื่นที่ระบุประเภทกิจกรรม ชื่อที่แสดงของกิจกรรม และอื่นๆ หากคุณตั้งค่า part=snippet การตอบกลับ API จะมีพร็อพเพอร์ตี้ที่ซ้อนอยู่ทั้งหมดเหล่านั้นด้วยรายการต่อไปนี้มี part ชื่อที่คุณสามารถใส่ในค่าพารามิเตอร์
|
|
ตัวกรอง (ระบุพารามิเตอร์ตัวใดตัวหนึ่งต่อไปนี้) | ||
channelId |
string พารามิเตอร์ channelId จะระบุรหัสช่อง YouTube ที่ไม่ซ้ํากัน จากนั้น API จะแสดงรายการกิจกรรมของช่องนั้นๆ |
|
home |
boolean หมายเหตุ: เราเลิกใช้งานพารามิเตอร์นี้แล้ว สําหรับคําขอที่ตั้งพารามิเตอร์นี้ การตอบกลับ API จะมีรายการคล้ายกับที่ผู้ใช้ที่ออกจากระบบแล้วจะเห็นในหน้าแรกของ YouTube โปรดทราบว่าพารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตที่เหมาะสมเท่านั้น |
|
mine |
boolean พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อเรียกข้อมูลฟีดกิจกรรมของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว |
|
พารามิเตอร์ที่ไม่บังคับ | ||
maxResults |
unsigned integer พารามิเตอร์ maxResults จะระบุจํานวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับคือ 0 ถึง 50 ค่าเริ่มต้นคือ 5 |
|
pageToken |
string พารามิเตอร์ pageToken จะระบุหน้าที่เจาะจงในชุดผลลัพธ์ที่ควรแสดงผล ในการตอบกลับ API พร็อพเพอร์ตี้ nextPageToken และ prevPageToken จะระบุหน้าอื่นๆ ที่สามารถดึงข้อมูลได้ |
|
publishedAfter |
datetime พารามิเตอร์ publishedAfter จะระบุวันที่และเวลาแรกสุดที่อาจทําให้กิจกรรมรวมอยู่ในการตอบกลับของ API หากค่าพารามิเตอร์ระบุวัน แต่ระบุเวลาไม่ได้ กิจกรรมที่เกิดขึ้นในวันนั้นจะรวมอยู่ในชุดผลลัพธ์ ค่านี้ระบุในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ) |
|
publishedBefore |
datetime พารามิเตอร์ publishedBefore จะระบุวันที่และเวลาที่เกิดกิจกรรมขึ้นเพื่อให้ระบบดําเนินการดังกล่าวในการตอบกลับ API หากค่าพารามิเตอร์ระบุวัน แต่ระบุเวลาไม่ได้ ระบบจะยกเว้นกิจกรรมที่เกิดขึ้นในวันนั้นจากชุดผลลัพธ์ ค่านี้ระบุในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ) |
|
regionCode |
string พารามิเตอร์ regionCode จะสั่งให้ API แสดงผลการค้นหาสําหรับประเทศที่ระบุ ค่าพารามิเตอร์คือรหัสประเทศตามมาตรฐาน ISO 3166-1 alpha-2 YouTube จะใช้ค่านี้เมื่อกิจกรรมก่อนหน้าของผู้ใช้ที่ได้รับอนุญาตบน YouTube มีข้อมูลไม่เพียงพอที่จะสร้างฟีดกิจกรรม |
เนื้อหาของคำขอ
ไม่ต้องให้เนื้อหาคําขอเมื่อเรียกใช้วิธีการนี้
คำตอบ
หากสําเร็จ วิธีนี้จะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้างต่อไปนี้
{ "kind": "youtube#activityListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ activity Resource ] }
พร็อพเพอร์ตี้
ตารางต่อไปนี้กําหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
kind |
string ระบุประเภทของทรัพยากร API ค่านี้จะเป็น youtube#activityListResponse |
etag |
etag Etag ของทรัพยากรนี้ |
nextPageToken |
string โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าถัดไปในชุดผลลัพธ์ได้ |
prevPageToken |
string โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าก่อนหน้าในชุดผลลัพธ์ได้ |
pageInfo |
object ออบเจ็กต์ pageInfo จะสรุปข้อมูลการแบ่งหน้าสําหรับชุดผลลัพธ์ |
pageInfo.totalResults |
integer จํานวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์ |
pageInfo.resultsPerPage |
integer จํานวนผลลัพธ์ที่รวมอยู่ในการตอบกลับ API |
items[] |
list รายการกิจกรรมหรือเหตุการณ์ที่ตรงกับเกณฑ์คําขอ |
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
forbidden (403) |
forbidden |
คําขอไม่ได้รับอนุญาตอย่างถูกต้อง |
forbidden (403) |
homeParameterDeprecated |
ข้อมูลกิจกรรมในหน้าแรกของผู้ใช้ไม่พร้อมใช้งานผ่าน API นี้ ข้อผิดพลาดนี้อาจเกิดขึ้นหากคุณตั้งค่าพารามิเตอร์ home เป็น true ในคําขอที่ไม่ได้รับอนุญาต |
notFound (404) |
channelNotFound |
ไม่พบรหัสแชแนลที่ระบุโดยพารามิเตอร์ channelId ของคําขอ |
notFound (404) |
homeChannelNotFound |
ไม่พบฟีดหน้าแรกของ YouTube สําหรับผู้ใช้ปัจจุบันที่ตรวจสอบสิทธิ์แล้ว |
unauthorized (401) |
authorizationRequired |
คําขอใช้พารามิเตอร์ home แต่ไม่ได้รับอนุญาตอย่างถูกต้อง |
ลองใช้เลย
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคําขอและการตอบกลับ API