GroupItems: list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
สำคัญ: คำขอ API สำหรับเมธอดนี้ต้องมีสิทธิ์เข้าถึงอย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/youtube
ขอบเขต
หรือ
- ขอบเขต
https://www.googleapis.com/auth/youtube.readonly
และ
ขอบเขต https://www.googleapis.com/auth/yt-analytics.readonly
ตัวเลือกแรกจะใช้ขอบเขต 1 ขอบเขต ซึ่งเกิดขึ้นเป็นขอบเขตแบบอ่านและเขียน ในขณะที่ตัวเลือกที่ 2 ใช้ขอบเขตแบบอ่านอย่างเดียว 2 ขอบเขต
แสดงคอลเล็กชันรายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ API
ส่งคำขอ
คำขอ HTTP
GET https://youtubeanalytics.googleapis.com/v2/groupItems
การให้สิทธิ์
คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 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 |
พารามิเตอร์
ตารางด้านล่างแสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา
พารามิเตอร์ |
พารามิเตอร์ที่จำเป็น |
groupId |
string
พารามิเตอร์ id จะระบุรหัสที่ไม่ซ้ำกันของกลุ่มที่คุณต้องการดึงข้อมูลรายการกลุ่ม |
พารามิเตอร์ที่ไม่บังคับ |
onBehalfOfContentOwner |
string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์ด้านเนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่องเท่านั้น
พารามิเตอร์ onBehalfOfContentOwner ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube ที่ทำหน้าที่ในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ ซึ่งจะช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์เพียงครั้งเดียวและเข้าถึงข้อมูลวิดีโอและช่องทั้งหมดของตนได้โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชีที่ผู้ใช้ใช้ตรวจสอบสิทธิ์ต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ |
เนื้อหาของคำขอ
อย่าระบุเนื้อหาคำขอเมื่อเรียกใช้เมธอดนี้
คำตอบ
หากทำสำเร็จ วิธีการนี้จะแสดงผลลัพธ์เป็นเนื้อหาการตอบกลับซึ่งมีโครงสร้างดังต่อไปนี้
{
"kind": "youtube#groupItemListResponse",
"etag": etag,
"items": [
groupItem Resource
]
}
พร็อพเพอร์ตี้
ตารางต่อไปนี้จะกำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ |
kind |
string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#groupItemListResponse
|
etag |
etag
Etag ของทรัพยากรนี้ |
items[] |
list
รายการรายการที่กลุ่มมี แต่ละรายการในรายการแสดงถึงทรัพยากร groupItem |
ข้อผิดพลาด
API ไม่ได้กำหนดข้อความแสดงข้อผิดพลาดเฉพาะสำหรับเมธอด API นี้ อย่างไรก็ตาม วิธีการนี้อาจยังแสดงข้อผิดพลาดทั่วไปของ API ที่ระบุไว้ในเอกสารข้อความแสดงข้อผิดพลาด
ลองใช้งาน
ใช้ APIs Explorer เพื่อเรียก API นี้และดูคําขอและการตอบกลับของ API
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-08-21 UTC
[null,null,["อัปเดตล่าสุด 2025-08-21 UTC"],[[["\u003cp\u003eThis API method retrieves a collection of group items that match the specified request parameters.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this method requires authorization with either the \u003ccode\u003ehttps://www.googleapis.com/auth/youtube\u003c/code\u003e scope or the combination of \u003ccode\u003ehttps://www.googleapis.com/auth/youtube.readonly\u003c/code\u003e and \u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics.readonly\u003c/code\u003e scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egroupId\u003c/code\u003e parameter is required to specify the unique ID of the group for which you want to retrieve items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter is an optional parameter allowing content owners to authenticate once to access data for all their channels, and it is intended exclusively for YouTube content partners managing multiple channels.\u003c/p\u003e\n"],["\u003cp\u003eThe response body structure includes a \u003ccode\u003ekind\u003c/code\u003e property identifying the type as \u003ccode\u003eyoutube#groupItemListResponse\u003c/code\u003e, an \u003ccode\u003eetag\u003c/code\u003e, and an \u003ccode\u003eitems[]\u003c/code\u003e list containing the requested groupItem resources.\u003c/p\u003e\n"]]],["To retrieve group items, use a `GET` request to `https://youtubeanalytics.googleapis.com/v2/groupItems`. Authorization requires either the `https://www.googleapis.com/auth/youtube` or both `https://www.googleapis.com/auth/youtube.readonly` and `https://www.googleapis.com/auth/yt-analytics.readonly` scopes. The `groupId` parameter is required. The `onBehalfOfContentOwner` parameter is optional for content partners. The API returns a collection of group items; response properties include `kind`, `etag`, and a list of `items`. There is no request body.\n"],null,["# GroupItems: list\n\n**Important:** API requests to this method require access to either:\n\n- the `https://www.googleapis.com/auth/youtube` scope \n or\n- the `https://www.googleapis.com/auth/youtube.readonly` scope \n *and* \n the `https://www.googleapis.com/auth/yt-analytics.readonly` scope\n\nThe first option uses one scope, which happens to be a read-write scope, while the second option uses two read-only scopes.\nReturns a collection of group items that match the API request parameters.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://youtubeanalytics.googleapis.com/v2/groupItems\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/analytics/authentication)).\n\n| Scopes ||\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| https://www.googleapis.com/auth/yt-analytics.readonly | View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts. |\n| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to estimated revenue and ad performance metrics. |\n| https://www.googleapis.com/auth/youtube | Manage your YouTube account. In the YouTube Analytics API, channel owners use this scope to manage YouTube Analytics groups and group items. |\n| https://www.googleapis.com/auth/youtubepartner | View and manage YouTube assets and associated content on YouTube. In the YouTube Analytics API, content owners use this scope to manage YouTube Analytics groups and group items. |\n\n### Parameters\n\nThe table below lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `groupId` | `string` The **id** parameter specifies the unique ID of the group for which you want to retrieve group items. |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"#kind\": \"youtube#groupItemListResponse\",\n \"#etag\": etag,\n \"#items[]\": [\n groupItem Resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#groupItemListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of items that the group contains. Each item in the list represents a [groupItem](/youtube/analytics/reference/groupItems) resource. |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/analytics/reference/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]