แสดงผลรายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ 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 Etag ของทรัพยากรนี้ |
items[] |
list รายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ API แต่ละรายการในลิสต์แสดงถึงทรัพยากร group |
nextPageToken |
string โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าถัดไปในชุดผลลัพธ์ได้ |
ข้อผิดพลาด
API ไม่ได้กําหนดข้อความแสดงข้อผิดพลาดที่ไม่ซ้ํากันให้กับเมธอด API นี้ แต่วิธีนี้อาจยังแสดงข้อผิดพลาด API ทั่วไปที่ระบุไว้ในเอกสารประกอบข้อความแสดงข้อผิดพลาด
ลองใช้เลย
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคําขอและการตอบกลับ API