Un recurso subscription
contiene información sobre una suscripción de 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é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
La siguiente estructura JSON 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 API. El valor será youtube#subscription . |
etag |
etag Es la Etag de este recurso. |
id |
string ID que YouTube utiliza para identificar de forma exclusiva la suscripción. |
snippet |
object El objeto snippet contiene detalles básicos 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 Título del canal al que pertenece la suscripción |
snippet.title |
string Es el título de la suscripción. |
snippet.description |
string 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 El tipo de recurso de la API. |
snippet.resourceId.channelId |
string Corresponde al valor que usa YouTube para identificar de forma exclusiva el canal al que se suscribió el usuario. |
snippet.channelId |
string Corresponde al ID que YouTube usa 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 Corresponde a un mapa de las 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 Estos son los valores clave válidos:
|
snippet.thumbnails.(key).url |
string Es la URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integer Ancho de la imagen |
snippet.thumbnails.(key).height |
unsigned integer Es la altura de la imagen. |
contentDetails |
object El objeto contentDetails contiene estadísticas básicas sobre la suscripción. |
contentDetails.totalItemCount |
unsigned integer La cantidad aproximada de artículos a los que apunta la suscripción. |
contentDetails.newItemCount |
unsigned integer Es la cantidad de elementos nuevos de la suscripción desde la última vez que se leyó su contenido. |
contentDetails.activityType |
string Corresponde al tipo de actividad al que se orienta esta suscripción (solo cargas, todo). Los valores válidos para esta propiedad son los siguientes:
|
subscriberSnippet |
object El objeto subscriberSnippet contiene detalles básicos sobre el suscriptor. |
subscriberSnippet.title |
string Título del canal del suscriptor |
subscriberSnippet.description |
string Es la descripción del canal del suscriptor. |
subscriberSnippet.channelId |
string ID que asigna YouTube para identificar de forma exclusiva el canal del suscriptor. |
subscriberSnippet.thumbnails |
object Miniaturas del canal del suscriptor |
subscriberSnippet.thumbnails.(key) |
object Estos son los valores clave válidos:
|
subscriberSnippet.thumbnails.(key).url |
string Es la URL de la imagen. |
subscriberSnippet.thumbnails.(key).width |
unsigned integer Ancho de la imagen |
subscriberSnippet.thumbnails.(key).height |
unsigned integer Es la altura de la imagen. |