Groups: list

แสดงผลรายการกลุ่มที่ตรงกับพารามิเตอร์คำขอ API เช่น คุณสามารถดึงข้อมูลกลุ่มทั้งหมดที่ผู้ใช้ที่ตรวจสอบสิทธิ์เป็นเจ้าของ หรือดึงข้อมูลกลุ่มอย่างน้อย 1 กลุ่มตามรหัสที่ไม่ซ้ำกันได้

ส่งคำขอ

คำขอ HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

การให้สิทธิ์

คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ (อ่านเพิ่มเติมเกี่ยวกับการรับรองและการให้สิทธิ์)

ขอบเขต
https://www.googleapis.com/auth/yt-analytics.readonly ดูรายงาน YouTube Analytics สำหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้ให้สิทธิ์เข้าถึงเมตริกกิจกรรมของผู้ใช้ เช่น จํานวนยอดดูและคะแนน
https://www.googleapis.com/auth/yt-analytics-monetary.readonly ดูรายงานการเงินของ YouTube Analytics สำหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้ให้สิทธิ์เข้าถึงเมตริกกิจกรรมของผู้ใช้ รวมถึงเมตริกรายได้และประสิทธิภาพโฆษณาโดยประมาณ
https://www.googleapis.com/auth/youtube จัดการบัญชี YouTube ใน YouTube Analytics API เจ้าของช่องจะใช้ขอบเขตนี้เพื่อจัดการกลุ่มและรายการกลุ่มของ YouTube Analytics
https://www.googleapis.com/auth/youtubepartner ดูและจัดการเนื้อหา YouTube และเนื้อหาที่เกี่ยวข้องบน YouTube ใน YouTube Analytics API เจ้าของเนื้อหาจะใช้ขอบเขตนี้เพื่อจัดการกลุ่มและรายการกลุ่มของ YouTube Analytics

พารามิเตอร์

ตารางด้านล่างแสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา

พารามิเตอร์
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียงรายการเดียว)
id string
พารามิเตอร์ id จะระบุรายการรหัสกลุ่ม YouTube ที่คั่นด้วยคอมมาสำหรับทรัพยากรที่กำลังดึงข้อมูล โดยผู้ใช้ที่ตรวจสอบสิทธิ์แล้วต้องเป็นเจ้าของกลุ่มแต่ละกลุ่ม ในทรัพยากร group พร็อพเพอร์ตี้ id จะระบุรหัสกลุ่ม YouTube ของกลุ่ม

โปรดทราบว่าหากไม่ได้ระบุค่าสำหรับพารามิเตอร์ id คุณต้องตั้งค่าพารามิเตอร์ mine เป็น true
mine boolean
ใช้พารามิเตอร์นี้ได้ในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น ตั้งค่าพารามิเตอร์นี้เป็น true เพื่อดึงข้อมูลกลุ่มทั้งหมดที่ผู้ใช้ที่ตรวจสอบสิทธิ์เป็นเจ้าของ
พารามิเตอร์ที่ไม่บังคับ
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหา YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่องเท่านั้น

พารามิเตอร์ onBehalfOfContentOwner บ่งชี้ว่าข้อมูลเข้าสู่ระบบสำหรับการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์เพียงครั้งเดียวและเข้าถึงข้อมูลวิดีโอและข้อมูลช่องทั้งหมดได้โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชีที่ผู้ใช้ตรวจสอบสิทธิ์จะต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ
pageToken string
พารามิเตอร์ pageToken จะระบุหน้าเว็บที่เฉพาะเจาะจงในชุดผลลัพธ์ที่ควรแสดง ในการตอบกลับของ API พร็อพเพอร์ตี้ nextPageToken จะระบุหน้าถัดไปที่ดึงข้อมูลได้

เนื้อหาของคำขอ

อย่าระบุเนื้อหาคำขอเมื่อเรียกใช้เมธอดนี้

คำตอบ

หากทำสำเร็จ วิธีการนี้จะแสดงผลลัพธ์เป็นเนื้อหาการตอบกลับซึ่งมีโครงสร้างดังต่อไปนี้

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

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

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

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#groupListResponse
etag etag
แท็กของทรัพยากรนี้
items[] list
รายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ API แต่ละรายการในลิสต์จะแสดงทรัพยากร group
nextPageToken string
โทเค็นที่ใช้เป็นค่าพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าถัดไปในชุดผลลัพธ์ได้

ข้อผิดพลาด

API ไม่ได้กำหนดข้อความแสดงข้อผิดพลาดเฉพาะสำหรับเมธอด API นี้ อย่างไรก็ตาม วิธีการนี้อาจยังแสดงข้อผิดพลาดทั่วไปของ API ที่ระบุไว้ในเอกสารข้อความแสดงข้อผิดพลาด

ลองใช้งาน

ใช้ APIs Explorer เพื่อเรียก API นี้และดูคําขอและการตอบกลับของ API