Subscriptions: list

Renvoie les ressources d'abonnement correspondant aux critères de requête de l'API.

Impact du quota : un appel à cette méthode a un coût de quota de 1 unité.

Cas d'utilisation courants

Demande

Requête HTTP :

GET https://www.googleapis.com/youtube/v3/subscriptions

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Réglages obligatoires
part string
Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressources subscription qui seront incluses dans la réponse de l'API.

Si le paramètre identifie une propriété contenant des propriétés enfants, celles-ci seront incluses dans la réponse. Par exemple, dans une ressource subscription, la propriété snippet contient d'autres propriétés, telles qu'un titre à afficher pour l'abonnement. Si vous définissez part=snippet, la réponse de l'API contiendra également toutes ces propriétés imbriquées.

La liste suivante contient les noms part que vous pouvez inclure dans la valeur du paramètre:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filtres (spécifier exactement l'un des paramètres suivants)
channelId string
Le paramètre channelId spécifie un ID de chaîne YouTube. L'API ne renvoie que les abonnements de cette chaîne.
id string
Le paramètre id spécifie une liste des ID d'abonnement YouTube pour les ressources récupérées, séparés par une virgule. Dans une ressource subscription, la propriété id spécifie l'ID d'abonnement YouTube.
mine boolean
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur true pour récupérer un flux des abonnements de l'utilisateur authentifié.
myRecentSubscribers boolean
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur true pour récupérer le flux des abonnés de l'utilisateur authentifié dans l'ordre chronologique inverse (les plus récents en premier).

Sachez que le nombre maximal d'abonnés renvoyé via cette API peut être limité.
mySubscribers boolean
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur true pour récupérer un flux des abonnés de l'utilisateur authentifié sans ordre particulier. Notez que le nombre maximal d'abonnés renvoyé via cette API peut être limité.
Paramètres facultatifs
forChannelId string
Le paramètre forChannelId spécifie une liste d'ID de chaînes séparés par une virgule. La réponse de l'API ne contiendra alors que les abonnements correspondant à ces chaînes.
maxResults unsigned integer
Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs autorisées vont de 0 à 50, inclus. La valeur par défaut est 5.
onBehalfOfContentOwner string
Remarque : Ce paramètre est réservé aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom du propriétaire de contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes différentes. Elle permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
onBehalfOfContentOwnerChannel string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Remarque:Ce paramètre est réservé aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne à laquelle une vidéo est ajoutée. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre onBehalfOfContentOwner. Il ne peut être utilisé qu'avec ce paramètre. En outre, la demande doit être autorisée via un compte CMS associé au propriétaire de contenu indiqué par le paramètre onBehalfOfContentOwner. Enfin, la chaîne spécifiée par le paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire de contenu indiqué par le paramètre onBehalfOfContentOwner.

Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Elle permet aux propriétaires de contenu de s'authentifier une fois et d'effectuer des actions pour le compte de la chaîne spécifiée dans la valeur du paramètre, sans avoir à fournir d'identifiants pour chaque chaîne.
order string
Le paramètre order spécifie la méthode qui sera utilisée pour trier les ressources dans la réponse de l'API. La valeur par défaut est SUBSCRIPTION_ORDER_RELEVANCE.

Les valeurs autorisées sont les suivantes :
  • alphabetical : tri par ordre alphabétique.
  • relevance : tri par pertinence.
  • unread : tri par ordre d'activité.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui pourraient être récupérées.

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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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 ressource de l'API. La valeur sera youtube#subscriptionListResponse.
etag etag
ETag de cette ressource.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour extraire la page suivante de l'ensemble de résultats.
prevPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente dans l'ensemble de résultats.
pageInfo object
L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults integer
Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste d'abonnements correspondant aux critères de requête.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

Type d'erreur Détails de l'erreur Description
forbidden (403) accountClosed Impossible de récupérer les abonnements, car le compte de l'abonné est clôturé.
forbidden (403) accountSuspended Impossible de récupérer les abonnements, car le compte de l'abonné est suspendu.
forbidden (403) subscriptionForbidden Le demandeur n'est pas autorisé à accéder aux abonnements demandés.
notFound (404) subscriberNotFound L'abonné identifié avec la demande est introuvable.

Essayer

Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.