Subscriptions

Une ressource subscription contient des informations sur l'abonnement d'un utilisateur YouTube. Un abonnement permet à un utilisateur de recevoir des notifications lorsque de nouvelles vidéos sont ajoutées à une chaîne ou lorsqu'un autre utilisateur effectue l'une des actions suivantes sur YouTube : mettre en ligne une vidéo, évaluer une vidéo ou commenter une vidéo.

Méthodes

L'API accepte les méthodes suivantes pour les ressources subscriptions :

liste
Renvoie les ressources d'abonnement correspondant aux critères de la requête API. Essayer
insérer
Ajoute un abonnement à la chaîne de l'utilisateur authentifié. Essayer
supprimer
Supprime un abonnement. Essayer

Représentation de la ressource

La structure JSON suivante montre le format d'une ressource subscriptions :

{
  "kind": "youtube#subscription",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelTitle": string,
    "title": string,
    "description": string,
    "resourceId": {
      "kind": string,
      "channelId": string,
    },
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "totalItemCount": unsigned integer,
    "newItemCount": unsigned integer,
    "activityType": string
  },
  "subscriberSnippet": {
    "title": string,
    "description": string,
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  }
}

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#subscription.
etag etag
Etag de cette ressource.
id string
ID utilisé par YouTube pour identifier de manière unique l'abonnement.
snippet object
L'objet snippet contient des informations de base sur l'abonnement, y compris son titre et la chaîne à laquelle l'utilisateur s'est abonné.
snippet.publishedAt datetime
Date et heure de création de l'abonnement. La valeur est spécifiée au format ISO 8601.
snippet.title string
Titre de l'abonnement.
snippet.description string
Détails de l'abonnement.
snippet.resourceId object
L'objet id contient des informations sur la chaîne à laquelle l'utilisateur s'est abonné.
snippet.resourceId.kind string
Type de ressource d'API.
snippet.resourceId.channelId string
Valeur utilisée par YouTube pour identifier de manière unique la chaîne à laquelle l'utilisateur s'est abonné.
snippet.channelId string
ID utilisé par YouTube pour identifier de manière unique la chaîne de l'abonné. L'objet resource_id identifie la chaîne à laquelle l'utilisateur s'est abonné.
snippet.thumbnails object
Carte des miniatures associées à l'abonnement. Pour chaque objet de la carte, la clé correspond au nom de la miniature et la valeur est un objet contenant d'autres informations sur la miniature.
snippet.thumbnails.(key) object
Les valeurs de clé valides sont les suivantes :
  • default : image miniature par défaut pour cette ressource. La vignette par défaut d'une vidéo (ou d'une ressource qui fait référence à une vidéo, comme un élément de playlist ou un résultat de recherche) mesure 120 pixels de large et 90 pixels de haut. La miniature par défaut d'une chaîne mesure 88 x 88 pixels.
  • medium : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 320 px de large et 180 px de haut. Pour une chaîne, cette image doit mesurer 240 x 240 pixels.
  • high : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 480 px de large et 360 px de haut. Pour une chaîne, cette image doit avoir une largeur et une hauteur de 800 px.
snippet.thumbnails.(key).url string
URL de l'image.
snippet.thumbnails.(key).width unsigned integer
Largeur de l'image.
snippet.thumbnails.(key).height unsigned integer
Hauteur de l'image.
contentDetails object
L'objet contentDetails contient des statistiques de base sur l'abonnement.
contentDetails.totalItemCount unsigned integer
Nombre approximatif d'éléments auxquels l'abonnement fait référence.
contentDetails.newItemCount unsigned integer
Nombre de nouveaux éléments dans l'abonnement depuis la dernière lecture du contenu.
contentDetails.activityType string
Type d'activité auquel s'applique cet abonnement (uniquement les mises en ligne, tout).

Les valeurs valides pour cette propriété sont les suivantes :
  • all
  • uploads
subscriberSnippet object
L'objet subscriberSnippet contient des informations de base sur l'abonné.
subscriberSnippet.title string
Titre de la chaîne de l'abonné.
subscriberSnippet.description string
Description de la chaîne de l'abonné.
subscriberSnippet.channelId string
ID que YouTube attribue pour identifier de manière unique la chaîne de l'abonné.
subscriberSnippet.thumbnails object
Vignettes de la chaîne de l'abonné.
subscriberSnippet.thumbnails.(key) object
Les valeurs de clé valides sont les suivantes :
  • default : image miniature par défaut pour cette ressource. La vignette par défaut d'une vidéo (ou d'une ressource qui fait référence à une vidéo, comme un élément de playlist ou un résultat de recherche) mesure 120 pixels de large et 90 pixels de haut. La miniature par défaut d'une chaîne mesure 88 x 88 pixels.
  • medium : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 320 px de large et 180 px de haut. Pour une chaîne, cette image doit mesurer 240 x 240 pixels.
  • high : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 480 px de large et 360 px de haut. Pour une chaîne, cette image doit avoir une largeur et une hauteur de 800 px.
subscriberSnippet.thumbnails.(key).url string
URL de l'image.
subscriberSnippet.thumbnails.(key).width unsigned integer
Largeur de l'image.
subscriberSnippet.thumbnails.(key).height unsigned integer
Hauteur de l'image.