GroupItems: list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Important:Les requêtes API envoyées à cette méthode nécessitent l'accès à :
- la portée
https://www.googleapis.com/auth/youtube
ou
- le champ d'application
https://www.googleapis.com/auth/youtube.readonly
et
le champ d'application https://www.googleapis.com/auth/yt-analytics.readonly
La première option utilise un champ d'application, qui se trouve être en lecture-écriture, tandis que la seconde utilise deux champs d'application en lecture seule.
Renvoie une collection d'éléments de groupe correspondant aux paramètres de requête de l'API.
Requête
Requête HTTP
GET https://youtubeanalytics.googleapis.com/v2/groupItems
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
Niveaux d'accès |
https://www.googleapis.com/auth/yt-analytics.readonly |
Affichez les rapports YouTube Analytics sur votre contenu YouTube. Ce champ d'application permet d'accéder aux métriques d'activité des utilisateurs, comme le nombre de vues et le nombre d'évaluations. |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
Afficher les rapports YouTube Analytics sur les revenus concernant votre contenu YouTube Cette portée permet d'accéder aux métriques sur l'activité des utilisateurs, ainsi qu'aux métriques sur les revenus estimés et les performances des annonces. |
https://www.googleapis.com/auth/youtube |
Gérez votre compte YouTube. Dans l'API YouTube Analytics, les propriétaires de chaînes utilisent cette portée pour gérer les groupes et les éléments de groupe YouTube Analytics. |
https://www.googleapis.com/auth/youtubepartner |
Consultez et gérez les éléments YouTube et le contenu associé sur YouTube. Dans l'API YouTube Analytics, les propriétaires de contenu utilisent cette portée pour gérer les groupes et les éléments de groupe YouTube Analytics. |
Paramètres
Le tableau ci-dessous liste les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.
Paramètres |
Paramètres obligatoires |
groupId |
string
Le paramètre id spécifie l'ID unique du groupe pour lequel vous souhaitez récupérer des éléments de groupe. |
Paramètres facultatifs |
onBehalfOfContentOwner |
string
Ce paramètre ne peut être utilisé que dans une requête autorisée appropriée. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenus YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes.
Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur YouTube qui agit au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Il permet aux propriétaires de contenus de s'authentifier une seule fois et d'accéder à toutes leurs données vidéo et de chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié. |
Corps de la requête
Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{
"kind": "youtube#groupItemListResponse",
"etag": etag,
"items": [
groupItem Resource
]
}
Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:
Propriétés |
kind |
string
Identifie le type de la ressource de l'API. La valeur sera youtube#groupItemListResponse .
|
etag |
etag
Etag de cette ressource. |
items[] |
list
Liste des éléments du groupe. Chaque élément de la liste représente une ressource groupItem . |
Erreurs
L'API ne définit aucun message d'erreur propre à cette méthode d'API. Toutefois, cette méthode peut toujours renvoyer des erreurs API générales listées dans la documentation du message d'erreur.
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/21 (UTC).
[null,null,["Dernière mise à jour le 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."]]