Subscriptions

Un recurso subscription contiene información sobre la suscripción de un usuario de YouTube. Una suscripción notifica al usuario cuando se agregan nuevos videos a un canal o cuando otro usuario realiza una de varias acciones en YouTube, como subir un video, calificar un video o comentar un video.

Métodos

La API admite los siguientes métodos para los recursos de subscriptions:

list
Muestra los recursos de suscripción que coinciden con los criterios de solicitud de la API. Pruébalo ahora.
insert
Agrega una suscripción al canal del usuario autenticado. Pruébalo ahora.
delete
Elimina una suscripción. Pruébalo ahora.

Representación de recursos

La estructura JSON a continuación muestra el formato de un recurso de 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
      }
    }
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Tipo de recurso de la API. El valor será youtube#subscription.
etag etag
Etag de este recurso.
id string
ID que YouTube utiliza para identificar de forma exclusiva la suscripción.
snippet object
El objeto snippet contiene información básica sobre la suscripción, como el título y el canal al que se suscribió el usuario.
snippet.publishedAt datetime
Fecha y hora en que se creó la suscripción. El valor se especifica en el formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelTitle string
Título del canal al que pertenece la suscripción.
snippet.title string
Título de la suscripción.
snippet.description string
Información sobre la suscripción.
snippet.resourceId object
El objeto id contiene información sobre un canal al que se suscribió un usuario.
snippet.resourceId.kind string
Tipo de recurso de la API.
snippet.resourceId.channelId string
Valor que YouTube utiliza para identificar de forma exclusiva el canal al que se suscribió el usuario.
snippet.channelId string
ID que YouTube utiliza para identificar de forma exclusiva el canal del suscriptor. El objeto resource_id identifica el canal al que se suscribió el usuario.
snippet.thumbnails object
Mapa de imágenes en miniatura asociadas con la suscripción. Para cada objeto en el mapa, la clave es el nombre de la imagen en miniatura, y el valor es un objeto que contiene otra información sobre la viñeta.
snippet.thumbnails.(key) object
Los valores de clave válidos son:
  • default: Imagen en miniatura predeterminada. La viñeta predeterminada de un video, o de un recurso que se refiere a un video, como un elemento de una lista de reproducción o el resultado de una búsqueda, es de 120 píxeles de ancho y 90 píxeles de alto. La viñeta predeterminada para un canal es de 88 píxeles de ancho y 88 píxeles de alto.
  • medium: Versión de mayor resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 320 píxeles de ancho y 180 píxeles de alto. Para un canal, esta imagen es de 240 píxeles de ancho y 240 píxeles de alto.
  • high: Versión de alta resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 480 píxeles de ancho y 360 píxeles de alto. Para un canal, esta imagen es de 800 píxeles de ancho y 800 píxeles de alto.
snippet.thumbnails.(key).url string
URL de la imagen.
snippet.thumbnails.(key).width unsigned integer
Ancho de la imagen.
snippet.thumbnails.(key).height unsigned integer
Altura de la imagen.
contentDetails object
El objeto contentDetails contiene datos estadísticos básicos sobre la suscripción.
contentDetails.totalItemCount unsigned integer
Número aproximado de elementos al que apunta la suscripción.
contentDetails.newItemCount unsigned integer
Número de elementos nuevos de la suscripción desde la última vez que se leyó su contenido.
contentDetails.activityType string
Tipo de actividad para esta suscripción (solo subidas, todo).

Los valores válidos para esta propiedad son:
  • all
  • uploads
subscriberSnippet object
El objeto subscriberSnippet contiene información básica sobre el suscriptor.
subscriberSnippet.title string
Título de canal del suscriptor.
subscriberSnippet.description string
Descripción del canal del suscriptor.
subscriberSnippet.channelId string
ID que YouTube asigna para identificar de forma exclusiva el canal del suscriptor.
subscriberSnippet.thumbnails object
Imágenes en miniatura de canal del suscriptor.
subscriberSnippet.thumbnails.(key) object
Los valores de clave válidos son:
  • default: Imagen en miniatura predeterminada. La viñeta predeterminada de un video, o de un recurso que se refiere a un video, como un elemento de una lista de reproducción o el resultado de una búsqueda, es de 120 píxeles de ancho y 90 píxeles de alto. La viñeta predeterminada para un canal es de 88 píxeles de ancho y 88 píxeles de alto.
  • medium: Versión de mayor resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 320 píxeles de ancho y 180 píxeles de alto. Para un canal, esta imagen es de 240 píxeles de ancho y 240 píxeles de alto.
  • high: Versión de alta resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 480 píxeles de ancho y 360 píxeles de alto. Para un canal, esta imagen es de 800 píxeles de ancho y 800 píxeles de alto.
subscriberSnippet.thumbnails.(key).url string
URL de la imagen.
subscriberSnippet.thumbnails.(key).width unsigned integer
Ancho de la imagen.
subscriberSnippet.thumbnails.(key).height unsigned integer
Altura de la imagen.