Groups: list
Stay organized with collections
Save and categorize content based on your preferences.
Returns 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.
Request
HTTP request
GET https://youtubeanalytics.googleapis.com/v2/groups
Authorization
This request requires authorization with at least one of the following scopes (
read more about authentication and authorization
).
Scopes
|
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.
|
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.
|
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.
|
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.
|
Parameters
The table below lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Filters
(specify exactly one of the following parameters)
|
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
.
|
mine
|
boolean
This parameter can only be used in a properly
authorized request
. Set this parameter's value to
true
to retrieve all groups owned by the authenticated user.
|
Optional parameters
|
onBehalfOfContentOwner
|
string
This parameter can only be used in a properly
authorized request
.
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.
|
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.
|
Request body
Do not provide a request body when calling this method.
Response
Properties
The following table defines the properties that appear in this resource:
Properties
|
kind
|
string
Identifies the API resource's type. The value will be
youtube#groupListResponse
.
|
etag
|
etag
The Etag of this resource.
|
items[]
|
list
A list of groups that match the API request parameters. Each item in the list represents a
group
resource.
|
nextPageToken
|
string
The token that can be used as the value of the
pageToken
parameter to retrieve the next page in the result set.
|
Errors
The 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
documentation.
Try it!
Use the
APIs Explorer
to call this API and see the API request and response.
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-11-04 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]