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 |
string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#groupListResponse |
etag |
etag
แท็กของทรัพยากรนี้ |
items[] |
list
รายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ API แต่ละรายการในลิสต์จะแสดงทรัพยากร group |
nextPageToken |
string
โทเค็นที่ใช้เป็นค่าพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าถัดไปในชุดผลลัพธ์ได้ |
ข้อผิดพลาด
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\u003eRetrieves a list of YouTube groups based on specified criteria, such as group IDs or ownership by the authenticated user.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific scopes to access group data, including read-only access to YouTube Analytics reports.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by group IDs (\u003ccode\u003eid\u003c/code\u003e parameter) or retrieving all groups owned by the authenticated user (\u003ccode\u003emine\u003c/code\u003e parameter).\u003c/p\u003e\n"],["\u003cp\u003eSupports optional parameters like \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e for content owners managing multiple channels and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eReturns a response containing group details, including kind, Etag, items (list of groups), and a token for retrieving the next page of results.\u003c/p\u003e\n"]]],["This API method retrieves a list of YouTube Analytics groups. Requests are made via a `GET` request to a specified URL. Authentication requires specific scopes like `yt-analytics.readonly`. Users can filter groups by specifying group `id`s or by setting `mine` to `true` to get all groups they own. The response contains an `etag`, a list of `groups`, and potentially a `nextPageToken` for pagination. The method has the possibility to use `onBehalfOfContentOwner` for content owners.\n"],null,["# Groups: list\n\nReturns a list of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://youtubeanalytics.googleapis.com/v2/groups\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| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`. |\n| `mine` | `boolean` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). Set this parameter's value to `true` to retrieve all groups owned by the authenticated user. |\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| `pageToken` | `string` The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved. |\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#groupListResponse\",\n \"#etag\": etag,\n \"#items[]\": [\n group Resource\n ],\n \"#nextPageToken\": string\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#groupListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of groups that match the API request parameters. Each item in the list represents a [group](/youtube/analytics/reference/groups) resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\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."]]
