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 subscriptions:

list
Muestra recursos de suscripción que coinciden con los criterios de solicitud a la API. Pruébala ahora.
insertar
Agrega una suscripción al canal del usuario autenticado. Pruébala ahora.
borrar
Borra una suscripción. Pruébala ahora.

Representación de recursos

En la siguiente estructura JSON, se muestra el formato de un recurso 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
Identifica el tipo de recurso de la API. El valor será youtube#subscription.
etag etag
La Etag de este recurso.
id string
ID que YouTube utiliza para identificar de manera inequívoca 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.
snippet.channelTitle string
Es el título del canal al que pertenece la suscripción.
snippet.title string
Título de la suscripción.
snippet.description string
Los detalles de la suscripción.
snippet.resourceId object
El objeto id contiene información sobre el canal al que se suscribió el usuario.
snippet.resourceId.kind string
Es el tipo de recurso de la API.
snippet.resourceId.channelId string
Es el valor que YouTube utiliza para identificar de forma inequívoca 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 información adicional sobre la viñeta.
snippet.thumbnails.(key) object
Los valores de clave válidos son los siguientes:
  • default: es la imagen en miniatura predeterminada de este recurso. 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: es una 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: Es una 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
La URL de la imagen.
snippet.thumbnails.(key).width unsigned integer
El ancho de la imagen.
snippet.thumbnails.(key).height unsigned integer
La altura de la imagen.
contentDetails object
El objeto contentDetails contiene estadísticas básicas sobre la suscripción.
contentDetails.totalItemCount unsigned integer
Indica la cantidad aproximada de elementos a los que apunta la suscripción.
contentDetails.newItemCount unsigned integer
Es la cantidad de elementos nuevos de la suscripción desde la última lectura de su contenido.
contentDetails.activityType string
El tipo de actividad para esta suscripción (solo cargas, todo).

Los valores válidos para esta propiedad son los siguientes:
  • all
  • uploads
subscriberSnippet object
El objeto subscriberSnippet contiene detalles básicos sobre el suscriptor.
subscriberSnippet.title string
Es el título del canal del suscriptor.
subscriberSnippet.description string
La descripción del canal del suscriptor.
subscriberSnippet.channelId string
Es el ID que YouTube asigna para identificar de forma única el canal del suscriptor.
subscriberSnippet.thumbnails object
Imágenes en miniatura del canal del suscriptor.
subscriberSnippet.thumbnails.(key) object
Los valores de clave válidos son los siguientes:
  • default: es la imagen en miniatura predeterminada de este recurso. 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: es una 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: Es una 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
La URL de la imagen.
subscriberSnippet.thumbnails.(key).width unsigned integer
El ancho de la imagen.
subscriberSnippet.thumbnails.(key).height unsigned integer
La altura de la imagen.