Activities: list

YouTube ได้เลิกใช้งานฟีเจอร์กระดานข่าวสารของช่องแล้ว เมธอด activities.list จะไม่แสดงกระดานข่าวสารของช่อง และไม่รองรับเมธอด activities.insert อีกต่อไป ดูรายละเอียดเพิ่มเติมได้ที่ศูนย์ช่วยเหลือของ YouTube

แสดงรายการเหตุการณ์กิจกรรมในช่องที่ตรงกับเกณฑ์คำขอ เช่น คุณสามารถเรียกข้อมูลเหตุการณ์ที่เชื่อมโยงกับช่องใดช่องหนึ่งหรือช่องของผู้ใช้เอง

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

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

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

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

รายการต่อไปนี้มีชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้
  • contentDetails
  • id
  • snippet
ตัวกรอง (ระบุพารามิเตอร์รายการใดรายการหนึ่งต่อไปนี้เท่านั้น)
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