Cette page a été traduite par l'API Cloud Translation.

Subscriptions

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

Méthodes

L'API est compatible avec les méthodes suivantes pour les ressources subscriptions:

liste: Renvoie les ressources d'abonnement qui correspondent aux critères de requête 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 d'API. La valeur est `youtube#subscription`.
`etag`	`etag` Etag de cette ressource.
`id`	`string` ID utilisé par YouTube 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 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 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 est abonné.
`snippet.channelId`	`string` ID utilisé par YouTube pour identifier de façon unique la chaîne de l'abonné. L'objet `resource_id` identifie la chaîne à laquelle l'utilisateur est abonné.
`snippet.thumbnails`	`object` Carte de vignettes 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 par défaut de cette ressource. La miniature par défaut d'une vidéo (ou d'une ressource faisant 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 fait 88 pixels de large et 88 pixels de haut. `medium` : version de la miniature dans une résolution plus élevée. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 320 pixels de large et 180 pixels de haut. Pour une chaîne, elle mesure 240 pixels de large et 240 pixels de haut. `high` : version haute résolution de l'image miniature. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 480 pixels de large et 360 pixels de haut. Pour une chaîne, elle mesure 800 pixels de large et 800 pixels de haut.
`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 inclus dans l'abonnement depuis la dernière lecture de son contenu.
`contentDetails.activityType`	`string` Type d'activité auquel cet abonnement est destiné (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 attribué par YouTube pour identifier de façon unique la chaîne de l'abonné.
`subscriberSnippet.thumbnails`	`object` Vignettes de la chaîne de l'abonné.
`subscriberSnippet.thumbnails.(key)`	`object` Les clés-valeurs valides sont les suivantes: `default` : vignette par défaut de cette ressource. La miniature par défaut d'une vidéo (ou d'une ressource faisant 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 fait 88 pixels de large et 88 pixels de haut. `medium` : version de la miniature dans une résolution plus élevée. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 320 pixels de large et 180 pixels de haut. Pour une chaîne, elle mesure 240 pixels de large et 240 pixels de haut. `high` : version haute résolution de l'image miniature. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 480 pixels de large et 360 pixels de haut. Pour une chaîne, elle mesure 800 pixels de large et 800 pixels de haut.
`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.