Activities: list

YouTube เลิกใช้งานฟีเจอร์ประกาศของช่องแล้ว เมธอด 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 ที่คุณสามารถรวมไว้ในค่าพารามิเตอร์
  • contentDetails
  • id
  • snippet
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียง 1 รายการ)
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