Subscriptions

Une ressource subscription contient des informations sur un abonnement utilisateur YouTube. Un abonnement informe l'utilisateur lorsque de nouvelles vidéos sont ajoutées à une chaîne ou lorsqu'un autre utilisateur effectue l'une des actions sur YouTube, comme mettre en ligne une vidéo, donner son avis ou commenter une vidéo.

Méthodes

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

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

Représentation des ressources

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
Identifiant que YouTube utilise pour identifier l'abonnement de manière unique.
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.channelTitle string
Titre de la chaîne à laquelle l'abonnement appartient.
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 la ressource API.
snippet.resourceId.channelId string
Valeur utilisée par YouTube pour identifier de façon unique la chaîne à laquelle l'utilisateur s'est abonné.
snippet.channelId string
ID que YouTube utilise pour identifier la chaîne de l'abonné de manière unique. 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é est le nom de la vignette et la valeur est un objet contenant d'autres informations sur la vignette.
snippet.thumbnails.(key) object
Les clés-valeurs valides sont les suivantes:
  • default : vignette miniature par défaut pour cette ressource. La miniature par défaut d'une vidéo, ou une ressource faisant référence à une vidéo, telle qu'un élément de playlist ou un résultat de recherche, fait 120 x 90 pixels de haut. La miniature par défaut d'une chaîne fait 88 x 88 pixels.
  • medium : version haute résolution de la vignette. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 320 x 180 pixels. Pour une chaîne, cette image fait 240 px de large et 240 px de haut.
  • high : version haute résolution de la vignette. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 480 x 360 pixels. Pour une chaîne, cette image fait 800 x 800 pixels.
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 vers lesquels renvoie l'abonnement.
contentDetails.newItemCount unsigned integer
Nombre de nouveaux éléments dans l'abonnement depuis la dernière lecture de son contenu.
contentDetails.activityType string
Type d'activité associé à cet abonnement (importations totales et complètes).

Valeurs valides pour cette propriété :
  • 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 attribué par YouTube pour identifier la chaîne de l'abonné.
subscriberSnippet.thumbnails object
Des miniatures pour la chaîne de l'abonné.
subscriberSnippet.thumbnails.(key) object
Les clés-valeurs valides sont les suivantes :
  • default : vignette miniature par défaut pour cette ressource. La miniature par défaut d'une vidéo, ou une ressource faisant référence à une vidéo, telle qu'un élément de playlist ou un résultat de recherche, fait 120 x 90 pixels de haut. La miniature par défaut d'une chaîne fait 88 x 88 pixels.
  • medium : version haute résolution de la vignette. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 320 x 180 pixels. Pour une chaîne, cette image fait 240 px de large et 240 px de haut.
  • high : version haute résolution de la vignette. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 480 x 360 pixels. Pour une chaîne, cette image fait 800 x 800 pixels.
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.